MODFLOW 6 version 6.9.0.dev0
USGS Modular Hydrologic Model
Loading...
Searching...
No Matches
ghostnodemodule::ghostnodetype Type Reference
Inheritance diagram for ghostnodemodule::ghostnodetype:
Inheritance graph
Collaboration diagram for ghostnodemodule::ghostnodetype:
Collaboration graph

Public Member Functions

procedure gnc_df (this, m1, m2)
 Initialize a gnc object.
procedure gnc_ac (this, sparse)
 Single or Two-Model GNC Add Connections.
procedure gnc_mc (this, matrix_sln)
 Single or Two-Model GNC Map Connections.
procedure gnc_fc (this, kiter, matrix)
 Fill matrix terms.
procedure gnc_fn (this, kiter, matrix_sln, condsat, ihc_opt, ivarcv_opt, ictm1_opt, ictm2_opt)
 Fill GNC Newton terms.
procedure gnc_cq (this, flowja)
 Add GNC to flowja.
procedure gnc_ot (this, ibudfl)
 Single Model GNC Output.
procedure gnc_da (this)
 Deallocate memory.
procedure deltaqgnc (this, ignc)
 Single Model deltaQgnc (ghost node correction flux).
procedure allocate_scalars (this)
 Allocate gnc scalar variables.
procedure set_names (this, ibcnum, name_model, pakname, ftype, input_mempath)
 Set package names.
procedure allocate_scalars (this)
 Allocate package scalars.
procedure da (this)
 Deallocate package scalars.
procedure read_check_ionper (this)
 Check ionper.
procedure get_block_data (this, tags, lfound, varinames)
 Read griddata block for a package.

Public Attributes

logical, pointer smgnc => null()
logical, pointer implicit => null()
logical, pointer i2kn => null()
integer(i4b), pointer nexg => null()
integer(i4b), pointer numjs => null()
class(numericalmodeltype), pointer m1 => null()
class(numericalmodeltype), pointer m2 => null()
integer(i4b), dimension(:), pointer, contiguous nodem1 => null()
integer(i4b), dimension(:), pointer, contiguous nodem2 => null()
integer(i4b), dimension(:, :), pointer, contiguous nodesj => null()
real(dp), dimension(:), pointer, contiguous cond => null()
integer(i4b), dimension(:), pointer, contiguous idxglo => null()
integer(i4b), dimension(:), pointer, contiguous idxsymglo => null()
real(dp), dimension(:, :), pointer, contiguous alphasj => null()
integer(i4b), dimension(:), pointer, contiguous idiagn => null()
integer(i4b), dimension(:), pointer, contiguous idiagm => null()
integer(i4b), dimension(:, :), pointer, contiguous jposinrown => null()
integer(i4b), dimension(:, :), pointer, contiguous jposinrowm => null()
character(len=lenmodelname) name_model = ''
 the name of the model that contains this package
character(len=lenpackagename) packname = ''
 name of the package
character(len=lenmempath) memorypath = ''
 the location in the memory manager where the variables are stored
character(len=lenmempath) memorypathmodel = ''
 the location in the memory manager where the variables of the parent model are stored
character(len=lenmempath) input_mempath = ''
 input context mempath
character(len=linelength), pointer input_fname => null()
 input file name
character(len=lenftype) filtyp = ''
 file type (CHD, DRN, RIV, etc.)
character(len=lenftype), pointer package_type => null()
 package type (same as filtyp) stored in memory manager
integer(i4b), pointer id => null()
 consecutive package number in model
integer(i4b), pointer inunit => null()
 unit number for input file
integer(i4b), pointer iout => null()
 unit number for writing package output
integer(i4b), pointer inewton => null()
 newton flag
integer(i4b), pointer iasym => null()
 package causes matrix asymmetry
integer(i4b), pointer iprpak => null()
 integer flag to echo input
integer(i4b), pointer iprflow => null()
 flag to print simulated flows
integer(i4b), pointer ipakcb => null()
 output flows (-1, 0, 1) - save_flows
integer(i4b), pointer ionper => null()
 stress period for next data
integer(i4b), pointer lastonper => null()
 last value of ionper (for checking)
type(blockparsertype) parser
 parser object for reading blocks of information
class(disbasetype), pointer dis => null()
 model discretization object

Private Member Functions

procedure, private gnc_fmsav (this, kiter, matrix)
 Store the n-m Picard conductance in cond prior to the Newton terms terms being added.
procedure, private allocate_arrays (this)
 Allocate gnc scalar variables.
procedure, private read_options (this)
 Read a gnc options block.
procedure, private read_dimensions (this)
 Single Model GNC Read Dimensions.
procedure, private read_data (this)
 Read a GNCDATA block.
procedure, private nodeu_to_noder (this, nodeu, noder, model)
 Convert the user-based node number into a reduced number.

Detailed Description

Definition at line 16 of file GhostNode.f90.

Member Function/Subroutine Documentation

◆ allocate_arrays()

procedure, private ghostnodemodule::ghostnodetype::allocate_arrays ( class(ghostnodetype) this)
private

Definition at line 49 of file GhostNode.f90.

◆ allocate_scalars() [1/2]

procedure ghostnodemodule::ghostnodetype::allocate_scalars ( class(ghostnodetype) this)

Definition at line 48 of file GhostNode.f90.

◆ allocate_scalars() [2/2]

procedure numericalpackagemodule::numericalpackagetype::allocate_scalars ( class(numericalpackagetype) this)
inherited

Allocate and initialize base numerical package scalars.

Parameters
thisNumericalPackageType object

Definition at line 54 of file NumericalPackage.f90.

◆ da()

procedure numericalpackagemodule::numericalpackagetype::da ( class(numericalpackagetype) this)
inherited

Deallocate and initialize base numerical package scalars.

Parameters
thisNumericalPackageType object

Definition at line 55 of file NumericalPackage.f90.

◆ deltaqgnc()

procedure ghostnodemodule::ghostnodetype::deltaqgnc ( class(ghostnodetype) this,
integer(i4b), intent(in) ignc )

Calculate the deltaQgnc value for any GNC in the GNC list

Definition at line 47 of file GhostNode.f90.

◆ get_block_data()

procedure numericalpackagemodule::numericalpackagetype::get_block_data ( class(numericalpackagetype) this,
character(len=24), dimension(:), intent(in) tags,
logical, dimension(:), intent(inout) lfound,
character(len=24), dimension(:), intent(in), optional varinames )
inherited

Generic method to read data in the GRIDDATA block for a package.

Parameters
thisNumericalPackageType object
[in]tagsvector with variable tags
[in,out]lfoundboolean vector indicating of a variable tag was found
[in]varinamesoptional vector of variable names

Definition at line 57 of file NumericalPackage.f90.

◆ gnc_ac()

procedure ghostnodemodule::ghostnodetype::gnc_ac ( class(ghostnodetype) this,
type(sparsematrix), intent(inout) sparse )

For implicit GNC, expand the sparse solution matrix

Definition at line 39 of file GhostNode.f90.

◆ gnc_cq()

procedure ghostnodemodule::ghostnodetype::gnc_cq ( class(ghostnodetype) this,
real(dp), dimension(:), intent(inout) flowja )

Definition at line 44 of file GhostNode.f90.

◆ gnc_da()

procedure ghostnodemodule::ghostnodetype::gnc_da ( class(ghostnodetype) this)

Definition at line 46 of file GhostNode.f90.

◆ gnc_df()

procedure ghostnodemodule::ghostnodetype::gnc_df ( class(ghostnodetype) this,
class(numericalmodeltype), target m1,
class(numericalmodeltype), optional, target m2 )

Definition at line 38 of file GhostNode.f90.

◆ gnc_fc()

procedure ghostnodemodule::ghostnodetype::gnc_fc ( class(ghostnodetype) this,
integer(i4b), intent(in) kiter,
class(matrixbasetype), pointer matrix )

Add the GNC terms to the solution matrix or model rhs depending on whether whether GNC is implicit or explicit

Definition at line 42 of file GhostNode.f90.

◆ gnc_fmsav()

procedure, private ghostnodemodule::ghostnodetype::gnc_fmsav ( class(ghostnodetype) this,
integer(i4b), intent(in) kiter,
class(matrixbasetype), pointer matrix )
private

Definition at line 41 of file GhostNode.f90.

◆ gnc_fn()

procedure ghostnodemodule::ghostnodetype::gnc_fn ( class(ghostnodetype) this,
integer(i4b) kiter,
class(matrixbasetype), pointer matrix_sln,
real(dp), dimension(:), intent(in) condsat,
integer(i4b), dimension(:), optional ihc_opt,
integer(i4b), optional ivarcv_opt,
integer(i4b), dimension(:), optional ictm1_opt,
integer(i4b), dimension(:), optional ictm2_opt )

Required arguments: kiter : outer iteration number matrix_sln: the solution matrix condsat is of size(njas) if single model, otherwise nexg

Optional arguments: ihc_opt : an optional vector of size(nexg), which contains a horizontal connection code (0=vertical, 1=horizontal, 2=vertically staggered) ivarcv_opt : variable vertical conductance flag (default is 0) ictm1_opt : icelltype for model 1 integer vector (default is 1) ictm2_opt : icelltype for model 2 integer vector (default is 1)

Definition at line 43 of file GhostNode.f90.

◆ gnc_mc()

procedure ghostnodemodule::ghostnodetype::gnc_mc ( class(ghostnodetype) this,
class(matrixbasetype), pointer matrix_sln )

Fill the following mapping arrays: thisidiagn, thisidiagm (diagonal positions in solution amat) thisidxglo (nm connection in solution amat) thisidxsymglo (mn connection in solution amat) thisjposinrown (position of j in row n of solution amat) thisjposinrowm (position of j in row m of solution amat)

Definition at line 40 of file GhostNode.f90.

◆ gnc_ot()

procedure ghostnodemodule::ghostnodetype::gnc_ot ( class(ghostnodetype) this,
integer(i4b), intent(in) ibudfl )

Output GNC deltaQgnc values

Definition at line 45 of file GhostNode.f90.

◆ nodeu_to_noder()

procedure, private ghostnodemodule::ghostnodetype::nodeu_to_noder ( class(ghostnodetype) this,
integer(i4b), intent(in) nodeu,
integer(i4b), intent(inout) noder,
class(numericalmodeltype), intent(in) model )
private

Definition at line 53 of file GhostNode.f90.

◆ read_check_ionper()

procedure numericalpackagemodule::numericalpackagetype::read_check_ionper ( class(numericalpackagetype), intent(inout) this)
inherited

Generic method to read and check ionperiod, which is used to determine if new period data should be read from the input file. The check of ionperiod also makes sure periods are increasing in subsequent period data blocks.

Parameters
[in,out]thisNumericalPackageType object

Definition at line 56 of file NumericalPackage.f90.

◆ read_data()

procedure, private ghostnodemodule::ghostnodetype::read_data ( class(ghostnodetype) this)
private

Read list of GNCs from input file

Definition at line 52 of file GhostNode.f90.

◆ read_dimensions()

procedure, private ghostnodemodule::ghostnodetype::read_dimensions ( class(ghostnodetype) this)
private

Read dimensions (size of gnc list) from input file

Definition at line 51 of file GhostNode.f90.

◆ read_options()

procedure, private ghostnodemodule::ghostnodetype::read_options ( class(ghostnodetype) this)
private

Read options from input file

Definition at line 50 of file GhostNode.f90.

◆ set_names()

procedure numericalpackagemodule::numericalpackagetype::set_names ( class(numericalpackagetype), intent(inout) this,
integer(i4b), intent(in) ibcnum,
character(len=*), intent(in) name_model,
character(len=*), intent(in) pakname,
character(len=*), intent(in) ftype,
character(len=*), intent(in), optional input_mempath )
inherited

Method to assign the filtyp (ftype), the model name, and package name for a package. This method also creates the memoryPath and memoryPathModel that is used by the memory manager when variables are allocated.

Parameters
[in,out]thisNumericalPackageType object
[in]ibcnumunique package number
[in]name_modelname of the model
[in]paknamename of the package
[in]ftypepackage type

Definition at line 53 of file NumericalPackage.f90.

Member Data Documentation

◆ alphasj

real(dp), dimension(:, :), pointer, contiguous ghostnodemodule::ghostnodetype::alphasj => null()

Definition at line 30 of file GhostNode.f90.

◆ cond

real(dp), dimension(:), pointer, contiguous ghostnodemodule::ghostnodetype::cond => null()

Definition at line 27 of file GhostNode.f90.

◆ dis

class(disbasetype), pointer numericalpackagemodule::numericalpackagetype::dis => null()
inherited

Definition at line 50 of file NumericalPackage.f90.

◆ filtyp

character(len=lenftype) numericalpackagemodule::numericalpackagetype::filtyp = ''
inherited

Definition at line 33 of file NumericalPackage.f90.

◆ i2kn

logical, pointer ghostnodemodule::ghostnodetype::i2kn => null()

Definition at line 19 of file GhostNode.f90.

◆ iasym

integer(i4b), pointer numericalpackagemodule::numericalpackagetype::iasym => null()
inherited

Definition at line 41 of file NumericalPackage.f90.

◆ id

integer(i4b), pointer numericalpackagemodule::numericalpackagetype::id => null()
inherited

Definition at line 37 of file NumericalPackage.f90.

◆ idiagm

integer(i4b), dimension(:), pointer, contiguous ghostnodemodule::ghostnodetype::idiagm => null()

Definition at line 32 of file GhostNode.f90.

◆ idiagn

integer(i4b), dimension(:), pointer, contiguous ghostnodemodule::ghostnodetype::idiagn => null()

Definition at line 31 of file GhostNode.f90.

◆ idxglo

integer(i4b), dimension(:), pointer, contiguous ghostnodemodule::ghostnodetype::idxglo => null()

Definition at line 28 of file GhostNode.f90.

◆ idxsymglo

integer(i4b), dimension(:), pointer, contiguous ghostnodemodule::ghostnodetype::idxsymglo => null()

Definition at line 29 of file GhostNode.f90.

◆ implicit

logical, pointer ghostnodemodule::ghostnodetype::implicit => null()

Definition at line 18 of file GhostNode.f90.

◆ inewton

integer(i4b), pointer numericalpackagemodule::numericalpackagetype::inewton => null()
inherited

Definition at line 40 of file NumericalPackage.f90.

◆ input_fname

character(len=linelength), pointer numericalpackagemodule::numericalpackagetype::input_fname => null()
inherited

Definition at line 32 of file NumericalPackage.f90.

◆ input_mempath

character(len=lenmempath) numericalpackagemodule::numericalpackagetype::input_mempath = ''
inherited

Definition at line 31 of file NumericalPackage.f90.

◆ inunit

integer(i4b), pointer numericalpackagemodule::numericalpackagetype::inunit => null()
inherited

Definition at line 38 of file NumericalPackage.f90.

◆ ionper

integer(i4b), pointer numericalpackagemodule::numericalpackagetype::ionper => null()
inherited

Definition at line 45 of file NumericalPackage.f90.

◆ iout

integer(i4b), pointer numericalpackagemodule::numericalpackagetype::iout => null()
inherited

Definition at line 39 of file NumericalPackage.f90.

◆ ipakcb

integer(i4b), pointer numericalpackagemodule::numericalpackagetype::ipakcb => null()
inherited

Definition at line 44 of file NumericalPackage.f90.

◆ iprflow

integer(i4b), pointer numericalpackagemodule::numericalpackagetype::iprflow => null()
inherited

Definition at line 43 of file NumericalPackage.f90.

◆ iprpak

integer(i4b), pointer numericalpackagemodule::numericalpackagetype::iprpak => null()
inherited

Definition at line 42 of file NumericalPackage.f90.

◆ jposinrowm

integer(i4b), dimension(:, :), pointer, contiguous ghostnodemodule::ghostnodetype::jposinrowm => null()

Definition at line 34 of file GhostNode.f90.

◆ jposinrown

integer(i4b), dimension(:, :), pointer, contiguous ghostnodemodule::ghostnodetype::jposinrown => null()

Definition at line 33 of file GhostNode.f90.

◆ lastonper

integer(i4b), pointer numericalpackagemodule::numericalpackagetype::lastonper => null()
inherited

Definition at line 46 of file NumericalPackage.f90.

◆ m1

class(numericalmodeltype), pointer ghostnodemodule::ghostnodetype::m1 => null()

Definition at line 22 of file GhostNode.f90.

◆ m2

class(numericalmodeltype), pointer ghostnodemodule::ghostnodetype::m2 => null()

Definition at line 23 of file GhostNode.f90.

◆ memorypath

character(len=lenmempath) numericalpackagemodule::numericalpackagetype::memorypath = ''
inherited

Definition at line 28 of file NumericalPackage.f90.

◆ memorypathmodel

character(len=lenmempath) numericalpackagemodule::numericalpackagetype::memorypathmodel = ''
inherited

Definition at line 29 of file NumericalPackage.f90.

◆ name_model

character(len=lenmodelname) numericalpackagemodule::numericalpackagetype::name_model = ''
inherited

Definition at line 26 of file NumericalPackage.f90.

◆ nexg

integer(i4b), pointer ghostnodemodule::ghostnodetype::nexg => null()

Definition at line 20 of file GhostNode.f90.

◆ nodem1

integer(i4b), dimension(:), pointer, contiguous ghostnodemodule::ghostnodetype::nodem1 => null()

Definition at line 24 of file GhostNode.f90.

◆ nodem2

integer(i4b), dimension(:), pointer, contiguous ghostnodemodule::ghostnodetype::nodem2 => null()

Definition at line 25 of file GhostNode.f90.

◆ nodesj

integer(i4b), dimension(:, :), pointer, contiguous ghostnodemodule::ghostnodetype::nodesj => null()

Definition at line 26 of file GhostNode.f90.

◆ numjs

integer(i4b), pointer ghostnodemodule::ghostnodetype::numjs => null()

Definition at line 21 of file GhostNode.f90.

◆ package_type

character(len=lenftype), pointer numericalpackagemodule::numericalpackagetype::package_type => null()
inherited

Definition at line 34 of file NumericalPackage.f90.

◆ packname

character(len=lenpackagename) numericalpackagemodule::numericalpackagetype::packname = ''
inherited

Definition at line 27 of file NumericalPackage.f90.

◆ parser

type(blockparsertype) numericalpackagemodule::numericalpackagetype::parser
inherited

Definition at line 49 of file NumericalPackage.f90.

49 type(BlockParserType) :: parser !< parser object for reading blocks of information

◆ smgnc

logical, pointer ghostnodemodule::ghostnodetype::smgnc => null()

Definition at line 17 of file GhostNode.f90.


The documentation for this type was generated from the following file: