MODFLOW 6  version 6.5.0.dev2
MODFLOW 6 Code Documentation
Public Member Functions | Private Member Functions | Private Attributes | List of all members
basedismodule::disbasetype Type Reference
Inheritance diagram for basedismodule::disbasetype:
Inheritance graph
Collaboration diagram for basedismodule::disbasetype:
Collaboration graph

Public Member Functions

generic, public read_grid_array => read_int_array, read_dbl_array
 
procedure, public read_layer_array
 
generic, public fill_grid_array => fill_int_array, fill_dbl_array
 
procedure, public read_list
 
procedure, public record_array
 
procedure, public record_connection_array
 
procedure, public noder_to_string
 
procedure, public noder_to_array
 
procedure, public record_srcdst_list_header
 
generic, public record_mf6_list_entry => record_srcdst_list_entry
 
procedure, public nlarray_to_nodelist
 
procedure, public highest_active
 
procedure, public get_area
 
procedure, public get_area_factor
 
procedure, public get_flow_width
 

Private Member Functions

procedure dis_df
 
procedure dis_ac
 
procedure dis_mc
 
procedure dis_ar
 
procedure dis_da
 
generic get_nodenumber => get_nodenumber_idx1, get_nodenumber_idx2, get_nodenumber_idx3
 
procedure get_nodenumber_idx1
 
procedure get_nodenumber_idx2
 
procedure get_nodenumber_idx3
 
procedure get_nodeuser
 
procedure nodeu_to_string
 
procedure nodeu_to_array
 
procedure nodeu_from_string
 
procedure nodeu_from_cellid
 
procedure noder_from_string
 
procedure noder_from_cellid
 
procedure connection_normal
 
procedure connection_vector
 
procedure get_dis_type
 
procedure get_dis_enum
 
procedure supports_layers
 
procedure allocate_scalars
 
procedure allocate_arrays
 
procedure get_ncpl
 
procedure get_cell_volume
 
procedure get_polyverts
 
procedure write_grb
 
procedure read_int_array
 
procedure read_dbl_array
 
procedure fill_int_array
 
procedure fill_dbl_array
 
procedure, private record_srcdst_list_entry
 

Private Attributes

character(len=lenmempath) memorypath
 path for memory allocation More...
 
character(len=lenmempath) input_mempath = ''
 input context mempath More...
 
character(len=lenmodelname), pointer name_model => null()
 name of the model More...
 
character(len=linelength), pointer input_fname => null()
 input file name More...
 
integer(i4b), pointer inunit => null()
 unit number for input file More...
 
integer(i4b), pointer iout => null()
 unit number for output file More...
 
integer(i4b), pointer nodes => null()
 number of nodes in solution More...
 
integer(i4b), pointer nodesuser => null()
 number of user nodes (same as nodes for disu grid) More...
 
integer(i4b), pointer nja => null()
 number of connections plus number of nodes More...
 
integer(i4b), pointer njas => null()
 (nja-nodes)/2 More...
 
integer(i4b), pointer lenuni => null()
 length unit More...
 
integer(i4b), pointer ndim => null()
 number of spatial model dimensions (1 for disu grid) More...
 
integer(i4b), pointer icondir => null()
 flag indicating if grid has enough info to calculate connection vectors More...
 
integer(i4b), pointer nogrb => null()
 don't write binary grid file More...
 
real(dp), dimension(:), pointer, contiguous xc => null()
 x-coordinate of the cell center More...
 
real(dp), dimension(:), pointer, contiguous yc => null()
 y-coordinate of the cell center More...
 
real(dp), pointer yorigin => null()
 y-position of the lower-left grid corner (default is 0.) More...
 
real(dp), pointer xorigin => null()
 x-position of the lower-left grid corner (default is 0.) More...
 
real(dp), pointer angrot => null()
 counter-clockwise rotation angle of the lower-left corner (default is 0.0) More...
 
integer(i4b), dimension(:), pointer, contiguous mshape => null()
 shape of the model; (nodes) for DisBaseType More...
 
