MODFLOW 6  version 6.5.0.dev2
MODFLOW 6 Code Documentation
gwtmstmodule::gwtmsttype Type Reference

@ brief Mobile storage and transfer More...

Inheritance diagram for gwtmstmodule::gwtmsttype:
Inheritance graph
Collaboration diagram for gwtmstmodule::gwtmsttype:
Collaboration graph

Public Member Functions

procedure mst_ar
 
procedure mst_fc
 
procedure mst_fc_sto
 
procedure mst_fc_dcy
 
procedure mst_fc_srb
 
procedure mst_fc_dcy_srb
 
procedure mst_cq
 
procedure mst_cq_sto
 
procedure mst_cq_dcy
 
procedure mst_cq_srb
 
procedure mst_cq_dcy_srb
 
procedure mst_bd
 
procedure mst_ot_flow
 
procedure mst_da
 
procedure allocate_scalars
 
procedure addto_volfracim
 
procedure get_volfracm
 

Public Attributes

real(dp), dimension(:), pointer, contiguous porosity => null()
 mobile porosity defined as volume mobile voids per volume of mobile domain More...
 
real(dp), dimension(:), pointer, contiguous thetam => null()
 mobile porosity defined as volume mobile voids per volume of aquifer More...
 
real(dp), dimension(:), pointer, contiguous volfracim => null()
 sum of all immobile domain volume fractions More...
 
real(dp), dimension(:), pointer, contiguous ratesto => null()
 rate of mobile storage More...
 
integer(i4b), pointer idcy => null()
 order of decay rate (0:none, 1:first, 2:zero) More...
 
real(dp), dimension(:), pointer, contiguous decay => null()
 first or zero order decay rate (aqueous) More...
 
real(dp), dimension(:), pointer, contiguous decay_sorbed => null()
 first or zero order decay rate (sorbed) More...
 
real(dp), dimension(:), pointer, contiguous ratedcy => null()
 rate of decay More...
 
real(dp), dimension(:), pointer, contiguous decaylast => null()
 decay rate used for last iteration (needed for zero order decay) More...
 
real(dp), dimension(:), pointer, contiguous decayslast => null()
 sorbed decay rate used for last iteration (needed for zero order decay) More...
 
integer(i4b), pointer isrb => null()
 sorption active flag (0:off, 1:linear, 2:freundlich, 3:langmuir) More...
 
real(dp), dimension(:), pointer, contiguous bulk_density => null()
 bulk density of mobile domain; mass of mobile domain solid per aquifer volume More...
 
real(dp), dimension(:), pointer, contiguous distcoef => null()
 kd distribution coefficient More...
 
real(dp), dimension(:), pointer, contiguous sp2 => null()
 second sorption parameter More...
 
real(dp), dimension(:), pointer, contiguous ratesrb => null()
 rate of sorption More...
 
real(dp), dimension(:), pointer, contiguous ratedcys => null()
 rate of sorbed mass decay More...
 
integer(i4b), dimension(:), pointer, contiguous ibound => null()
 pointer to model ibound More...
 
type(tspfmitype), pointer fmi => null()
 pointer to fmi object More...
 

Private Member Functions

procedure, private allocate_arrays
 
procedure, private read_options
 
procedure, private read_data
 
procedure set_names
 
procedure da
 
procedure read_check_ionper
 
procedure get_block_data
 

Private Attributes

character(len=lenmodelname) name_model = ''
 the name of the model that contains this package More...
 
character(len=lenpackagename) packname = ''
 name of the package More...
 
character(len=lenmempath) memorypath = ''
 the location in the memory manager where the variables are stored More...
 
character(len=lenmempath) memorypathmodel = ''
 the location in the memory manager where the variables of the parent model are stored More...
 
character(len=lenmempath) input_mempath = ''
 input context mempath More...
 
character(len=linelength), pointer input_fname => null()
 input file name More...
 
character(len=lenftype) filtyp = ''
 file type (CHD, DRN, RIV, etc.) More...
 
character(len=lenftype), pointer package_type => null()
 package type (same as filtyp) stored in memory manager More...
 
integer(i4b), pointer id => null()
 consecutive package number in model More...
 
integer(i4b), pointer inunit => null()
 unit number for input file More...
 
integer(i4b), pointer iout => null()
 unit number for writing package output More...
 
integer(i4b), pointer inewton => null()
 newton flag More...
 
integer(i4b), pointer iasym => null()
 package causes matrix asymmetry More...
 
integer(i4b), pointer iprpak => null()
 integer flag to echo input More...
 
integer(i4b), pointer iprflow => null()
 flag to print simulated flows More...
 
integer(i4b), pointer ipakcb => null()
 output flows (-1, 0, 1) - save_flows More...
 
integer(i4b), pointer ionper => null()
 stress period for next data More...
 
integer(i4b), pointer lastonper => null()
 last value of ionper (for checking) More...
 
type(blockparsertype) parser
 parser object for reading blocks of information More...
 
class(disbasetype), pointer dis => null()
 model discretization object More...
 

Detailed Description

Data and methods for handling changes in solute storage, decay of dissolved solute mass, sorption, and decay of sorbed mass.

Definition at line 37 of file gwt-mst.f90.

Member Function/Subroutine Documentation

◆ addto_volfracim()

procedure gwtmstmodule::gwtmsttype::addto_volfracim

Definition at line 82 of file gwt-mst.f90.

◆ allocate_arrays()

procedure, private gwtmstmodule::gwtmsttype::allocate_arrays
private

Definition at line 84 of file gwt-mst.f90.

◆ allocate_scalars()

procedure gwtmstmodule::gwtmsttype::allocate_scalars

Definition at line 81 of file gwt-mst.f90.

◆ da()

procedure numericalpackagemodule::numericalpackagetype::da
privateinherited

Definition at line 55 of file NumericalPackage.f90.

◆ get_block_data()

procedure numericalpackagemodule::numericalpackagetype::get_block_data
privateinherited

Definition at line 57 of file NumericalPackage.f90.

◆ get_volfracm()

procedure gwtmstmodule::gwtmsttype::get_volfracm

Definition at line 83 of file gwt-mst.f90.

◆ mst_ar()

procedure gwtmstmodule::gwtmsttype::mst_ar

Definition at line 67 of file gwt-mst.f90.

◆ mst_bd()

procedure gwtmstmodule::gwtmsttype::mst_bd

Definition at line 78 of file gwt-mst.f90.

◆ mst_cq()

procedure gwtmstmodule::gwtmsttype::mst_cq

Definition at line 73 of file gwt-mst.f90.

◆ mst_cq_dcy()

procedure gwtmstmodule::gwtmsttype::mst_cq_dcy

Definition at line 75 of file gwt-mst.f90.

◆ mst_cq_dcy_srb()

procedure gwtmstmodule::gwtmsttype::mst_cq_dcy_srb

Definition at line 77 of file gwt-mst.f90.

◆ mst_cq_srb()

procedure gwtmstmodule::gwtmsttype::mst_cq_srb

Definition at line 76 of file gwt-mst.f90.

◆ mst_cq_sto()

procedure gwtmstmodule::gwtmsttype::mst_cq_sto

Definition at line 74 of file gwt-mst.f90.

◆ mst_da()

procedure gwtmstmodule::gwtmsttype::mst_da

Definition at line 80 of file gwt-mst.f90.

◆ mst_fc()

procedure gwtmstmodule::gwtmsttype::mst_fc

Definition at line 68 of file gwt-mst.f90.

◆ mst_fc_dcy()

procedure gwtmstmodule::gwtmsttype::mst_fc_dcy

Definition at line 70 of file gwt-mst.f90.

◆ mst_fc_dcy_srb()

procedure gwtmstmodule::gwtmsttype::mst_fc_dcy_srb

Definition at line 72 of file gwt-mst.f90.

◆ mst_fc_srb()

procedure gwtmstmodule::gwtmsttype::mst_fc_srb

Definition at line 71 of file gwt-mst.f90.

◆ mst_fc_sto()

procedure gwtmstmodule::gwtmsttype::mst_fc_sto

Definition at line 69 of file gwt-mst.f90.

◆ mst_ot_flow()

procedure gwtmstmodule::gwtmsttype::mst_ot_flow

Definition at line 79 of file gwt-mst.f90.

◆ read_check_ionper()

procedure numericalpackagemodule::numericalpackagetype::read_check_ionper
privateinherited

Definition at line 56 of file NumericalPackage.f90.

◆ read_data()

procedure, private gwtmstmodule::gwtmsttype::read_data
private

Definition at line 86 of file gwt-mst.f90.

◆ read_options()

procedure, private gwtmstmodule::gwtmsttype::read_options
private

Definition at line 85 of file gwt-mst.f90.

◆ set_names()

procedure numericalpackagemodule::numericalpackagetype::set_names
privateinherited

Definition at line 53 of file NumericalPackage.f90.

Member Data Documentation

◆ bulk_density

real(dp), dimension(:), pointer, contiguous gwtmstmodule::gwtmsttype::bulk_density => null()

Definition at line 55 of file gwt-mst.f90.

55  real(DP), dimension(:), pointer, contiguous :: bulk_density => null() !< bulk density of mobile domain; mass of mobile domain solid per aquifer volume

◆ decay

real(dp), dimension(:), pointer, contiguous gwtmstmodule::gwtmsttype::decay => null()

Definition at line 47 of file gwt-mst.f90.

47  real(DP), dimension(:), pointer, contiguous :: decay => null() !< first or zero order decay rate (aqueous)

◆ decay_sorbed

real(dp), dimension(:), pointer, contiguous gwtmstmodule::gwtmsttype::decay_sorbed => null()

Definition at line 48 of file gwt-mst.f90.

48  real(DP), dimension(:), pointer, contiguous :: decay_sorbed => null() !< first or zero order decay rate (sorbed)

◆ decaylast

real(dp), dimension(:), pointer, contiguous gwtmstmodule::gwtmsttype::decaylast => null()

Definition at line 50 of file gwt-mst.f90.

50  real(DP), dimension(:), pointer, contiguous :: decaylast => null() !< decay rate used for last iteration (needed for zero order decay)

◆ decayslast

real(dp), dimension(:), pointer, contiguous gwtmstmodule::gwtmsttype::decayslast => null()

Definition at line 51 of file gwt-mst.f90.

51  real(DP), dimension(:), pointer, contiguous :: decayslast => null() !< sorbed decay rate used for last iteration (needed for zero order decay)

◆ dis

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

Definition at line 50 of file NumericalPackage.f90.

50  class(DisBaseType), pointer :: dis => null() !< model discretization object

◆ distcoef

real(dp), dimension(:), pointer, contiguous gwtmstmodule::gwtmsttype::distcoef => null()

Definition at line 56 of file gwt-mst.f90.

56  real(DP), dimension(:), pointer, contiguous :: distcoef => null() !< kd distribution coefficient

◆ filtyp

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

Definition at line 33 of file NumericalPackage.f90.

33  character(len=LENFTYPE) :: filtyp = '' !< file type (CHD, DRN, RIV, etc.)

◆ fmi

type(tspfmitype), pointer gwtmstmodule::gwtmsttype::fmi => null()

Definition at line 63 of file gwt-mst.f90.

63  type(TspFmiType), pointer :: fmi => null() !< pointer to fmi object

◆ iasym

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

Definition at line 41 of file NumericalPackage.f90.

41  integer(I4B), pointer :: iasym => null() !< package causes matrix asymmetry

◆ ibound

integer(i4b), dimension(:), pointer, contiguous gwtmstmodule::gwtmsttype::ibound => null()

Definition at line 62 of file gwt-mst.f90.

62  integer(I4B), dimension(:), pointer, contiguous :: ibound => null() !< pointer to model ibound

◆ id

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

Definition at line 37 of file NumericalPackage.f90.

37  integer(I4B), pointer :: id => null() !< consecutive package number in model

◆ idcy

integer(i4b), pointer gwtmstmodule::gwtmsttype::idcy => null()

Definition at line 46 of file gwt-mst.f90.

46  integer(I4B), pointer :: idcy => null() !< order of decay rate (0:none, 1:first, 2:zero)

◆ inewton

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

Definition at line 40 of file NumericalPackage.f90.

40  integer(I4B), pointer :: inewton => null() !< newton flag

◆ input_fname

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

Definition at line 32 of file NumericalPackage.f90.

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

◆ input_mempath

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

Definition at line 31 of file NumericalPackage.f90.

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

◆ inunit

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

Definition at line 38 of file NumericalPackage.f90.

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

◆ ionper

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

Definition at line 45 of file NumericalPackage.f90.

45  integer(I4B), pointer :: ionper => null() !< stress period for next data

◆ iout

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

Definition at line 39 of file NumericalPackage.f90.

39  integer(I4B), pointer :: iout => null() !< unit number for writing package output

◆ ipakcb

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

Definition at line 44 of file NumericalPackage.f90.

44  integer(I4B), pointer :: ipakcb => null() !< output flows (-1, 0, 1) - save_flows

◆ iprflow

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

Definition at line 43 of file NumericalPackage.f90.

43  integer(I4B), pointer :: iprflow => null() !< flag to print simulated flows

◆ iprpak

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

Definition at line 42 of file NumericalPackage.f90.

42  integer(I4B), pointer :: iprpak => null() !< integer flag to echo input

◆ isrb

integer(i4b), pointer gwtmstmodule::gwtmsttype::isrb => null()

Definition at line 54 of file gwt-mst.f90.

54  integer(I4B), pointer :: isrb => null() !< sorption active flag (0:off, 1:linear, 2:freundlich, 3:langmuir)

◆ lastonper

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

Definition at line 46 of file NumericalPackage.f90.

46  integer(I4B), pointer :: lastonper => null() !< last value of ionper (for checking)

◆ memorypath

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

Definition at line 28 of file NumericalPackage.f90.

28  character(len=LENMEMPATH) :: memoryPath = '' !< the location in the memory manager where the variables are stored

◆ memorypathmodel

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

Definition at line 29 of file NumericalPackage.f90.

29  character(len=LENMEMPATH) :: memoryPathModel = '' !< the location in the memory manager where the variables

◆ name_model

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

Definition at line 26 of file NumericalPackage.f90.

26  character(len=LENMODELNAME) :: name_model = '' !< the name of the model that contains this package

◆ package_type

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

Definition at line 34 of file NumericalPackage.f90.

34  character(len=LENFTYPE), pointer :: package_type => null() !< package type (same as filtyp) stored in memory manager

◆ packname

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

Definition at line 27 of file NumericalPackage.f90.

27  character(len=LENPACKAGENAME) :: packName = '' !< name of the package

◆ parser

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

Definition at line 49 of file NumericalPackage.f90.

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

◆ porosity

real(dp), dimension(:), pointer, contiguous gwtmstmodule::gwtmsttype::porosity => null()

Definition at line 40 of file gwt-mst.f90.

40  real(DP), dimension(:), pointer, contiguous :: porosity => null() !< mobile porosity defined as volume mobile voids per volume of mobile domain

◆ ratedcy

real(dp), dimension(:), pointer, contiguous gwtmstmodule::gwtmsttype::ratedcy => null()

Definition at line 49 of file gwt-mst.f90.

49  real(DP), dimension(:), pointer, contiguous :: ratedcy => null() !< rate of decay

◆ ratedcys

real(dp), dimension(:), pointer, contiguous gwtmstmodule::gwtmsttype::ratedcys => null()

Definition at line 59 of file gwt-mst.f90.

59  real(DP), dimension(:), pointer, contiguous :: ratedcys => null() !< rate of sorbed mass decay

◆ ratesrb

real(dp), dimension(:), pointer, contiguous gwtmstmodule::gwtmsttype::ratesrb => null()

Definition at line 58 of file gwt-mst.f90.

58  real(DP), dimension(:), pointer, contiguous :: ratesrb => null() !< rate of sorption

◆ ratesto

real(dp), dimension(:), pointer, contiguous gwtmstmodule::gwtmsttype::ratesto => null()

Definition at line 43 of file gwt-mst.f90.

43  real(DP), dimension(:), pointer, contiguous :: ratesto => null() !< rate of mobile storage

◆ sp2

real(dp), dimension(:), pointer, contiguous gwtmstmodule::gwtmsttype::sp2 => null()

Definition at line 57 of file gwt-mst.f90.

57  real(DP), dimension(:), pointer, contiguous :: sp2 => null() !< second sorption parameter

◆ thetam

real(dp), dimension(:), pointer, contiguous gwtmstmodule::gwtmsttype::thetam => null()

Definition at line 41 of file gwt-mst.f90.

41  real(DP), dimension(:), pointer, contiguous :: thetam => null() !< mobile porosity defined as volume mobile voids per volume of aquifer

◆ volfracim

real(dp), dimension(:), pointer, contiguous gwtmstmodule::gwtmsttype::volfracim => null()

Definition at line 42 of file gwt-mst.f90.

42  real(DP), dimension(:), pointer, contiguous :: volfracim => null() !< sum of all immobile domain volume fractions

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