MODFLOW 6 version 6.9.0.dev0
USGS Modular Hydrologic Model
Loading...
Searching...
No Matches
Inheritance diagram for tspadvmodule::tspadvtype:
Inheritance graph
Collaboration diagram for tspadvmodule::tspadvtype:
Collaboration graph

Public Member Functions

procedure adv_df (this, adv_options)
 Define ADV object.
procedure adv_ar (this, dis, ibound)
 Allocate and read method for package.
procedure adv_dt (this, dtmax, msg, thetam)
 Calculate maximum time step length.
procedure adv_fc (this, nodes, matrix_sln, idxglo, cnew, rhs)
 Fill coefficient method for ADV package.
procedure adv_cq (this, cnew, flowja)
 Calculate advection contribution to flowja.
procedure adv_da (this)
 Deallocate memory.
procedure allocate_scalars (this)
 Allocate scalars specific to the streamflow energy transport (SFE) package.
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

integer(i4b), pointer iadvwt => null()
 advection scheme. See ADV_SCHEME_* constants
real(dp), pointer ats_percel => null()
 user-specified fractional number of cells advection can move a particle during one time step
integer(i4b), dimension(:), pointer, contiguous ibound => null()
 pointer to model ibound
type(tspfmitype), pointer fmi => null()
 pointer to fmi object
real(dp), pointer eqnsclfac => null()
 governing equation scale factor; =1. for solute; =rhow*cpw for energy
class(interpolationschemeinterface), allocatable face_interpolation
 interpolation scheme for face values
class(igradienttype), allocatable gradient
 cell centered gradient
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 source_options (this)
 Source input options.

Detailed Description

Definition at line 28 of file tsp-adv.f90.

Member Function/Subroutine Documentation

◆ adv_ar()

procedure tspadvmodule::tspadvtype::adv_ar ( class(tspadvtype) this,
class(disbasetype), intent(in), pointer dis,
integer(i4b), dimension(:), intent(in), pointer, contiguous ibound )

Method to allocate and read static data for the ADV package.

Definition at line 40 of file tsp-adv.f90.

◆ adv_cq()

procedure tspadvmodule::tspadvtype::adv_cq ( class(tspadvtype) this,
real(dp), dimension(:), intent(in), target cnew,
real(dp), dimension(:), intent(inout) flowja )

Definition at line 43 of file tsp-adv.f90.

◆ adv_da()

procedure tspadvmodule::tspadvtype::adv_da ( class(tspadvtype) this)

Definition at line 44 of file tsp-adv.f90.

◆ adv_df()

procedure tspadvmodule::tspadvtype::adv_df ( class(tspadvtype) this,
type(tspadvoptionstype), intent(in), optional adv_options )

Define the ADV package

Parameters
[in]adv_optionsthe optional options, for when not constructing from file

Definition at line 39 of file tsp-adv.f90.

◆ adv_dt()

procedure tspadvmodule::tspadvtype::adv_dt ( class(tspadvtype) this,
real(dp), intent(out) dtmax,
character(len=*), intent(inout) msg,
real(dp), dimension(:), intent(in) thetam )

Return the largest time step that meets stability constraints

Parameters
thisthis instance
[out]dtmaxmaximum allowable dt subject to stability constraint
[in,out]msgpackage/cell dt constraint message
[in]thetamporosity

Definition at line 41 of file tsp-adv.f90.

◆ adv_fc()

procedure tspadvmodule::tspadvtype::adv_fc ( class(tspadvtype) this,
integer(i4b), intent(in) nodes,
class(matrixbasetype), pointer matrix_sln,
integer(i4b), dimension(:), intent(in) idxglo,
real(dp), dimension(:), intent(in), target cnew,
real(dp), dimension(:), intent(inout) rhs )

Method to calculate coefficients and fill amat and rhs.

Parameters
thisthis instance
[in]nodesnumber of nodes
matrix_slnpointer to solution matrix
[in]idxgloglobal indices for matrix
[in]cnewnew concentration/temperature values
[in,out]rhsright-hand side vector

Definition at line 42 of file tsp-adv.f90.

◆ allocate_scalars() [1/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.

◆ allocate_scalars() [2/2]

procedure tspadvmodule::tspadvtype::allocate_scalars ( class(tspadvtype) this)

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

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

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

◆ 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, private tspadvmodule::tspadvtype::source_options ( class(tspadvtype) this)
private

Definition at line 47 of file tsp-adv.f90.

Member Data Documentation

◆ ats_percel

real(dp), pointer tspadvmodule::tspadvtype::ats_percel => null()

Definition at line 30 of file tsp-adv.f90.

◆ dis

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

Definition at line 50 of file NumericalPackage.f90.

◆ eqnsclfac

real(dp), pointer tspadvmodule::tspadvtype::eqnsclfac => null()

Definition at line 33 of file tsp-adv.f90.

◆ face_interpolation

class(interpolationschemeinterface), allocatable tspadvmodule::tspadvtype::face_interpolation

Definition at line 35 of file tsp-adv.f90.

35 class(InterpolationSchemeInterface), allocatable :: face_interpolation !< interpolation scheme for face values

◆ filtyp

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

Definition at line 33 of file NumericalPackage.f90.

◆ fmi

type(tspfmitype), pointer tspadvmodule::tspadvtype::fmi => null()

Definition at line 32 of file tsp-adv.f90.

◆ gradient

class(igradienttype), allocatable tspadvmodule::tspadvtype::gradient

Definition at line 36 of file tsp-adv.f90.

36 class(IGradientType), allocatable :: gradient !< cell centered gradient

◆ iadvwt

integer(i4b), pointer tspadvmodule::tspadvtype::iadvwt => null()

Definition at line 29 of file tsp-adv.f90.

◆ iasym

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

Definition at line 41 of file NumericalPackage.f90.

◆ ibound

integer(i4b), dimension(:), pointer, contiguous tspadvmodule::tspadvtype::ibound => null()

Definition at line 31 of file tsp-adv.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

The documentation for this type was generated from the following file:
  • /home/runner/work/modflow6/modflow6/src/Model/TransportModel/tsp-adv.f90