basedismodule Module Reference

Data Types
type	disbasetype

Functions/Subroutines
subroutine	dis_df (this)
	Define the discretization. More...
subroutine	dis_ac (this, moffset, sparse)
	Add connections to sparse cell connectivity matrix. More...
subroutine	dis_mc (this, moffset, idxglo, matrix_sln)
	Map cell connections in the numerical solution coefficient matrix. More...
subroutine	dis_ar (this, icelltype)
	Allocate and setup variables, and write binary grid file. More...
subroutine	write_grb (this, icelltype)
	Write a binary grid file. More...
subroutine	dis_da (this)
	@brier Deallocate variables More...
subroutine	nodeu_to_string (this, nodeu, str)
	Convert a user nodenumber to a string (nodenumber), (k,j), or (k,i,j) More...
subroutine	nodeu_to_array (this, nodeu, arr)
	Convert a user nodenumber to an array (nodenumber), (k,j), or (k,i,j) More...
integer(i4b) function	get_nodeuser (this, noder)
	Convert a reduced nodenumber to a user node number. More...
integer(i4b) function	get_nodenumber_idx1 (this, nodeu, icheck)
integer(i4b) function	get_nodenumber_idx2 (this, k, j, icheck)
integer(i4b) function	get_nodenumber_idx3 (this, k, i, j, icheck)
subroutine	connection_normal (this, noden, nodem, ihc, xcomp, ycomp, zcomp, ipos)
	Get normal vector components between the cell and a given neighbor. The normal points outward from the shared face between noden and nodem. More...
subroutine	connection_vector (this, noden, nodem, nozee, satn, satm, ihc, xcomp, ycomp, zcomp, conlen)
	Get unit vector components between the cell and a given neighbor. Saturation must be provided to compute cell center vertical coordinates. Also return the straight-line connection length. More...
subroutine, public	dis_transform_xy (x, y, xorigin, yorigin, angrot, xglo, yglo)
	Get global (x, y) coordinates from cell-local coordinates. More...
subroutine	get_dis_type (this, dis_type)
	Get the discretization type (DIS, DISV, or DISU) More...
integer(i4b) function	get_dis_enum (this)
	Get the discretization type enumeration. More...
subroutine	allocate_scalars (this, name_model, input_mempath)
	Allocate and initialize scalar variables. More...
subroutine	allocate_arrays (this)
	Allocate and initialize arrays. More...
integer(i4b) function	nodeu_from_string (this, lloc, istart, istop, in, iout, line, flag_string, allow_zero)
	Convert a string to a user nodenumber. More...
integer(i4b) function	nodeu_from_cellid (this, cellid, inunit, iout, flag_string, allow_zero)
	Convert a cellid string to a user nodenumber. More...
integer(i4b) function	noder_from_string (this, lloc, istart, istop, in, iout, line, flag_string)
	Convert a string to a reduced nodenumber. More...
integer(i4b) function	noder_from_cellid (this, cellid, inunit, iout, flag_string, allow_zero)
	Convert cellid string to reduced nodenumber. More...
logical function	supports_layers (this)
	Indicates whether the grid discretization supports layers. More...
integer(i4b) function	get_ncpl (this)
	Return number of cells per layer. This is nodes for a DISU grid, as there are no layers. More...
real(dp) function	get_cell_volume (this, n, x)
	Return volume of cell n based on x value passed. More...
subroutine	get_polyverts (this, ic, polyverts, closed)
	Get a 2D array of cell polygon vertices, in clockwise order starting with the lower left corner. More...
integer(i4b) function	get_npolyverts (this, ic, closed)
	Get the number of cell polygon vertices. More...
integer(i4b) function	get_max_npolyverts (this, closed)
	Get the maximum number of cell polygon vertices. More...
subroutine	read_int_array (this, line, lloc, istart, istop, iout, in, iarray, aname)
	Read an integer array. More...
subroutine	read_dbl_array (this, line, lloc, istart, istop, iout, in, darray, aname)
	Read a double precision array. More...
subroutine	fill_int_array (this, ibuff1, ibuff2)
	Fill an integer array. More...
subroutine	fill_dbl_array (this, buff1, buff2)
	Fill a double precision array. More...
subroutine	read_list (this, line_reader, in, iout, iprpak, nlist, inamedbound, iauxmultcol, nodelist, rlist, auxvar, auxname, boundname, label, pkgname, tsManager, iscloc, indxconvertflux)
	Read a list using the list reader. More...
subroutine	read_layer_array (this, nodelist, darray, ncolbnd, maxbnd, icolbnd, aname, inunit, iout)
	Read a 2d double array into col icolbnd of darray. More...
subroutine	record_array (this, darray, iout, iprint, idataun, aname, cdatafmp, nvaluesp, nwidthp, editdesc, dinact)
	Record a double precision array. More...
subroutine	record_connection_array (this, flowja, ibinun, iout)
	Record a connection-based double precision array. More...
subroutine	noder_to_string (this, noder, str)
	Convert reduced node number to string (nodenumber), (k,j) or (k,i,j) More...
subroutine	noder_to_array (this, noder, arr)
	Convert reduced node number to array (nodenumber), (k,j) or (k,i,j) More...
subroutine	record_srcdst_list_header (this, text, textmodel, textpackage, dstmodel, dstpackage, naux, auxtxt, ibdchn, nlist, iout)
	Record list header for imeth=6. More...
subroutine	record_srcdst_list_entry (this, ibdchn, noder, noder2, q, naux, aux, olconv, olconv2)
	Record list header. More...
subroutine	nlarray_to_nodelist (this, darray, nodelist, maxbnd, nbound, aname)
	Convert an integer array to nodelist. More...
subroutine	highest_active (this, n, ibound)
	Find the first highest active cell beneath cell n. More...
subroutine	highest_saturated (this, n, sat)
	Find the first saturated cell beneath cell n. More...
real(dp) function	get_area (this, node)
	Return the cell area for the given node. More...
real(dp) function	get_area_factor (this, node, idx_conn)
	@ brief Calculate the area factor for the cell connection More...
subroutine	get_flow_width (this, n, m, idx_conn, width_n, width_m)
	@ brief Calculate the flow width between two cells More...
logical(lgp) function	is_3d (this)
	@Brief return true if grid is three dimensional More...
logical(lgp) function	is_2d (this)
	@Brief return true if grid is two dimensional More...
logical(lgp) function	is_1d (this)
	@Brief return true if grid is one dimensional More...

Function/Subroutine Documentation

allocate_arrays()

subroutine basedismodule::allocate_arrays ( class(disbasetype)  this )

private

Definition at line 463 of file DiscretizationBase.f90.

    class(DisBaseType) :: this
    integer :: isize
    !
    ! -- Allocate
    call mem_allocate(this%mshape, this%ndim, 'MSHAPE', this%memoryPath)
    call mem_allocate(this%xc, this%nodes, 'XC', this%memoryPath)
    call mem_allocate(this%yc, this%nodes, 'YC', this%memoryPath)
    call mem_allocate(this%top, this%nodes, 'TOP', this%memoryPath)
    call mem_allocate(this%bot, this%nodes, 'BOT', this%memoryPath)
    call mem_allocate(this%area, this%nodes, 'AREA', this%memoryPath)
    !
    ! -- Initialize
    this%mshape(1) = this%nodes
    !
    ! -- Determine size of buff memory
    if (this%nodes < this%nodesuser) then
      isize = this%nodesuser
    else
      isize = this%nodes
    end if
    !
    ! -- Allocate the arrays
    call mem_allocate(this%dbuff, isize, 'DBUFF', this%name_model)
    call mem_allocate(this%ibuff, isize, 'IBUFF', this%name_model)

allocate_scalars()

subroutine basedismodule::allocate_scalars	(	class(disbasetype)	this,
		character(len=*), intent(in)	name_model,
		character(len=*), intent(in)	input_mempath
	)

Definition at line 404 of file DiscretizationBase.f90.

    ! -- dummy
    class(DisBaseType) :: this
    character(len=*), intent(in) :: name_model
    character(len=*), intent(in) :: input_mempath
    logical(LGP) :: found
    !
    ! -- Create memory path
    this%memoryPath = create_mem_path(name_model, 'DIS')
    !
    ! -- Allocate
    allocate (this%name_model)
    allocate (this%input_fname)
    allocate (this%output_fname)
    !
    call mem_allocate(this%inunit, 'INUNIT', this%memoryPath)
    call mem_allocate(this%iout, 'IOUT', this%memoryPath)
    call mem_allocate(this%nodes, 'NODES', this%memoryPath)
    call mem_allocate(this%nodesuser, 'NODESUSER', this%memoryPath)
    call mem_allocate(this%ndim, 'NDIM', this%memoryPath)
    call mem_allocate(this%icondir, 'ICONDIR', this%memoryPath)
    call mem_allocate(this%nogrb, 'NOGRB', this%memoryPath)
    call mem_allocate(this%xorigin, 'XORIGIN', this%memoryPath)
    call mem_allocate(this%yorigin, 'YORIGIN', this%memoryPath)
    call mem_allocate(this%angrot, 'ANGROT', this%memoryPath)
    call mem_allocate(this%nja, 'NJA', this%memoryPath)
    call mem_allocate(this%njas, 'NJAS', this%memoryPath)
    call mem_allocate(this%lenuni, 'LENUNI', this%memoryPath)
    !
    ! -- Initialize
    this%name_model = name_model
    this%input_mempath = input_mempath
    this%input_fname = ''
    this%output_fname = ''
    this%inunit = 0
    this%iout = 0
    this%nodes = 0
    this%nodesuser = 0
    this%ndim = 1
    this%icondir = 1
    this%nogrb = 0
    this%xorigin = dzero
    this%yorigin = dzero
    this%angrot = dzero
    this%nja = 0
    this%njas = 0
    this%lenuni = 0
    !
    ! -- update input and output filenames
    call mem_set_value(this%input_fname, 'INPUT_FNAME', &
                       this%input_mempath, found)
    call mem_set_value(this%output_fname, 'GRB6_FILENAME', &
                       this%input_mempath, found)
    if (.not. found) then
      this%output_fname = trim(this%input_fname)//'.grb'
    end if

Here is the call graph for this function:

connection_normal()

subroutine basedismodule::connection_normal ( class(disbasetype)  this, integer(i4b), intent(in)  noden, integer(i4b), intent(in)  nodem, integer(i4b), intent(in)  ihc, real(dp), intent(inout)  xcomp, real(dp), intent(inout)  ycomp, real(dp), intent(inout)  zcomp, integer(i4b), intent(in)  ipos  )

private

Parameters

[in]	noden	cell (reduced nn)
[in]	nodem	neighbor (reduced nn)
[in]	ihc	horizontal connection flag

Definition at line 319 of file DiscretizationBase.f90.

    class(DisBaseType) :: this
    integer(I4B), intent(in) :: noden !< cell (reduced nn)
    integer(I4B), intent(in) :: nodem !< neighbor (reduced nn)
    integer(I4B), intent(in) :: ihc !< horizontal connection flag
    real(DP), intent(inout) :: xcomp
    real(DP), intent(inout) :: ycomp
    real(DP), intent(inout) :: zcomp
    integer(I4B), intent(in) :: ipos
 
    call store_error('Programmer error: connection_normal must be overridden', &
                     terminate=.true.)

Here is the call graph for this function:

connection_vector()

subroutine basedismodule::connection_vector ( class(disbasetype)  this, integer(i4b), intent(in)  noden, integer(i4b), intent(in)  nodem, logical, intent(in)  nozee, real(dp), intent(in)  satn, real(dp), intent(in)  satm, integer(i4b), intent(in)  ihc, real(dp), intent(inout)  xcomp, real(dp), intent(inout)  ycomp, real(dp), intent(inout)  zcomp, real(dp), intent(inout)  conlen  )

private

Parameters

[in]	noden	cell (reduced nn)
[in]	nodem	neighbor (reduced nn)
[in]	ihc	horizontal connection flag

Definition at line 337 of file DiscretizationBase.f90.

    class(DisBaseType) :: this
    integer(I4B), intent(in) :: noden !< cell (reduced nn)
    integer(I4B), intent(in) :: nodem !< neighbor (reduced nn)
    logical, intent(in) :: nozee
    real(DP), intent(in) :: satn
    real(DP), intent(in) :: satm
    integer(I4B), intent(in) :: ihc !< horizontal connection flag
    real(DP), intent(inout) :: xcomp
    real(DP), intent(inout) :: ycomp
    real(DP), intent(inout) :: zcomp
    real(DP), intent(inout) :: conlen
 
    call store_error('Programmer error: connection_vector must be overridden', &
                     terminate=.true.)

Here is the call graph for this function:

dis_ac()

subroutine basedismodule::dis_ac ( class(disbasetype)  this, integer(i4b), intent(in)  moffset, type(sparsematrix), intent(inout)  sparse  )

private

Definition at line 138 of file DiscretizationBase.f90.

    ! -- modules
    use sparsemodule, only: sparsematrix
    ! -- dummy
    class(DisBaseType) :: this
    integer(I4B), intent(in) :: moffset
    type(sparsematrix), intent(inout) :: sparse
    ! -- local
    integer(I4B) :: i, j, ipos, iglo, jglo
    !
    do i = 1, this%nodes
      do ipos = this%con%ia(i), this%con%ia(i + 1) - 1
        j = this%con%ja(ipos)
        iglo = i + moffset
        jglo = j + moffset
        call sparse%addconnection(iglo, jglo, 1)
      end do
    end do

dis_ar()

subroutine basedismodule::dis_ar ( class(disbasetype)  this, integer(i4b), dimension(:), intent(in)  icelltype  )

private

Definition at line 179 of file DiscretizationBase.f90.

    ! -- dummy
    class(DisBaseType) :: this
    integer(I4B), dimension(:), intent(in) :: icelltype
    ! -- local
    integer(I4B), dimension(:), allocatable :: ict
    integer(I4B) :: nu, nr
    !
    ! -- Expand icelltype to full grid; fill with 0 if cell is excluded
    allocate (ict(this%nodesuser))
    do nu = 1, this%nodesuser
      nr = this%get_nodenumber(nu, 0)
      if (nr > 0) then
        ict(nu) = icelltype(nr)
      else
        ict(nu) = 0
      end if
    end do
    !
    if (this%nogrb == 0) call this%write_grb(ict)

dis_da()

subroutine basedismodule::dis_da ( class(disbasetype)  this )

private

Definition at line 210 of file DiscretizationBase.f90.

    ! -- modules
    use memorymanagermodule, only: mem_deallocate
    ! -- dummy
    class(DisBaseType) :: this
    !
    ! -- Strings
    deallocate (this%name_model)
    deallocate (this%input_fname)
    deallocate (this%output_fname)
    !
    ! -- Scalars
    call mem_deallocate(this%inunit)
    call mem_deallocate(this%iout)
    call mem_deallocate(this%nodes)
    call mem_deallocate(this%nodesuser)
    call mem_deallocate(this%ndim)
    call mem_deallocate(this%icondir)
    call mem_deallocate(this%nogrb)
    call mem_deallocate(this%xorigin)
    call mem_deallocate(this%yorigin)
    call mem_deallocate(this%angrot)
    call mem_deallocate(this%nja)
    call mem_deallocate(this%njas)
    call mem_deallocate(this%lenuni)
    !
    ! -- Arrays
    call mem_deallocate(this%mshape)
    call mem_deallocate(this%xc)
    call mem_deallocate(this%yc)
    call mem_deallocate(this%top)
    call mem_deallocate(this%bot)
    call mem_deallocate(this%area)
    call mem_deallocate(this%dbuff)
    call mem_deallocate(this%ibuff)
    !
    ! -- Connections
    call this%con%con_da()
    deallocate (this%con)

dis_df()

subroutine basedismodule::dis_df ( class(disbasetype)  this )

private

Definition at line 131 of file DiscretizationBase.f90.

    class(DisBaseType) :: this
    call store_error('Programmer error: dis_df must be overridden', &
                     terminate=.true.)

Here is the call graph for this function:

dis_mc()

subroutine basedismodule::dis_mc	(	class(disbasetype)	this,
		integer(i4b), intent(in)	moffset,
		integer(i4b), dimension(:), intent(inout)	idxglo,
		class(matrixbasetype), pointer	matrix_sln
	)

Definition at line 159 of file DiscretizationBase.f90.

    ! -- dummy
    class(DisBaseType) :: this
    integer(I4B), intent(in) :: moffset
    integer(I4B), dimension(:), intent(inout) :: idxglo
    class(MatrixBaseType), pointer :: matrix_sln
    ! -- local
    integer(I4B) :: i, j, ipos, iglo, jglo
    !
    do i = 1, this%nodes
      iglo = i + moffset
      do ipos = this%con%ia(i), this%con%ia(i + 1) - 1
        j = this%con%ja(ipos)
        jglo = j + moffset
        idxglo(ipos) = matrix_sln%get_position(iglo, jglo)
      end do
    end do

dis_transform_xy()

subroutine, public basedismodule::dis_transform_xy	(	real(dp), intent(in)	x,
		real(dp), intent(in)	y,
		real(dp), intent(in)	xorigin,
		real(dp), intent(in)	yorigin,
		real(dp), intent(in)	angrot,
		real(dp), intent(out)	xglo,
		real(dp), intent(out)	yglo
	)

Parameters

[in]	x	the cell-x coordinate to transform
[in]	y	the cell-y coordinate to transform
[in]	xorigin	the cell-y coordinate to transform
[in]	yorigin	the cell-y coordinate to transform
[in]	angrot	the cell-y coordinate to transform
[out]	xglo	the global cell-x coordinate
[out]	yglo	the global cell-y coordinate

Definition at line 356 of file DiscretizationBase.f90.

    real(DP), intent(in) :: x !< the cell-x coordinate to transform
    real(DP), intent(in) :: y !< the cell-y coordinate to transform
    real(DP), intent(in) :: xorigin !< the cell-y coordinate to transform
    real(DP), intent(in) :: yorigin !< the cell-y coordinate to transform
    real(DP), intent(in) :: angrot !< the cell-y coordinate to transform
    real(DP), intent(out) :: xglo !< the global cell-x coordinate
    real(DP), intent(out) :: yglo !< the global cell-y coordinate
    ! local
    real(DP) :: ang
 
    xglo = x
    yglo = y
 
    ! first _rotate_ to 'real world'
    ang = angrot * dpio180
    if (ang /= dzero) then
      xglo = x * cos(ang) - y * sin(ang)
      yglo = x * sin(ang) + y * cos(ang)
    end if
 
    ! then _translate_
    xglo = xglo + xorigin
    yglo = yglo + yorigin

Here is the caller graph for this function:

fill_dbl_array()

subroutine basedismodule::fill_dbl_array ( class(disbasetype), intent(inout)  this, real(dp), dimension(:), intent(in), pointer, contiguous  buff1, real(dp), dimension(:), intent(inout), pointer, contiguous  buff2  )

private

Definition at line 767 of file DiscretizationBase.f90.

    ! -- dummy
    class(DisBaseType), intent(inout) :: this
    real(DP), dimension(:), pointer, contiguous, intent(in) :: buff1
    real(DP), dimension(:), pointer, contiguous, intent(inout) :: buff2
    ! -- local
    integer(I4B) :: nodeu
    integer(I4B) :: noder
 
    do nodeu = 1, this%nodesuser
      noder = this%get_nodenumber(nodeu, 0)
      if (noder <= 0) cycle
      buff2(noder) = buff1(nodeu)
    end do

Here is the caller graph for this function:

fill_int_array()

subroutine basedismodule::fill_int_array ( class(disbasetype), intent(inout)  this, integer(i4b), dimension(:), intent(in), pointer, contiguous  ibuff1, integer(i4b), dimension(:), intent(inout), pointer, contiguous  ibuff2  )

private

Definition at line 750 of file DiscretizationBase.f90.

    ! -- dummy
    class(DisBaseType), intent(inout) :: this
    integer(I4B), dimension(:), pointer, contiguous, intent(in) :: ibuff1
    integer(I4B), dimension(:), pointer, contiguous, intent(inout) :: ibuff2
    ! -- local
    integer(I4B) :: nodeu
    integer(I4B) :: noder
 
    do nodeu = 1, this%nodesuser
      noder = this%get_nodenumber(nodeu, 0)
      if (noder <= 0) cycle
      ibuff2(noder) = ibuff1(nodeu)
    end do

Here is the caller graph for this function:

get_area()

real(dp) function basedismodule::get_area ( class(disbasetype)  this, integer(i4b), intent(in)  node  )

private

Parameters

[in]

node

reduced node number

Definition at line 1177 of file DiscretizationBase.f90.

    class(DisBaseType) :: this
    integer(I4B), intent(in) :: node !< reduced node number
    real(DP) :: area
 
    area = this%area(node)

get_area_factor()

real(dp) function basedismodule::get_area_factor ( class(disbasetype)  this, integer(i4b), intent(in)  node, integer(i4b), intent(in)  idx_conn  )

private

Function calculates the area factor for the cell connection. The sum of all area factors for all cell connections to overlying or underlying cells cells will be 1.

TODO: confirm that this works for cells that are only partially covered by overlying or underlying cells.

Returns

connection cell area factor

Parameters

[in]	node	cell node number
[in]	idx_conn	connection index

Definition at line 1194 of file DiscretizationBase.f90.

    ! -- return
    real(DP) :: area_factor !< connection cell area factor
    ! -- dummy
    class(DisBaseType) :: this
    integer(I4B), intent(in) :: node !< cell node number
    integer(I4B), intent(in) :: idx_conn !< connection index
    ! -- local
    real(DP) :: area_node
    real(DP) :: area_conn
    !
    ! -- calculate the cell area fraction
    area_node = this%area(node)
    area_conn = this%con%hwva(idx_conn)
    !
    ! -- return the cell area factor
    area_factor = area_conn / area_node

get_cell_volume()

real(dp) function basedismodule::get_cell_volume ( class(disbasetype)  this, integer(i4b), intent(in)  n, real(dp), intent(in)  x  )

private

Definition at line 659 of file DiscretizationBase.f90.

    ! -- return
    real(DP) :: get_cell_volume
    ! -- dummy
    class(DisBaseType) :: this
    integer(I4B), intent(in) :: n
    real(DP), intent(in) :: x
    ! -- local
    real(DP) :: tp
    real(DP) :: bt
    real(DP) :: sat
    real(DP) :: thick
 
    get_cell_volume = dzero
    tp = this%top(n)
    bt = this%bot(n)
    sat = squadraticsaturation(tp, bt, x)
    thick = (tp - bt) * sat
    get_cell_volume = this%area(n) * thick

Here is the call graph for this function:

get_dis_enum()

integer(i4b) function basedismodule::get_dis_enum ( class(disbasetype), intent(in)  this )

private

Definition at line 393 of file DiscretizationBase.f90.

    use constantsmodule, only: disundef
    class(DisBaseType), intent(in) :: this
    integer(I4B) :: dis_enum
 
    dis_enum = disundef
    call store_error('Programmer error: get_dis_enum must be overridden', &
                     terminate=.true.)

Here is the call graph for this function:

get_dis_type()

subroutine basedismodule::get_dis_type ( class(disbasetype), intent(in)  this, character(len=*), intent(out)  dis_type  )

private

Definition at line 383 of file DiscretizationBase.f90.

    class(DisBaseType), intent(in) :: this
    character(len=*), intent(out) :: dis_type
 
    dis_type = "Not implemented"
    call store_error('Programmer error: get_dis_type must be overridden', &
                     terminate=.true.)

Here is the call graph for this function:

get_flow_width()

subroutine basedismodule::get_flow_width ( class(disbasetype)  this, integer(i4b), intent(in)  n, integer(i4b), intent(in)  m, integer(i4b), intent(in)  idx_conn, real(dp), intent(out)  width_n, real(dp), intent(out)  width_m  )

private

This should only be called for connections with IHC > 0. Routine is needed, so it can be overridden by the linear network discretization, which allows for a separate flow

Parameters

[in]	n	cell node number
[in]	m	cell node number
[in]	idx_conn	connection index
[out]	width_n	flow width for cell n
[out]	width_m	flow width for cell m

Definition at line 1220 of file DiscretizationBase.f90.

    ! dummy
    class(DisBaseType) :: this
    integer(I4B), intent(in) :: n !< cell node number
    integer(I4B), intent(in) :: m !< cell node number
    integer(I4B), intent(in) :: idx_conn !< connection index
    real(DP), intent(out) :: width_n !< flow width for cell n
    real(DP), intent(out) :: width_m !< flow width for cell m
    ! local
    integer(I4B) :: isympos
 
    ! For general case, width_n = width_m
    isympos = this%con%jas(idx_conn)
    width_n = this%con%hwva(isympos)
    width_m = width_n
 

get_max_npolyverts()

integer(i4b) function basedismodule::get_max_npolyverts ( class(disbasetype), intent(inout)  this, logical(lgp), intent(in), optional  closed  )

private

Parameters

[in]

closed

whether to close the polygon, duplicating a vertex

Definition at line 704 of file DiscretizationBase.f90.

    class(DisBaseType), intent(inout) :: this
    logical(LGP), intent(in), optional :: closed !< whether to close the polygon, duplicating a vertex
    integer(I4B) :: max_npolyverts
    max_npolyverts = 0 ! suppress compiler warning
    errmsg = 'Programmer error: get_max_npolyverts must be overridden'
    call store_error(errmsg, terminate=.true.)

Here is the call graph for this function:

get_ncpl()

integer(i4b) function basedismodule::get_ncpl ( class(disbasetype)  this )

private

Definition at line 650 of file DiscretizationBase.f90.

    integer(I4B) :: get_ncpl
    class(DisBaseType) :: this
    get_ncpl = 0
    call store_error('Programmer error: get_ncpl must be overridden', &
                     terminate=.true.)

Here is the call graph for this function:

get_nodenumber_idx1()

integer(i4b) function basedismodule::get_nodenumber_idx1 ( class(disbasetype), intent(in)  this, integer(i4b), intent(in)  nodeu, integer(i4b), intent(in)  icheck  )

private

Definition at line 284 of file DiscretizationBase.f90.

    class(DisBaseType), intent(in) :: this
    integer(I4B), intent(in) :: nodeu
    integer(I4B), intent(in) :: icheck
    integer(I4B) :: nodenumber
 
    nodenumber = 0
    call store_error('Programmer error: get_nodenumber_idx1 must be overridden', &
                     terminate=.true.)

Here is the call graph for this function:

Here is the caller graph for this function:

get_nodenumber_idx2()

integer(i4b) function basedismodule::get_nodenumber_idx2 ( class(disbasetype), intent(in)  this, integer(i4b), intent(in)  k, integer(i4b), intent(in)  j, integer(i4b), intent(in)  icheck  )

private

Definition at line 295 of file DiscretizationBase.f90.

    class(DisBaseType), intent(in) :: this
    integer(I4B), intent(in) :: k, j
    integer(I4B), intent(in) :: icheck
    integer(I4B) :: nodenumber
 
    nodenumber = 0
    call store_error('Programmer error: get_nodenumber_idx2 must be overridden', &
                     terminate=.true.)

Here is the call graph for this function:

Here is the caller graph for this function:

get_nodenumber_idx3()

integer(i4b) function basedismodule::get_nodenumber_idx3 ( class(disbasetype), intent(in)  this, integer(i4b), intent(in)  k, integer(i4b), intent(in)  i, integer(i4b), intent(in)  j, integer(i4b), intent(in)  icheck  )

private

Definition at line 306 of file DiscretizationBase.f90.

    class(DisBaseType), intent(in) :: this
    integer(I4B), intent(in) :: k, i, j
    integer(I4B), intent(in) :: icheck
    integer(I4B) :: nodenumber
 
    nodenumber = 0
    call store_error('Programmer error: get_nodenumber_idx3 must be overridden', &
                     terminate=.true.)

Here is the call graph for this function:

Here is the caller graph for this function:

get_nodeuser()

integer(i4b) function basedismodule::get_nodeuser ( class(disbasetype)  this, integer(i4b), intent(in)  noder  )

private

Definition at line 272 of file DiscretizationBase.f90.

    class(DisBaseType) :: this
    integer(I4B), intent(in) :: noder
    integer(I4B) :: nodenumber
 
    if (this%nodes < this%nodesuser) then
      nodenumber = this%nodeuser(noder)
    else
      nodenumber = noder
    end if

get_npolyverts()

integer(i4b) function basedismodule::get_npolyverts ( class(disbasetype), intent(inout)  this, integer(i4b), intent(in)  ic, logical(lgp), intent(in), optional  closed  )

private

Parameters

[in]	ic	cell number (reduced)
[in]	closed	whether to close the polygon, duplicating a vertex

Definition at line 693 of file DiscretizationBase.f90.

    class(DisBaseType), intent(inout) :: this
    integer(I4B), intent(in) :: ic !< cell number (reduced)
    logical(LGP), intent(in), optional :: closed !< whether to close the polygon, duplicating a vertex
    integer(I4B) :: npolyverts
    npolyverts = 0 ! suppress compiler warning
    errmsg = 'Programmer error: get_npolyverts must be overridden'
    call store_error(errmsg, terminate=.true.)

Here is the call graph for this function:

get_polyverts()

subroutine basedismodule::get_polyverts ( class(disbasetype), intent(inout)  this, integer(i4b), intent(in)  ic, real(dp), dimension(:, :), intent(out), allocatable  polyverts, logical(lgp), intent(in), optional  closed  )

private

Parameters

[in]	ic	cell number (reduced)
[out]	polyverts	polygon vertices (column-major indexing)
[in]	closed	whether to close the polygon, duplicating a vertex

Definition at line 682 of file DiscretizationBase.f90.

    class(DisBaseType), intent(inout) :: this
    integer(I4B), intent(in) :: ic !< cell number (reduced)
    real(DP), allocatable, intent(out) :: polyverts(:, :) !< polygon vertices (column-major indexing)
    logical(LGP), intent(in), optional :: closed !< whether to close the polygon, duplicating a vertex
 
    errmsg = 'Programmer error: get_polyverts must be overridden'
    call store_error(errmsg, terminate=.true.)

Here is the call graph for this function:

highest_active()

subroutine basedismodule::highest_active ( class(disbasetype)  this, integer(i4b), intent(inout)  n, integer(i4b), dimension(:), intent(in)  ibound  )

private

Definition at line 1101 of file DiscretizationBase.f90.

    ! -- dummy
    class(DisBaseType) :: this
    integer(I4B), intent(inout) :: n
    integer(I4B), dimension(:), intent(in) :: ibound
    ! -- locals
    integer(I4B) :: m, ii, iis
    logical done, bottomcell
    !
    ! -- Loop through connected cells until the highest active one (including a
    !    constant head cell) is found.  Return that cell as n.
    done = .false.
    do while (.not. done)
      bottomcell = .true.
      cloop: do ii = this%con%ia(n) + 1, this%con%ia(n + 1) - 1
        m = this%con%ja(ii)
        iis = this%con%jas(ii)
        if (this%con%ihc(iis) == 0 .and. m > n) then
          !
          ! -- this cannot be a bottom cell
          bottomcell = .false.
          !
          ! -- vertical down
          if (ibound(m) /= 0) then
            n = m
            done = .true.
            exit cloop
          else
            n = m
            exit cloop
          end if
        end if
      end do cloop
      if (bottomcell) done = .true.
    end do

highest_saturated()

subroutine basedismodule::highest_saturated ( class(disbasetype)  this, integer(i4b), intent(inout)  n, real(dp), dimension(:), intent(in)  sat  )

private

Definition at line 1139 of file DiscretizationBase.f90.

    ! -- dummy
    class(DisBaseType) :: this
    integer(I4B), intent(inout) :: n
    real(DP), dimension(:), intent(in) :: sat
    ! -- locals
    integer(I4B) :: m, ii, iis
    logical(LGP) :: is_done, bottomcell
    !
    ! -- Loop through connected cells until the highest saturated one (including a
    !    constant head cell) is found.  Return that cell as n.
    is_done = .false.
    do while (.not. is_done)
      bottomcell = .true.
      cloop: do ii = this%con%ia(n) + 1, this%con%ia(n + 1) - 1
        m = this%con%ja(ii)
        iis = this%con%jas(ii)
        if (this%con%ihc(iis) == 0 .and. m > n) then
          !
          ! -- this cannot be a bottom cell
          bottomcell = .false.
          !
          ! -- vertical down
          if (sat(m) > dzero) then
            n = m
            is_done = .true.
            exit cloop
          else
            n = m
            exit cloop
          end if
        end if
      end do cloop
      if (bottomcell) is_done = .true.
    end do

is_1d()

logical(lgp) function basedismodule::is_1d ( class(disbasetype)  this )

private

Definition at line 1265 of file DiscretizationBase.f90.

    ! dummy
    class(DisBaseType) :: this
    ! return
    logical(LGP) :: r
    r = .false.
    select case (this%get_dis_enum())
    case (dis1d, disv1d, disu1d)
      r = .true.
    end select

is_2d()

logical(lgp) function basedismodule::is_2d ( class(disbasetype)  this )

private

Definition at line 1252 of file DiscretizationBase.f90.

    ! dummy
    class(DisBaseType) :: this
    ! return
    logical(LGP) :: r
    r = .false.
    select case (this%get_dis_enum())
    case (dis2d, disv2d, disu2d)
      r = .true.
    end select

is_3d()

logical(lgp) function basedismodule::is_3d ( class(disbasetype)  this )

private

Definition at line 1239 of file DiscretizationBase.f90.

    ! dummy
    class(DisBaseType) :: this
    ! return
    logical(LGP) :: r
    r = .false.
    select case (this%get_dis_enum())
    case (dis, disv, disu)
      r = .true.
    end select

nlarray_to_nodelist()

subroutine basedismodule::nlarray_to_nodelist ( class(disbasetype)  this, integer(i4b), dimension(:), pointer, contiguous  darray, integer(i4b), dimension(maxbnd), intent(inout)  nodelist, integer(i4b), intent(in)  maxbnd, integer(i4b), intent(inout)  nbound, character(len=*), intent(in)  aname  )

private

For DIS/DISV, the array is layer number, for DISU it's node number.

Definition at line 1088 of file DiscretizationBase.f90.

    class(DisBaseType) :: this
    integer(I4B), intent(in) :: maxbnd
    integer(I4B), dimension(:), pointer, contiguous :: darray
    integer(I4B), dimension(maxbnd), intent(inout) :: nodelist
    integer(I4B), intent(inout) :: nbound
    character(len=*), intent(in) :: aname
 
    errmsg = 'Programmer error: nlarray_to_nodelist must be overridden'
    call store_error(errmsg, terminate=.true.)

Here is the call graph for this function:

noder_from_cellid()

integer(i4b) function basedismodule::noder_from_cellid ( class(disbasetype)  this, character(len=*), intent(inout)  cellid, integer(i4b), intent(in)  inunit, integer(i4b), intent(in)  iout, logical, intent(in), optional  flag_string, logical, intent(in), optional  allow_zero  )

private

If flag_string argument is present and true, the first token in string is allowed to be a string (e.g. boundary name). In this case, if a string is encountered, return value as -2. If allow_zero argument is present and true, if all indices equal zero, the result can be zero. If allow_zero is false, a zero in any index is an error.

Definition at line 594 of file DiscretizationBase.f90.

    ! -- return
    integer(I4B) :: noder
    ! -- dummy
    class(DisBaseType) :: this
    character(len=*), intent(inout) :: cellid
    integer(I4B), intent(in) :: inunit
    integer(I4B), intent(in) :: iout
    logical, optional, intent(in) :: flag_string
    logical, optional, intent(in) :: allow_zero
    ! -- local
    integer(I4B) :: nodeu
    logical :: allowzerolocal
    character(len=LINELENGTH) :: nodestr
    logical :: flag_string_local
    !
    if (present(flag_string)) then
      flag_string_local = flag_string
    else
      flag_string_local = .false.
    end if
    if (present(allow_zero)) then
      allowzerolocal = allow_zero
    else
      allowzerolocal = .false.
    end if
    !
    nodeu = this%nodeu_from_cellid(cellid, inunit, iout, flag_string_local, &
                                   allowzerolocal)
    !
    ! -- Convert user-based nodenumber to reduced node number
    if (nodeu > 0) then
      noder = this%get_nodenumber(nodeu, 0)
    else
      noder = nodeu
    end if
    if (noder <= 0 .and. .not. flag_string_local) then
      call this%nodeu_to_string(nodeu, nodestr)
      write (errmsg, *) &
        ' Cell is outside active grid domain: '// &
        trim(adjustl(nodestr))
      call store_error(errmsg)
    end if

Here is the call graph for this function:

noder_from_string()

integer(i4b) function basedismodule::noder_from_string ( class(disbasetype)  this, integer(i4b), intent(inout)  lloc, integer(i4b), intent(inout)  istart, integer(i4b), intent(inout)  istop, integer(i4b), intent(in)  in, integer(i4b), intent(in)  iout, character(len=*), intent(inout)  line, logical, intent(in), optional  flag_string  )

private

If the model is unstructured; just read user nodenumber. If flag_string argument is present and true, the first token in string is allowed to be a string (e.g. boundary name). In this case, if a string is encountered, return value as -2.

Definition at line 546 of file DiscretizationBase.f90.

    ! -- dummy
    class(DisBaseType) :: this
    integer(I4B), intent(inout) :: lloc
    integer(I4B), intent(inout) :: istart
    integer(I4B), intent(inout) :: istop
    integer(I4B), intent(in) :: in
    integer(I4B), intent(in) :: iout
    character(len=*), intent(inout) :: line
    logical, optional, intent(in) :: flag_string
    integer(I4B) :: noder
    ! -- local
    integer(I4B) :: nodeu
    character(len=LINELENGTH) :: nodestr
    logical :: flag_string_local
    !
    if (present(flag_string)) then
      flag_string_local = flag_string
    else
      flag_string_local = .false.
    end if
    nodeu = this%nodeu_from_string(lloc, istart, istop, in, iout, line, &
                                   flag_string_local)
    !
    ! -- Convert user-based nodenumber to reduced node number
    if (nodeu > 0) then
      noder = this%get_nodenumber(nodeu, 0)
    else
      noder = nodeu
    end if
    if (noder <= 0 .and. .not. flag_string_local) then
      call this%nodeu_to_string(nodeu, nodestr)
      write (errmsg, *) &
        ' Cell is outside active grid domain: '// &
        trim(adjustl(nodestr))
      call store_error(errmsg)
    end if

Here is the call graph for this function:

noder_to_array()

subroutine basedismodule::noder_to_array ( class(disbasetype)  this, integer(i4b), intent(in)  noder, integer(i4b), dimension(:), intent(inout)  arr  )

private

Definition at line 1009 of file DiscretizationBase.f90.

    ! -- dummy
    class(DisBaseType) :: this
    integer(I4B), intent(in) :: noder
    integer(I4B), dimension(:), intent(inout) :: arr
    ! -- local
    integer(I4B) :: nodeu
 
    nodeu = this%get_nodeuser(noder)
    call this%nodeu_to_array(nodeu, arr)

noder_to_string()

subroutine basedismodule::noder_to_string ( class(disbasetype)  this, integer(i4b), intent(in)  noder, character(len=*), intent(inout)  str  )

private

Definition at line 996 of file DiscretizationBase.f90.

    ! -- dummy
    class(DisBaseType) :: this
    integer(I4B), intent(in) :: noder
    character(len=*), intent(inout) :: str
    ! -- local
    integer(I4B) :: nodeu
 
    nodeu = this%get_nodeuser(noder)
    call this%nodeu_to_string(nodeu, str)

nodeu_from_cellid()

integer(i4b) function basedismodule::nodeu_from_cellid ( class(disbasetype)  this, character(len=*), intent(inout)  cellid, integer(i4b), intent(in)  inunit, integer(i4b), intent(in)  iout, logical, intent(in), optional  flag_string, logical, intent(in), optional  allow_zero  )

private

If flag_string is present and true, the first token may be non-numeric (e.g. boundary name). In this case, return -2.

If allow_zero is present and true, and all indices are zero, the result can be zero. If allow_zero is false, a zero in any index is an error.

Definition at line 523 of file DiscretizationBase.f90.

    ! -- dummy
    class(DisBaseType) :: this
    character(len=*), intent(inout) :: cellid
    integer(I4B), intent(in) :: inunit
    integer(I4B), intent(in) :: iout
    logical, optional, intent(in) :: flag_string
    logical, optional, intent(in) :: allow_zero
    integer(I4B) :: nodeu
 
    nodeu = 0
    call store_error('Programmer error: nodeu_from_cellid must be overridden', &
                     terminate=.true.)

Here is the call graph for this function:

nodeu_from_string()

integer(i4b) function basedismodule::nodeu_from_string ( class(disbasetype)  this, integer(i4b), intent(inout)  lloc, integer(i4b), intent(inout)  istart, integer(i4b), intent(inout)  istop, integer(i4b), intent(in)  in, integer(i4b), intent(in)  iout, character(len=*), intent(inout)  line, logical, intent(in), optional  flag_string, logical, intent(in), optional  allow_zero  )

private

If DIS or DISV, read indices. If DISU, read user node number directly. If flag_string is present and true, the first token may be non-numeric (e.g. boundary name). In this case, return -2.

Definition at line 496 of file DiscretizationBase.f90.

    ! -- dummy
    class(DisBaseType) :: this
    integer(I4B), intent(inout) :: lloc
    integer(I4B), intent(inout) :: istart
    integer(I4B), intent(inout) :: istop
    integer(I4B), intent(in) :: in
    integer(I4B), intent(in) :: iout
    character(len=*), intent(inout) :: line
    logical, optional, intent(in) :: flag_string
    logical, optional, intent(in) :: allow_zero
    integer(I4B) :: nodeu
 
    nodeu = 0
    call store_error('Programmer error: nodeu_from_string must be overridden', &
                     terminate=.true.)

Here is the call graph for this function:

nodeu_to_array()

subroutine basedismodule::nodeu_to_array ( class(disbasetype)  this, integer(i4b), intent(in)  nodeu, integer(i4b), dimension(:), intent(inout)  arr  )

private

Definition at line 262 of file DiscretizationBase.f90.

    class(DisBaseType) :: this
    integer(I4B), intent(in) :: nodeu
    integer(I4B), dimension(:), intent(inout) :: arr
 
    call store_error('Programmer error: nodeu_to_array must be overridden', &
                     terminate=.true.)

Here is the call graph for this function:

nodeu_to_string()

subroutine basedismodule::nodeu_to_string	(	class(disbasetype)	this,
		integer(i4b), intent(in)	nodeu,
		character(len=*), intent(inout)	str
	)

Definition at line 252 of file DiscretizationBase.f90.

    class(DisBaseType) :: this
    integer(I4B), intent(in) :: nodeu
    character(len=*), intent(inout) :: str
 
    call store_error('Programmer error: nodeu_to_string must be overridden', &
                     terminate=.true.)

Here is the call graph for this function:

read_dbl_array()

subroutine basedismodule::read_dbl_array ( class(disbasetype), intent(inout)  this, character(len=*), intent(inout)  line, integer(i4b), intent(inout)  lloc, integer(i4b), intent(inout)  istart, integer(i4b), intent(inout)  istop, integer(i4b), intent(in)  iout, integer(i4b), intent(in)  in, real(dp), dimension(:), intent(inout), pointer, contiguous  darray, character(len=*), intent(in)  aname  )

private

Definition at line 732 of file DiscretizationBase.f90.

    ! -- dummy
    class(DisBaseType), intent(inout) :: this
    character(len=*), intent(inout) :: line
    integer(I4B), intent(inout) :: lloc
    integer(I4B), intent(inout) :: istart
    integer(I4B), intent(inout) :: istop
    integer(I4B), intent(in) :: in
    integer(I4B), intent(in) :: iout
    real(DP), dimension(:), pointer, contiguous, intent(inout) :: darray
    character(len=*), intent(in) :: aname
 
    errmsg = 'Programmer error: read_dbl_array must be overridden'
    call store_error(errmsg, terminate=.true.)

Here is the call graph for this function:

Here is the caller graph for this function:

read_int_array()

subroutine basedismodule::read_int_array ( class(disbasetype), intent(inout)  this, character(len=*), intent(inout)  line, integer(i4b), intent(inout)  lloc, integer(i4b), intent(inout)  istart, integer(i4b), intent(inout)  istop, integer(i4b), intent(in)  iout, integer(i4b), intent(in)  in, integer(i4b), dimension(:), intent(inout), pointer, contiguous  iarray, character(len=*), intent(in)  aname  )

private

Definition at line 714 of file DiscretizationBase.f90.

    ! -- dummy
    class(DisBaseType), intent(inout) :: this
    character(len=*), intent(inout) :: line
    integer(I4B), intent(inout) :: lloc
    integer(I4B), intent(inout) :: istart
    integer(I4B), intent(inout) :: istop
    integer(I4B), intent(in) :: in
    integer(I4B), intent(in) :: iout
    integer(I4B), dimension(:), pointer, contiguous, intent(inout) :: iarray
    character(len=*), intent(in) :: aname
 
    errmsg = 'Programmer error: read_int_array must be overridden'
    call store_error(errmsg, terminate=.true.)

Here is the call graph for this function:

Here is the caller graph for this function:

read_layer_array()

subroutine basedismodule::read_layer_array	(	class(disbasetype)	this,
		integer(i4b), dimension(maxbnd)	nodelist,
		real(dp), dimension(ncolbnd, maxbnd), intent(inout)	darray,
		integer(i4b), intent(in)	ncolbnd,
		integer(i4b), intent(in)	maxbnd,
		integer(i4b), intent(in)	icolbnd,
		character(len=*), intent(in)	aname,
		integer(i4b), intent(in)	inunit,
		integer(i4b), intent(in)	iout
	)

For cells that are outside of the active domain, do not copy the array value into darray.

Definition at line 938 of file DiscretizationBase.f90.

    ! -- dummy
    class(DisBaseType) :: this
    integer(I4B), intent(in) :: ncolbnd
    integer(I4B), intent(in) :: maxbnd
    integer(I4B), dimension(maxbnd) :: nodelist
    real(DP), dimension(ncolbnd, maxbnd), intent(inout) :: darray
    integer(I4B), intent(in) :: icolbnd
    character(len=*), intent(in) :: aname
    integer(I4B), intent(in) :: inunit
    integer(I4B), intent(in) :: iout
 
    errmsg = 'Programmer error: read_layer_array must be overridden'
    call store_error(errmsg, terminate=.true.)

Here is the call graph for this function:

read_list()

subroutine basedismodule::read_list ( class(disbasetype)  this, type(longlinereadertype), intent(inout)  line_reader, integer(i4b), intent(in)  in, integer(i4b), intent(in)  iout, integer(i4b), intent(in)  iprpak, integer(i4b), intent(inout)  nlist, integer(i4b), intent(in)  inamedbound, integer(i4b), intent(in)  iauxmultcol, integer(i4b), dimension(:), intent(inout), pointer, contiguous  nodelist, real(dp), dimension(:, :), intent(inout), pointer, contiguous  rlist, real(dp), dimension(:, :), intent(inout), pointer, contiguous  auxvar, character(len=lenauxname), dimension(:), intent(inout)  auxname, character(len=lenboundname), dimension(:), intent(inout), pointer, contiguous  boundname, character(len=*), intent(in)  label, character(len=*), intent(in)  pkgname, type(timeseriesmanagertype)  tsManager, integer(i4b), intent(in)  iscloc, integer(i4b), intent(in), optional  indxconvertflux  )

private

Convert user node numbers to reduced numbers. Terminate if any nodenumbers are within an inactive domain. Set up time series and multiply by iauxmultcol if it exists. Write the list to iout if iprpak is set.

Definition at line 790 of file DiscretizationBase.f90.

    ! -- modules
    use constantsmodule, only: lenboundname, linelength
    use longlinereadermodule, only: longlinereadertype
    use listreadermodule, only: listreadertype
    use simmodule, only: store_error, store_error_unit, count_errors
    use inputoutputmodule, only: urword
    use timeserieslinkmodule, only: timeserieslinktype
    use timeseriesmanagermodule, only: read_value_or_time_series
    ! -- dummy
    class(DisBaseType) :: this
    type(LongLineReaderType), intent(inout) :: line_reader
    integer(I4B), intent(in) :: in
    integer(I4B), intent(in) :: iout
    integer(I4B), intent(in) :: iprpak
    integer(I4B), intent(inout) :: nlist
    integer(I4B), intent(in) :: inamedbound
    integer(I4B), intent(in) :: iauxmultcol
    integer(I4B), dimension(:), pointer, contiguous, intent(inout) :: nodelist
    real(DP), dimension(:, :), pointer, contiguous, intent(inout) :: rlist
    real(DP), dimension(:, :), pointer, contiguous, intent(inout) :: auxvar
    character(len=LENAUXNAME), dimension(:), intent(inout) :: auxname
    character(len=LENBOUNDNAME), dimension(:), pointer, contiguous, &
      intent(inout) :: boundname
    character(len=*), intent(in) :: label
    character(len=*), intent(in) :: pkgName
    type(TimeSeriesManagerType) :: tsManager
    integer(I4B), intent(in) :: iscloc
    integer(I4B), intent(in), optional :: indxconvertflux
    ! -- local
    integer(I4B) :: l
    integer(I4B) :: nodeu, noder
    character(len=LINELENGTH) :: nodestr
    integer(I4B) :: ii, jj
    real(DP), pointer :: bndElem => null()
    type(ListReaderType) :: lstrdobj
    type(TimeSeriesLinkType), pointer :: tsLinkBnd => null()
    type(TimeSeriesLinkType), pointer :: tsLinkAux => null()
    !
    ! -- Read the list
    call lstrdobj%read_list(line_reader, in, iout, nlist, inamedbound, &
                            this%mshape, nodelist, rlist, auxvar, auxname, &
                            boundname, label)
    !
    ! -- Go through all locations where a text string was found instead of
    !    a double precision value and make time-series links to rlist
    if (lstrdobj%ntxtrlist > 0) then
      do l = 1, lstrdobj%ntxtrlist
        ii = lstrdobj%idxtxtrow(l)
        jj = lstrdobj%idxtxtcol(l)
        tslinkbnd => null()
        bndelem => rlist(jj, ii)
        call read_value_or_time_series(lstrdobj%txtrlist(l), ii, jj, bndelem, &
                                       pkgname, 'BND', tsmanager, iprpak, &
                                       tslinkbnd)
        if (associated(tslinkbnd)) then
          !
          ! -- If iauxmultcol is active and this column is the column
          !    to be scaled, then assign tsLinkBnd%RMultiplier to auxvar
          !    multiplier
          if (iauxmultcol > 0 .and. jj == iscloc) then
            tslinkbnd%RMultiplier => auxvar(iauxmultcol, ii)
          end if
          !
          ! -- If boundaries are named, save the name in the link
          if (lstrdobj%inamedbound == 1) then
            tslinkbnd%BndName = lstrdobj%boundname(tslinkbnd%IRow)
          end if
          !
          ! -- if the value is a flux and needs to be converted to a flow
          !    then set the tsLinkBnd appropriately
          if (present(indxconvertflux)) then
            if (indxconvertflux == jj) then
              tslinkbnd%convertflux = .true.
              nodeu = nodelist(ii)
              noder = this%get_nodenumber(nodeu, 0)
              tslinkbnd%CellArea = this%get_area(noder)
            end if
          end if
          !
        end if
      end do
    end if
    !
    ! -- Make time-series substitutions for auxvar
    if (lstrdobj%ntxtauxvar > 0) then
      do l = 1, lstrdobj%ntxtauxvar
        ii = lstrdobj%idxtxtauxrow(l)
        jj = lstrdobj%idxtxtauxcol(l)
        tslinkaux => null()
        bndelem => auxvar(jj, ii)
        call read_value_or_time_series(lstrdobj%txtauxvar(l), ii, jj, bndelem, &
                                       pkgname, 'AUX', tsmanager, iprpak, &
                                       tslinkaux)
        if (lstrdobj%inamedbound == 1) then
          if (associated(tslinkaux)) then
            tslinkaux%BndName = lstrdobj%boundname(tslinkaux%IRow)
          end if
        end if
      end do
    end if
    !
    ! -- Multiply rlist by the multiplier column in auxvar
    if (iauxmultcol > 0) then
      do l = 1, nlist
        rlist(iscloc, l) = rlist(iscloc, l) * auxvar(iauxmultcol, l)
      end do
    end if
    !
    ! -- Write the list to iout if requested
    if (iprpak /= 0) then
      call lstrdobj%write_list()
    end if
    !
    ! -- Convert user nodenumbers to reduced nodenumbers, if necessary.
    !    Conversion to reduced nodenumbers must be done last, after the
    !    list is written so that correct indices are written to the list.
    if (this%nodes < this%nodesuser) then
      do l = 1, nlist
        nodeu = nodelist(l)
        noder = this%get_nodenumber(nodeu, 0)
        if (noder <= 0) then
          call this%nodeu_to_string(nodeu, nodestr)
          write (errmsg, *) &
            ' Cell is outside active grid domain: '// &
            trim(adjustl(nodestr))
          call store_error(errmsg)
        end if
        nodelist(l) = noder
      end do
      !
      ! -- Check for errors and terminate if encountered
      if (count_errors() > 0) then
        write (errmsg, *) count_errors(), ' errors encountered.'
        call store_error(errmsg)
        call store_error_unit(in)
      end if
    end if

Here is the call graph for this function:

record_array()

subroutine basedismodule::record_array ( class(disbasetype), intent(inout)  this, real(dp), dimension(:), intent(inout), pointer, contiguous  darray, integer(i4b), intent(in)  iout, integer(i4b), intent(in)  iprint, integer(i4b), intent(in)  idataun, character(len=*), intent(in)  aname, character(len=*), intent(in)  cdatafmp, integer(i4b), intent(in)  nvaluesp, integer(i4b), intent(in)  nwidthp, character(len=*), intent(in)  editdesc, real(dp), intent(in)  dinact  )

private

The array is written to a formatted or unformatted external file depending on the arguments.

Parameters

[in,out]	darray	double precision array to record
[in]	iout	ascii output unit number
[in]	iprint	whether to print the array
[in]	idataun	binary output unit number
[in]	aname	text descriptor
[in]	cdatafmp	write format
[in]	nvaluesp	values per line
[in]	nwidthp	number width
[in]	editdesc	format type (I, G, F, S, E)
[in]	dinact	double precision value for cells excluded from model domain

Definition at line 959 of file DiscretizationBase.f90.

    ! -- dummy
    class(DisBaseType), intent(inout) :: this
    real(DP), dimension(:), pointer, contiguous, intent(inout) :: darray !< double precision array to record
    integer(I4B), intent(in) :: iout !< ascii output unit number
    integer(I4B), intent(in) :: iprint !< whether to print the array
    integer(I4B), intent(in) :: idataun !< binary output unit number
    character(len=*), intent(in) :: aname !< text descriptor
    character(len=*), intent(in) :: cdatafmp !< write format
    integer(I4B), intent(in) :: nvaluesp !< values per line
    integer(I4B), intent(in) :: nwidthp !< number width
    character(len=*), intent(in) :: editdesc !< format type (I, G, F, S, E)
    real(DP), intent(in) :: dinact !< double precision value for cells excluded from model domain
 
    errmsg = 'Programmer error: record_array must be overridden'
    call store_error(errmsg, terminate=.true.)

Here is the call graph for this function:

record_connection_array()

subroutine basedismodule::record_connection_array ( class(disbasetype)  this, real(dp), dimension(:), intent(in)  flowja, integer(i4b), intent(in)  ibinun, integer(i4b), intent(in)  iout  )

private

Definition at line 979 of file DiscretizationBase.f90.

    ! -- dummy
    class(DisBaseType) :: this
    real(DP), dimension(:), intent(in) :: flowja
    integer(I4B), intent(in) :: ibinun
    integer(I4B), intent(in) :: iout
    ! -- local
    character(len=16), dimension(1) :: text
    ! -- data
    data text(1)/'    FLOW-JA-FACE'/
 
    ! -- write full ja array
    call ubdsv1(kstp, kper, text(1), ibinun, flowja, size(flowja), 1, 1, &
                iout, delt, pertim, totim)

Here is the call graph for this function:

record_srcdst_list_entry()

subroutine basedismodule::record_srcdst_list_entry ( class(disbasetype)  this, integer(i4b), intent(in)  ibdchn, integer(i4b), intent(in)  noder, integer(i4b), intent(in)  noder2, real(dp), intent(in)  q, integer(i4b), intent(in)  naux, real(dp), dimension(naux), intent(in)  aux, logical, intent(in), optional  olconv, logical, intent(in), optional  olconv2  )

private

Definition at line 1042 of file DiscretizationBase.f90.

    ! -- dummy
    class(DisBaseType) :: this
    integer(I4B), intent(in) :: ibdchn
    integer(I4B), intent(in) :: noder
    integer(I4B), intent(in) :: noder2
    real(DP), intent(in) :: q
    integer(I4B), intent(in) :: naux
    real(DP), dimension(naux), intent(in) :: aux
    logical, optional, intent(in) :: olconv
    logical, optional, intent(in) :: olconv2
    ! -- local
    logical :: lconv
    logical :: lconv2
    integer(I4B) :: nodeu
    integer(I4B) :: nodeu2
    !
    ! -- Use ubdsvb to write list header
    if (present(olconv)) then
      lconv = olconv
    else
      lconv = .true.
    end if
    if (lconv) then
      nodeu = this%get_nodeuser(noder)
    else
      nodeu = noder
    end if
    if (present(olconv2)) then
      lconv2 = olconv2
    else
      lconv2 = .true.
    end if
    if (lconv2) then
      nodeu2 = this%get_nodeuser(noder2)
    else
      nodeu2 = noder2
    end if
    call ubdsvd(ibdchn, nodeu, nodeu2, q, naux, aux)

Here is the call graph for this function:

Here is the caller graph for this function:

record_srcdst_list_header()

subroutine basedismodule::record_srcdst_list_header ( class(disbasetype)  this, character(len=16), intent(in)  text, character(len=16), intent(in)  textmodel, character(len=16), intent(in)  textpackage, character(len=16), intent(in)  dstmodel, character(len=16), intent(in)  dstpackage, integer(i4b), intent(in)  naux, character(len=16), dimension(:), intent(in)  auxtxt, integer(i4b), intent(in)  ibdchn, integer(i4b), intent(in)  nlist, integer(i4b), intent(in)  iout  )

private

Definition at line 1022 of file DiscretizationBase.f90.

    class(DisBaseType) :: this
    character(len=16), intent(in) :: text
    character(len=16), intent(in) :: textmodel
    character(len=16), intent(in) :: textpackage
    character(len=16), intent(in) :: dstmodel
    character(len=16), intent(in) :: dstpackage
    integer(I4B), intent(in) :: naux
    character(len=16), dimension(:), intent(in) :: auxtxt
    integer(I4B), intent(in) :: ibdchn
    integer(I4B), intent(in) :: nlist
    integer(I4B), intent(in) :: iout
 
    errmsg = 'Programmer error: record_srcdst_list_header must be overridden'
    call store_error(errmsg, terminate=.true.)

Here is the call graph for this function:

supports_layers()

logical function basedismodule::supports_layers ( class(disbasetype)  this )

private

Definition at line 641 of file DiscretizationBase.f90.

    class(DisBaseType) :: this
    supports_layers = .false.
    call store_error('Programmer error: supports_layers must be overridden', &
                     terminate=.true.)

Here is the call graph for this function:

write_grb()

subroutine basedismodule::write_grb ( class(disbasetype)  this, integer(i4b), dimension(:), intent(in)  icelltype  )

private

Definition at line 202 of file DiscretizationBase.f90.

    class(DisBaseType) :: this
    integer(I4B), dimension(:), intent(in) :: icelltype
    call store_error('Programmer error: write_grb must be overridden', &
                     terminate=.true.)

Here is the call graph for this function: