MODFLOW 6 version 6.9.0.dev0
USGS Modular Hydrologic Model
Loading...
Searching...
No Matches
tvbasemodule::tvbasetype Type Referenceabstract
Inheritance diagram for tvbasemodule::tvbasetype:
Inheritance graph
Collaboration diagram for tvbasemodule::tvbasetype:
Collaboration graph

Public Member Functions

procedure init (this, name_model, pakname, ftype, mempath, inunit, iout)
 Initialize the TvBaseType object.
procedure ar (this, dis)
 Allocate and read static data for the package.
procedure rp (this)
 Read and prepare stress period data for the package.
procedure ad (this)
 Apply advanced values at each time step.
procedure da (this)
 Deallocate package memory.
procedure(ar_set_pointers), deferred ar_set_pointers (this)
procedure source_options (this)
 Source common options from the input memory path.
procedure source_package_options (this)
 Source package-specific options from the input memory path.
procedure(apply_row_changes), deferred apply_row_changes (this, nodeu, node)
procedure(set_changed_at), deferred set_changed_at (this, kper, kstp)
procedure(reset_change_flags), deferred reset_change_flags (this)
procedure(validate_change), deferred validate_change (this, n, varname)
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(lgp) ts_active = .false.
 is timeseries active in package
integer(i4b), dimension(:, :), pointer, contiguous cellid => null()
 input cellids of time varying value
type(stlvecint) tracked_nodeu
 unreduced node numbers ever set, in first-set order, no duplicates
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 tvbase_allocate_scalars (this)
 Allocate scalar variables.
procedure, private sync_node_changes (this)
 Sync every tracked node's current input value into the model property array(s) it belongs to (e.g. NPF's K11).
procedure, private cellid_to_nodeu (this, n)
 Return the unreduced node number for CELLID row n.

Detailed Description

Definition at line 27 of file TvBase.f90.

Member Function/Subroutine Documentation

◆ ad()

procedure tvbasemodule::tvbasetype::ad ( class(tvbasetype) this)

Definition at line 35 of file TvBase.f90.

◆ allocate_scalars()

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.

◆ apply_row_changes()

procedure(apply_row_changes), deferred tvbasemodule::tvbasetype::apply_row_changes ( class(tvbasetype) this,
integer(i4b), intent(in) nodeu,
integer(i4b), intent(in) node )
pure virtual
Parameters
[in]nodeuunreduced node number, indexes the permanent input arrays
[in]nodereduced node number; may be invalid, see above

Definition at line 43 of file TvBase.f90.

◆ ar()

procedure tvbasemodule::tvbasetype::ar ( class(tvbasetype) this,
class(disbasetype), intent(in), pointer dis )

Definition at line 33 of file TvBase.f90.

◆ ar_set_pointers()

procedure(ar_set_pointers), deferred tvbasemodule::tvbasetype::ar_set_pointers ( class(tvbasetype) this)
pure virtual

Definition at line 40 of file TvBase.f90.

◆ cellid_to_nodeu()

procedure, private tvbasemodule::tvbasetype::cellid_to_nodeu ( class(tvbasetype) this,
integer(i4b), intent(in) n )
private
Parameters
[in]nrow index in the period-data arrays

Definition at line 39 of file TvBase.f90.

◆ da() [1/2]

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.

◆ da() [2/2]

procedure tvbasemodule::tvbasetype::da ( class(tvbasetype) this)

Deallocate package scalars and arrays.

Definition at line 36 of file TvBase.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.

◆ init()

procedure tvbasemodule::tvbasetype::init ( class(tvbasetype) this,
character(len=*), intent(in) name_model,
character(len=*), intent(in) pakname,
character(len=*), intent(in) ftype,
character(len=*), intent(in) mempath,
integer(i4b), intent(in) inunit,
integer(i4b), intent(in) iout )

Allocate and initialize data members of the object.

Definition at line 32 of file TvBase.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.

◆ reset_change_flags()

procedure(reset_change_flags), deferred tvbasemodule::tvbasetype::reset_change_flags ( class(tvbasetype) this)
pure virtual

Definition at line 45 of file TvBase.f90.

◆ rp()

procedure tvbasemodule::tvbasetype::rp ( class(tvbasetype) this)

Definition at line 34 of file TvBase.f90.

◆ set_changed_at()

procedure(set_changed_at), deferred tvbasemodule::tvbasetype::set_changed_at ( class(tvbasetype) this,
integer(i4b), intent(in) kper,
integer(i4b), intent(in) kstp )
pure virtual

Definition at line 44 of file TvBase.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.

◆ source_options()

procedure tvbasemodule::tvbasetype::source_options ( class(tvbasetype) this)

Source common options and call derived package routine to source and log any package-specific options within the same block.

Definition at line 41 of file TvBase.f90.

◆ source_package_options()

procedure tvbasemodule::tvbasetype::source_package_options ( class(tvbasetype) this)

Override in derived package to source and log package-specific options. Default implementation is a no-op.

Definition at line 42 of file TvBase.f90.

◆ sync_node_changes()

procedure, private tvbasemodule::tvbasetype::sync_node_changes ( class(tvbasetype) this)
private

Definition at line 38 of file TvBase.f90.

◆ tvbase_allocate_scalars()

procedure, private tvbasemodule::tvbasetype::tvbase_allocate_scalars ( class(tvbasetype) this)
private

Allocate scalar data members of the object.

Definition at line 37 of file TvBase.f90.

◆ validate_change()

procedure(validate_change), deferred tvbasemodule::tvbasetype::validate_change ( class(tvbasetype) this,
integer(i4b), intent(in) n,
character(len=*), intent(in) varname )
pure virtual

Definition at line 46 of file TvBase.f90.

Member Data Documentation

◆ cellid

integer(i4b), dimension(:, :), pointer, contiguous tvbasemodule::tvbasetype::cellid => null()

Definition at line 29 of file TvBase.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.

◆ 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.

◆ 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.

◆ lastonper

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

Definition at line 46 of file NumericalPackage.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.

◆ 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

◆ tracked_nodeu

type(stlvecint) tvbasemodule::tvbasetype::tracked_nodeu

Definition at line 30 of file TvBase.f90.

30 type(STLVecInt) :: tracked_nodeu !< unreduced node numbers ever set, in first-set order, no duplicates

◆ ts_active

logical(lgp) tvbasemodule::tvbasetype::ts_active = .false.

Definition at line 28 of file TvBase.f90.


The documentation for this type was generated from the following file:
  • /home/runner/work/modflow6/modflow6/src/Model/GroundWaterFlow/TvBase.f90