real(dp), dimension(:), pointer, contiguous top => null()
 (size:nodes) cell top elevation More...
 
real(dp), dimension(:), pointer, contiguous bot => null()
 (size:nodes) cell bottom elevation More...
 
real(dp), dimension(:), pointer, contiguous area => null()
 (size:nodes) cell area, in plan view More...
 
type(connectionstype), pointer con => null()
 connections object More...
 
type(blockparsertype) parser
 object to read blocks More...
 
real(dp), dimension(:), pointer, contiguous dbuff => null()
 helper double array of size nodesuser More...
 
integer(i4b), dimension(:), pointer, contiguous ibuff => null()
 helper int array of size nodesuser More...
 
integer(i4b), dimension(:), pointer, contiguous nodereduced => null()
 (size:nodesuser)contains reduced nodenumber (size 0 if not reduced); -1 means vertical pass through, 0 is idomain = 0 More...
 
integer(i4b), dimension(:), pointer, contiguous nodeuser => null()
 (size:nodes) given a reduced nodenumber, provide the user nodenumber (size 0 if not reduced) More...
 

Detailed Description

Definition at line 26 of file DiscretizationBase.f90.

Member Function/Subroutine Documentation

◆ allocate_arrays()

procedure basedismodule::disbasetype::allocate_arrays
private

Definition at line 88 of file DiscretizationBase.f90.

◆ allocate_scalars()

procedure basedismodule::disbasetype::allocate_scalars
private

Definition at line 87 of file DiscretizationBase.f90.

◆ connection_normal()

procedure basedismodule::disbasetype::connection_normal
private

Definition at line 82 of file DiscretizationBase.f90.

◆ connection_vector()

procedure basedismodule::disbasetype::connection_vector
private

Definition at line 83 of file DiscretizationBase.f90.

◆ dis_ac()

procedure basedismodule::disbasetype::dis_ac
private

Definition at line 58 of file DiscretizationBase.f90.

◆ dis_ar()

procedure basedismodule::disbasetype::dis_ar
private

Definition at line 60 of file DiscretizationBase.f90.

◆ dis_da()

procedure basedismodule::disbasetype::dis_da
private

Definition at line 61 of file DiscretizationBase.f90.

◆ dis_df()

procedure basedismodule::disbasetype::dis_df
private

Definition at line 57 of file DiscretizationBase.f90.

◆ dis_mc()

procedure basedismodule::disbasetype::dis_mc
private

Definition at line 59 of file DiscretizationBase.f90.

◆ fill_dbl_array()

procedure basedismodule::disbasetype::fill_dbl_array
private

Definition at line 99 of file DiscretizationBase.f90.

◆ fill_grid_array()

generic, public basedismodule::disbasetype::fill_grid_array

Definition at line 100 of file DiscretizationBase.f90.

Here is the call graph for this function:

◆ fill_int_array()

procedure basedismodule::disbasetype::fill_int_array
private

Definition at line 98 of file DiscretizationBase.f90.

◆ get_area()

procedure, public basedismodule::disbasetype::get_area

Definition at line 112 of file DiscretizationBase.f90.

◆ get_area_factor()

procedure, public basedismodule::disbasetype::get_area_factor

Definition at line 113 of file DiscretizationBase.f90.

◆ get_cell_volume()

procedure basedismodule::disbasetype::get_cell_volume
private

Definition at line 90 of file DiscretizationBase.f90.

◆ get_dis_enum()

procedure basedismodule::disbasetype::get_dis_enum
private

Definition at line 85 of file DiscretizationBase.f90.

◆ get_dis_type()

procedure basedismodule::disbasetype::get_dis_type
private

Definition at line 84 of file DiscretizationBase.f90.

◆ get_flow_width()

procedure, public basedismodule::disbasetype::get_flow_width

Definition at line 114 of file DiscretizationBase.f90.

◆ get_ncpl()

procedure basedismodule::disbasetype::get_ncpl
private

Definition at line 89 of file DiscretizationBase.f90.

◆ get_nodenumber()

generic basedismodule::disbasetype::get_nodenumber
private

Definition at line 69 of file DiscretizationBase.f90.

Here is the call graph for this function:

◆ get_nodenumber_idx1()

procedure basedismodule::disbasetype::get_nodenumber_idx1
private

Definition at line 72 of file DiscretizationBase.f90.

◆ get_nodenumber_idx2()

procedure basedismodule::disbasetype::get_nodenumber_idx2
private

Definition at line 73 of file DiscretizationBase.f90.

◆ get_nodenumber_idx3()

procedure basedismodule::disbasetype::get_nodenumber_idx3
private

Definition at line 74 of file DiscretizationBase.f90.

◆ get_nodeuser()

procedure basedismodule::disbasetype::get_nodeuser
private

Definition at line 75 of file DiscretizationBase.f90.

◆ get_polyverts()

procedure basedismodule::disbasetype::get_polyverts
private

Definition at line 91 of file DiscretizationBase.f90.

◆ highest_active()

procedure, public basedismodule::disbasetype::highest_active

Definition at line 111 of file DiscretizationBase.f90.

◆ nlarray_to_nodelist()

procedure, public basedismodule::disbasetype::nlarray_to_nodelist

Definition at line 110 of file DiscretizationBase.f90.

◆ noder_from_cellid()

procedure basedismodule::disbasetype::noder_from_cellid
private

Definition at line 81 of file DiscretizationBase.f90.

◆ noder_from_string()

procedure basedismodule::disbasetype::noder_from_string
private

Definition at line 80 of file DiscretizationBase.f90.

◆ noder_to_array()

procedure, public basedismodule::disbasetype::noder_to_array

Definition at line 106 of file DiscretizationBase.f90.

◆ noder_to_string()

procedure, public basedismodule::disbasetype::noder_to_string

Definition at line 105 of file DiscretizationBase.f90.

◆ nodeu_from_cellid()

procedure basedismodule::disbasetype::nodeu_from_cellid
private

Definition at line 79 of file DiscretizationBase.f90.

◆ nodeu_from_string()

procedure basedismodule::disbasetype::nodeu_from_string
private

Definition at line 78 of file DiscretizationBase.f90.

◆ nodeu_to_array()

procedure basedismodule::disbasetype::nodeu_to_array
private

Definition at line 77 of file DiscretizationBase.f90.

◆ nodeu_to_string()

procedure basedismodule::disbasetype::nodeu_to_string
private

Definition at line 76 of file DiscretizationBase.f90.

◆ read_dbl_array()

procedure basedismodule::disbasetype::read_dbl_array
private

Definition at line 95 of file DiscretizationBase.f90.

◆ read_grid_array()

generic, public basedismodule::disbasetype::read_grid_array

Definition at line 96 of file DiscretizationBase.f90.

Here is the call graph for this function:

◆ read_int_array()

procedure basedismodule::disbasetype::read_int_array
private

Definition at line 94 of file DiscretizationBase.f90.

◆ read_layer_array()

procedure, public basedismodule::disbasetype::read_layer_array

Definition at line 97 of file DiscretizationBase.f90.

◆ read_list()

procedure, public basedismodule::disbasetype::read_list

Definition at line 101 of file DiscretizationBase.f90.

◆ record_array()

procedure, public basedismodule::disbasetype::record_array

Definition at line 103 of file DiscretizationBase.f90.

◆ record_connection_array()

procedure, public basedismodule::disbasetype::record_connection_array

Definition at line 104 of file DiscretizationBase.f90.

◆ record_mf6_list_entry()

generic, public basedismodule::disbasetype::record_mf6_list_entry

Definition at line 109 of file DiscretizationBase.f90.

Here is the call graph for this function:

◆ record_srcdst_list_entry()

procedure, private basedismodule::disbasetype::record_srcdst_list_entry
private

Definition at line 108 of file DiscretizationBase.f90.

◆ record_srcdst_list_header()

procedure, public basedismodule::disbasetype::record_srcdst_list_header

Definition at line 107 of file DiscretizationBase.f90.

◆ supports_layers()

procedure basedismodule::disbasetype::supports_layers
private

Definition at line 86 of file DiscretizationBase.f90.

◆ write_grb()

procedure basedismodule::disbasetype::write_grb
private

Definition at line 92 of file DiscretizationBase.f90.

Member Data Documentation

◆ angrot

real(dp), pointer basedismodule::disbasetype::angrot => null()
private

Definition at line 45 of file DiscretizationBase.f90.

45  real(DP), pointer :: angrot => null() !< counter-clockwise rotation angle of the lower-left corner (default is 0.0)

◆ area

real(dp), dimension(:), pointer, contiguous basedismodule::disbasetype::area => null()
private

Definition at line 49 of file DiscretizationBase.f90.

49  real(DP), dimension(:), pointer, contiguous :: area => null() !< (size:nodes) cell area, in plan view

◆ bot

real(dp), dimension(:), pointer, contiguous basedismodule::disbasetype::bot => null()
private

Definition at line 48 of file DiscretizationBase.f90.

48  real(DP), dimension(:), pointer, contiguous :: bot => null() !< (size:nodes) cell bottom elevation

◆ con

type(connectionstype), pointer basedismodule::disbasetype::con => null()
private

Definition at line 50 of file DiscretizationBase.f90.

50  type(ConnectionsType), pointer :: con => null() !< connections object

◆ dbuff

real(dp), dimension(:), pointer, contiguous basedismodule::disbasetype::dbuff => null()
private

Definition at line 52 of file DiscretizationBase.f90.

52  real(DP), dimension(:), pointer, contiguous :: dbuff => null() !< helper double array of size nodesuser

◆ ibuff

integer(i4b), dimension(:), pointer, contiguous basedismodule::disbasetype::ibuff => null()
private

Definition at line 53 of file DiscretizationBase.f90.

53  integer(I4B), dimension(:), pointer, contiguous :: ibuff => null() !< helper int array of size nodesuser

◆ icondir

integer(i4b), pointer basedismodule::disbasetype::icondir => null()
private

Definition at line 39 of file DiscretizationBase.f90.

39  integer(I4B), pointer :: icondir => null() !< flag indicating if grid has enough info to calculate connection vectors

◆ input_fname

character(len=linelength), pointer basedismodule::disbasetype::input_fname => null()
private

Definition at line 30 of file DiscretizationBase.f90.

30  character(len=LINELENGTH), pointer :: input_fname => null() !< input file name

◆ input_mempath

character(len=lenmempath) basedismodule::disbasetype::input_mempath = ''
private

Definition at line 28 of file DiscretizationBase.f90.

28  character(len=LENMEMPATH) :: input_mempath = '' !< input context mempath

◆ inunit

integer(i4b), pointer basedismodule::disbasetype::inunit => null()
private

Definition at line 31 of file DiscretizationBase.f90.

31  integer(I4B), pointer :: inunit => null() !< unit number for input file

◆ iout

integer(i4b), pointer basedismodule::disbasetype::iout => null()
private

Definition at line 32 of file DiscretizationBase.f90.

32  integer(I4B), pointer :: iout => null() !< unit number for output file

◆ lenuni

integer(i4b), pointer basedismodule::disbasetype::lenuni => null()
private

Definition at line 37 of file DiscretizationBase.f90.

37  integer(I4B), pointer :: lenuni => null() !< length unit

◆ memorypath

character(len=lenmempath) basedismodule::disbasetype::memorypath
private

Definition at line 27 of file DiscretizationBase.f90.

27  character(len=LENMEMPATH) :: memoryPath !< path for memory allocation

◆ mshape

integer(i4b), dimension(:), pointer, contiguous basedismodule::disbasetype::mshape => null()
private

Definition at line 46 of file DiscretizationBase.f90.

46  integer(I4B), dimension(:), pointer, contiguous :: mshape => null() !< shape of the model; (nodes) for DisBaseType

◆ name_model

character(len=lenmodelname), pointer basedismodule::disbasetype::name_model => null()
private

Definition at line 29 of file DiscretizationBase.f90.

29  character(len=LENMODELNAME), pointer :: name_model => null() !< name of the model

◆ ndim

integer(i4b), pointer basedismodule::disbasetype::ndim => null()
private

Definition at line 38 of file DiscretizationBase.f90.

38  integer(I4B), pointer :: ndim => null() !< number of spatial model dimensions (1 for disu grid)

◆ nja

integer(i4b), pointer basedismodule::disbasetype::nja => null()
private

Definition at line 35 of file DiscretizationBase.f90.

35  integer(I4B), pointer :: nja => null() !< number of connections plus number of nodes

◆ njas

integer(i4b), pointer basedismodule::disbasetype::njas => null()
private

Definition at line 36 of file DiscretizationBase.f90.

36  integer(I4B), pointer :: njas => null() !< (nja-nodes)/2

◆ nodereduced

integer(i4b), dimension(:), pointer, contiguous basedismodule::disbasetype::nodereduced => null()
private

Definition at line 54 of file DiscretizationBase.f90.

54  integer(I4B), dimension(:), pointer, contiguous :: nodereduced => null() !< (size:nodesuser)contains reduced nodenumber (size 0 if not reduced); -1 means vertical pass through, 0 is idomain = 0

◆ nodes

integer(i4b), pointer basedismodule::disbasetype::nodes => null()
private

Definition at line 33 of file DiscretizationBase.f90.

33  integer(I4B), pointer :: nodes => null() !< number of nodes in solution

◆ nodesuser

integer(i4b), pointer basedismodule::disbasetype::nodesuser => null()
private

Definition at line 34 of file DiscretizationBase.f90.

34  integer(I4B), pointer :: nodesuser => null() !< number of user nodes (same as nodes for disu grid)

◆ nodeuser

integer(i4b), dimension(:), pointer, contiguous basedismodule::disbasetype::nodeuser => null()
private

Definition at line 55 of file DiscretizationBase.f90.

55  integer(I4B), dimension(:), pointer, contiguous :: nodeuser => null() !< (size:nodes) given a reduced nodenumber, provide the user nodenumber (size 0 if not reduced)

◆ nogrb

integer(i4b), pointer basedismodule::disbasetype::nogrb => null()
private

Definition at line 40 of file DiscretizationBase.f90.

40  integer(I4B), pointer :: nogrb => null() !< don't write binary grid file

◆ parser

type(blockparsertype) basedismodule::disbasetype::parser
private

Definition at line 51 of file DiscretizationBase.f90.

51  type(BlockParserType) :: parser !< object to read blocks

◆ top

real(dp), dimension(:), pointer, contiguous basedismodule::disbasetype::top => null()
private

Definition at line 47 of file DiscretizationBase.f90.

47  real(DP), dimension(:), pointer, contiguous :: top => null() !< (size:nodes) cell top elevation

◆ xc

real(dp), dimension(:), pointer, contiguous basedismodule::disbasetype::xc => null()
private

Definition at line 41 of file DiscretizationBase.f90.

41  real(DP), dimension(:), pointer, contiguous :: xc => null() !< x-coordinate of the cell center

◆ xorigin

real(dp), pointer basedismodule::disbasetype::xorigin => null()
private

Definition at line 44 of file DiscretizationBase.f90.

44  real(DP), pointer :: xorigin => null() !< x-position of the lower-left grid corner (default is 0.)

◆ yc

real(dp), dimension(:), pointer, contiguous basedismodule::disbasetype::yc => null()
private

Definition at line 42 of file DiscretizationBase.f90.

42  real(DP), dimension(:), pointer, contiguous :: yc => null() !< y-coordinate of the cell center

◆ yorigin

real(dp), pointer basedismodule::disbasetype::yorigin => null()
private

Definition at line 43 of file DiscretizationBase.f90.

43  real(DP), pointer :: yorigin => null() !< y-position of the lower-left grid corner (default is 0.)
The documentation for this type was generated from the following file: