MODFLOW 6  version 6.7.0.dev0
USGS Modular Hydrologic Model
prtmodule::prtmodeltype Type Reference

Particle tracking (PRT) model. More...

Inheritance diagram for prtmodule::prtmodeltype:
Inheritance graph
Collaboration diagram for prtmodule::prtmodeltype:
Collaboration graph

Private Member Functions

procedure model_df => prt_df
 
procedure model_ar => prt_ar
 
procedure model_rp => prt_rp
 
procedure model_ad => prt_ad
 
procedure model_cq => prt_cq
 
procedure model_bd => prt_bd
 
procedure model_ot => prt_ot
 
procedure model_da => prt_da
 
procedure model_solve => prt_solve
 
procedure allocate_scalars
 
procedure allocate_arrays
 
procedure, private package_create
 
procedure, private ftype_check
 
procedure, private prt_ot_flow
 
procedure, private prt_ot_saveflow
 
procedure, private prt_ot_printflow
 
procedure, private prt_ot_dv
 
procedure, private prt_ot_bdsummary
 
procedure, private prt_cq_sto
 
procedure, private create_packages
 
procedure, private create_bndpkgs
 
procedure, private log_namfile_options
 
procedure model_fp
 
procedure model_ac
 
procedure model_mc
 
procedure model_reset
 
procedure model_cf
 
procedure model_fc
 
procedure model_ptcchk
 
procedure model_ptc
 
procedure model_nr
 
procedure model_cc
 
procedure model_nur
 
procedure model_bdcalc
 
procedure model_bdsave
 
procedure model_bdentry
 
procedure set_moffset
 
procedure set_idsoln
 
procedure set_xptr
 
procedure set_rhsptr
 
procedure set_iboundptr
 
procedure get_mrange
 
procedure get_mcellid
 
procedure get_mnodeu
 
procedure get_iasym
 
procedure create_lstfile
 
procedure model_dt
 
procedure model_message
 

Private Attributes

type(prtfmitype), pointer fmi => null()
 
type(prtmiptype), pointer mip => null()
 
type(prtoctype), pointer oc => null()
 
type(budgettype), pointer budget => null()
 
class(methodtype), pointer method => null()
 
type(trackcontroltype), pointer trackctl
 
integer(i4b), pointer infmi => null()
 
integer(i4b), pointer inmip => null()
 
integer(i4b), pointer inmvt => null()
 
integer(i4b), pointer inmst => null()
 
integer(i4b), pointer inadv => null()
 
integer(i4b), pointer indsp => null()
 
integer(i4b), pointer inssm => null()
 
integer(i4b), pointer inoc => null()
 
integer(i4b), pointer nprp => null()
 
real(dp), dimension(:), pointer, contiguous masssto => null()
 particle mass storage in cells, new value More...
 
real(dp), dimension(:), pointer, contiguous massstoold => null()
 particle mass storage in cells, old value More...
 
real(dp), dimension(:), pointer, contiguous ratesto => null()
 particle mass storage rate in cells More...
 
character(len=linelength), pointer filename => null()
 
integer(i4b), pointer neq => null()
 
integer(i4b), pointer nja => null()
 
integer(i4b), pointer moffset => null()
 
integer(i4b), pointer icnvg => null()
 
integer(i4b), dimension(:), pointer, contiguous ia => null()
 
integer(i4b), dimension(:), pointer, contiguous ja => null()
 
real(dp), dimension(:), pointer, contiguous x => null()
 
real(dp), dimension(:), pointer, contiguous rhs => null()
 
real(dp), dimension(:), pointer, contiguous cond => null()
 
integer(i4b), dimension(:), pointer, contiguous idxglo => null()
 
real(dp), dimension(:), pointer, contiguous xold => null()
 
real(dp), dimension(:), pointer, contiguous flowja => null()
 
integer(i4b), dimension(:), pointer, contiguous ibound => null()
 
type(listtype), pointer bndlist => null()
 
class(disbasetype), pointer dis => null()
 
character(len=lenmempath) memorypath
 the location in the memory manager where the variables are stored More...
 
character(len=lenmodelname), pointer name => null()
 name of the model More...
 
character(len=3), pointer macronym => null()
 3 letter model acronym (GWF, GWT, ...) More...
 
integer(i4b), pointer idsoln => null()
 id of the solution model is in More...
 
integer(i4b), pointer id => null()
 model id More...
 
integer(i4b), pointer iout => null()
 output unit number More...
 
integer(i4b), pointer inewton => null()
 newton-raphson flag 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()
 save_flows flag More...
 

Detailed Description

Definition at line 41 of file prt.f90.

Member Function/Subroutine Documentation

◆ allocate_arrays()

procedure prtmodule::prtmodeltype::allocate_arrays
private

Definition at line 74 of file prt.f90.

◆ allocate_scalars()

procedure prtmodule::prtmodeltype::allocate_scalars
private

Definition at line 73 of file prt.f90.

◆ create_bndpkgs()

procedure, private prtmodule::prtmodeltype::create_bndpkgs
private

Definition at line 84 of file prt.f90.

◆ create_lstfile()

procedure numericalmodelmodule::numericalmodeltype::create_lstfile
privateinherited

Definition at line 80 of file NumericalModel.f90.

◆ create_packages()

procedure, private prtmodule::prtmodeltype::create_packages
private

Definition at line 83 of file prt.f90.

◆ ftype_check()

procedure, private prtmodule::prtmodeltype::ftype_check
private

Definition at line 76 of file prt.f90.

◆ get_iasym()

procedure numericalmodelmodule::numericalmodeltype::get_iasym
privateinherited

Definition at line 79 of file NumericalModel.f90.

◆ get_mcellid()

procedure numericalmodelmodule::numericalmodeltype::get_mcellid
privateinherited

Definition at line 77 of file NumericalModel.f90.

◆ get_mnodeu()

procedure numericalmodelmodule::numericalmodeltype::get_mnodeu
privateinherited

Definition at line 78 of file NumericalModel.f90.

◆ get_mrange()

procedure numericalmodelmodule::numericalmodeltype::get_mrange
privateinherited

Definition at line 76 of file NumericalModel.f90.

◆ log_namfile_options()

procedure, private prtmodule::prtmodeltype::log_namfile_options
private

Definition at line 85 of file prt.f90.

◆ model_ac()

procedure numericalmodelmodule::numericalmodeltype::model_ac
privateinherited

Definition at line 48 of file NumericalModel.f90.

◆ model_ad()

procedure prtmodule::prtmodeltype::model_ad
private

Definition at line 65 of file prt.f90.

◆ model_ar()

procedure prtmodule::prtmodeltype::model_ar
private

Definition at line 63 of file prt.f90.

◆ model_bd()

procedure prtmodule::prtmodeltype::model_bd
private

Definition at line 67 of file prt.f90.

◆ model_bdcalc()

procedure numericalmodelmodule::numericalmodeltype::model_bdcalc
privateinherited

Definition at line 63 of file NumericalModel.f90.

◆ model_bdentry()

procedure numericalmodelmodule::numericalmodeltype::model_bdentry
privateinherited

Definition at line 66 of file NumericalModel.f90.

◆ model_bdsave()

procedure numericalmodelmodule::numericalmodeltype::model_bdsave
privateinherited

Definition at line 64 of file NumericalModel.f90.

◆ model_cc()

procedure numericalmodelmodule::numericalmodeltype::model_cc
privateinherited

Definition at line 59 of file NumericalModel.f90.

◆ model_cf()

procedure numericalmodelmodule::numericalmodeltype::model_cf
privateinherited

Definition at line 54 of file NumericalModel.f90.

◆ model_cq()

procedure prtmodule::prtmodeltype::model_cq
private

Definition at line 66 of file prt.f90.

◆ model_da()

procedure prtmodule::prtmodeltype::model_da
private

Definition at line 69 of file prt.f90.

◆ model_df()

procedure prtmodule::prtmodeltype::model_df
private

Definition at line 62 of file prt.f90.

◆ model_dt()

procedure basemodelmodule::basemodeltype::model_dt
privateinherited

Definition at line 28 of file BaseModel.f90.

◆ model_fc()

procedure numericalmodelmodule::numericalmodeltype::model_fc
privateinherited

Definition at line 55 of file NumericalModel.f90.

◆ model_fp()

procedure numericalmodelmodule::numericalmodeltype::model_fp
privateinherited

Definition at line 44 of file NumericalModel.f90.

◆ model_mc()

procedure numericalmodelmodule::numericalmodeltype::model_mc
privateinherited

Definition at line 49 of file NumericalModel.f90.

◆ model_message()

procedure basemodelmodule::basemodeltype::model_message
privateinherited

Definition at line 33 of file BaseModel.f90.

◆ model_nr()

procedure numericalmodelmodule::numericalmodeltype::model_nr
privateinherited

Definition at line 58 of file NumericalModel.f90.

◆ model_nur()

procedure numericalmodelmodule::numericalmodeltype::model_nur
privateinherited

Definition at line 60 of file NumericalModel.f90.

◆ model_ot()

procedure prtmodule::prtmodeltype::model_ot
private

Definition at line 68 of file prt.f90.

◆ model_ptc()

procedure numericalmodelmodule::numericalmodeltype::model_ptc
privateinherited

Definition at line 57 of file NumericalModel.f90.

◆ model_ptcchk()

procedure numericalmodelmodule::numericalmodeltype::model_ptcchk
privateinherited

Definition at line 56 of file NumericalModel.f90.

◆ model_reset()

procedure numericalmodelmodule::numericalmodeltype::model_reset
privateinherited

Definition at line 52 of file NumericalModel.f90.

◆ model_rp()

procedure prtmodule::prtmodeltype::model_rp
private

Definition at line 64 of file prt.f90.

◆ model_solve()

procedure prtmodule::prtmodeltype::model_solve
private

Definition at line 70 of file prt.f90.

◆ package_create()

procedure, private prtmodule::prtmodeltype::package_create
private

Definition at line 75 of file prt.f90.

◆ prt_cq_sto()

procedure, private prtmodule::prtmodeltype::prt_cq_sto
private

Definition at line 82 of file prt.f90.

◆ prt_ot_bdsummary()

procedure, private prtmodule::prtmodeltype::prt_ot_bdsummary
private

Definition at line 81 of file prt.f90.

◆ prt_ot_dv()

procedure, private prtmodule::prtmodeltype::prt_ot_dv
private

Definition at line 80 of file prt.f90.

◆ prt_ot_flow()

procedure, private prtmodule::prtmodeltype::prt_ot_flow
private

Definition at line 77 of file prt.f90.

◆ prt_ot_printflow()

procedure, private prtmodule::prtmodeltype::prt_ot_printflow
private

Definition at line 79 of file prt.f90.

◆ prt_ot_saveflow()

procedure, private prtmodule::prtmodeltype::prt_ot_saveflow
private

Definition at line 78 of file prt.f90.

◆ set_iboundptr()

procedure numericalmodelmodule::numericalmodeltype::set_iboundptr
privateinherited

Definition at line 75 of file NumericalModel.f90.

◆ set_idsoln()

procedure numericalmodelmodule::numericalmodeltype::set_idsoln
privateinherited

Definition at line 72 of file NumericalModel.f90.

◆ set_moffset()

procedure numericalmodelmodule::numericalmodeltype::set_moffset
privateinherited

Definition at line 71 of file NumericalModel.f90.

◆ set_rhsptr()

procedure numericalmodelmodule::numericalmodeltype::set_rhsptr
privateinherited

Definition at line 74 of file NumericalModel.f90.

◆ set_xptr()

procedure numericalmodelmodule::numericalmodeltype::set_xptr
privateinherited

Definition at line 73 of file NumericalModel.f90.

Member Data Documentation

◆ bndlist

type(listtype), pointer numericalmodelmodule::numericalmodeltype::bndlist => null()
privateinherited

Definition at line 36 of file NumericalModel.f90.

36  type(ListType), pointer :: bndlist => null() !array of boundary packages for this model

◆ budget

type(budgettype), pointer prtmodule::prtmodeltype::budget => null()
private

Definition at line 45 of file prt.f90.

45  type(BudgetType), pointer :: budget => null() ! budget object

◆ cond

real(dp), dimension(:), pointer, contiguous numericalmodelmodule::numericalmodeltype::cond => null()
privateinherited

Definition at line 29 of file NumericalModel.f90.

29  real(DP), dimension(:), pointer, contiguous :: cond => null() !conductance matrix

◆ dis

class(disbasetype), pointer numericalmodelmodule::numericalmodeltype::dis => null()
privateinherited

Definition at line 37 of file NumericalModel.f90.

37  class(DisBaseType), pointer :: dis => null() !discretization object

◆ filename

character(len=linelength), pointer numericalmodelmodule::numericalmodeltype::filename => null()
privateinherited

Definition at line 20 of file NumericalModel.f90.

20  character(len=LINELENGTH), pointer :: filename => null() !input file name

◆ flowja

real(dp), dimension(:), pointer, contiguous numericalmodelmodule::numericalmodeltype::flowja => null()
privateinherited

Definition at line 32 of file NumericalModel.f90.

32  real(DP), dimension(:), pointer, contiguous :: flowja => null() !intercell flows

◆ fmi

type(prtfmitype), pointer prtmodule::prtmodeltype::fmi => null()
private

Definition at line 42 of file prt.f90.

42  type(PrtFmiType), pointer :: fmi => null() ! flow model interface

◆ ia

integer(i4b), dimension(:), pointer, contiguous numericalmodelmodule::numericalmodeltype::ia => null()
privateinherited

Definition at line 25 of file NumericalModel.f90.

25  integer(I4B), dimension(:), pointer, contiguous :: ia => null() !csr row pointer

◆ ibound

integer(i4b), dimension(:), pointer, contiguous numericalmodelmodule::numericalmodeltype::ibound => null()
privateinherited

Definition at line 33 of file NumericalModel.f90.

33  integer(I4B), dimension(:), pointer, contiguous :: ibound => null() !ibound array

◆ icnvg

integer(i4b), pointer numericalmodelmodule::numericalmodeltype::icnvg => null()
privateinherited

Definition at line 24 of file NumericalModel.f90.

24  integer(I4B), pointer :: icnvg => null() !convergence flag

◆ id

integer(i4b), pointer basemodelmodule::basemodeltype::id => null()
privateinherited

Definition at line 18 of file BaseModel.f90.

18  integer(I4B), pointer :: id => null() !< model id

◆ idsoln

integer(i4b), pointer basemodelmodule::basemodeltype::idsoln => null()
privateinherited

Definition at line 17 of file BaseModel.f90.

17  integer(I4B), pointer :: idsoln => null() !< id of the solution model is in

◆ idxglo

integer(i4b), dimension(:), pointer, contiguous numericalmodelmodule::numericalmodeltype::idxglo => null()
privateinherited

Definition at line 30 of file NumericalModel.f90.

30  integer(I4B), dimension(:), pointer, contiguous :: idxglo => null() !pointer to position in solution matrix

◆ inadv

integer(i4b), pointer prtmodule::prtmodeltype::inadv => null()
private

Definition at line 52 of file prt.f90.

52  integer(I4B), pointer :: inadv => null() ! unit number ADV

◆ indsp

integer(i4b), pointer prtmodule::prtmodeltype::indsp => null()
private

Definition at line 53 of file prt.f90.

53  integer(I4B), pointer :: indsp => null() ! unit number DSP

◆ inewton

integer(i4b), pointer basemodelmodule::basemodeltype::inewton => null()
privateinherited

Definition at line 20 of file BaseModel.f90.

20  integer(I4B), pointer :: inewton => null() !< newton-raphson flag

◆ infmi

integer(i4b), pointer prtmodule::prtmodeltype::infmi => null()
private

Definition at line 48 of file prt.f90.

48  integer(I4B), pointer :: infmi => null() ! unit number FMI

◆ inmip

integer(i4b), pointer prtmodule::prtmodeltype::inmip => null()
private

Definition at line 49 of file prt.f90.

49  integer(I4B), pointer :: inmip => null() ! unit number MIP

◆ inmst

integer(i4b), pointer prtmodule::prtmodeltype::inmst => null()
private

Definition at line 51 of file prt.f90.

51  integer(I4B), pointer :: inmst => null() ! unit number MST

◆ inmvt

integer(i4b), pointer prtmodule::prtmodeltype::inmvt => null()
private

Definition at line 50 of file prt.f90.

50  integer(I4B), pointer :: inmvt => null() ! unit number MVT

◆ inoc

integer(i4b), pointer prtmodule::prtmodeltype::inoc => null()
private

Definition at line 55 of file prt.f90.

55  integer(I4B), pointer :: inoc => null() ! unit number OC

◆ inssm

integer(i4b), pointer prtmodule::prtmodeltype::inssm => null()
private

Definition at line 54 of file prt.f90.

54  integer(I4B), pointer :: inssm => null() ! unit number SSM

◆ iout

integer(i4b), pointer basemodelmodule::basemodeltype::iout => null()
privateinherited

Definition at line 19 of file BaseModel.f90.

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

◆ ipakcb

integer(i4b), pointer basemodelmodule::basemodeltype::ipakcb => null()
privateinherited

Definition at line 23 of file BaseModel.f90.

23  integer(I4B), pointer :: ipakcb => null() !< save_flows flag

◆ iprflow

integer(i4b), pointer basemodelmodule::basemodeltype::iprflow => null()
privateinherited

Definition at line 22 of file BaseModel.f90.

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

◆ iprpak

integer(i4b), pointer basemodelmodule::basemodeltype::iprpak => null()
privateinherited

Definition at line 21 of file BaseModel.f90.

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

◆ ja

integer(i4b), dimension(:), pointer, contiguous numericalmodelmodule::numericalmodeltype::ja => null()
privateinherited

Definition at line 26 of file NumericalModel.f90.

26  integer(I4B), dimension(:), pointer, contiguous :: ja => null() !csr columns

◆ macronym

character(len=3), pointer basemodelmodule::basemodeltype::macronym => null()
privateinherited

Definition at line 16 of file BaseModel.f90.

16  character(len=3), pointer :: macronym => null() !< 3 letter model acronym (GWF, GWT, ...)

◆ masssto

real(dp), dimension(:), pointer, contiguous prtmodule::prtmodeltype::masssto => null()
private

Definition at line 57 of file prt.f90.

57  real(DP), dimension(:), pointer, contiguous :: masssto => null() !< particle mass storage in cells, new value

◆ massstoold

real(dp), dimension(:), pointer, contiguous prtmodule::prtmodeltype::massstoold => null()
private

Definition at line 58 of file prt.f90.

58  real(DP), dimension(:), pointer, contiguous :: massstoold => null() !< particle mass storage in cells, old value

◆ memorypath

character(len=lenmempath) basemodelmodule::basemodeltype::memorypath
privateinherited

Definition at line 14 of file BaseModel.f90.

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

◆ method

class(methodtype), pointer prtmodule::prtmodeltype::method => null()
private

Definition at line 46 of file prt.f90.

46  class(MethodType), pointer :: method => null() ! tracking method

◆ mip

type(prtmiptype), pointer prtmodule::prtmodeltype::mip => null()
private

Definition at line 43 of file prt.f90.

43  type(PrtMipType), pointer :: mip => null() ! model input package

◆ moffset

integer(i4b), pointer numericalmodelmodule::numericalmodeltype::moffset => null()
privateinherited

Definition at line 23 of file NumericalModel.f90.

23  integer(I4B), pointer :: moffset => null() !offset of this model in the solution

◆ name

character(len=lenmodelname), pointer basemodelmodule::basemodeltype::name => null()
privateinherited

Definition at line 15 of file BaseModel.f90.

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

◆ neq

integer(i4b), pointer numericalmodelmodule::numericalmodeltype::neq => null()
privateinherited

Definition at line 21 of file NumericalModel.f90.

21  integer(I4B), pointer :: neq => null() !number of equations

◆ nja

integer(i4b), pointer numericalmodelmodule::numericalmodeltype::nja => null()
privateinherited

Definition at line 22 of file NumericalModel.f90.

22  integer(I4B), pointer :: nja => null() !number of connections

◆ nprp

integer(i4b), pointer prtmodule::prtmodeltype::nprp => null()
private

Definition at line 56 of file prt.f90.

56  integer(I4B), pointer :: nprp => null() ! number of PRP packages in the model

◆ oc

type(prtoctype), pointer prtmodule::prtmodeltype::oc => null()
private

Definition at line 44 of file prt.f90.

44  type(PrtOcType), pointer :: oc => null() ! output control package

◆ ratesto

real(dp), dimension(:), pointer, contiguous prtmodule::prtmodeltype::ratesto => null()
private

Definition at line 59 of file prt.f90.

59  real(DP), dimension(:), pointer, contiguous :: ratesto => null() !< particle mass storage rate in cells

◆ rhs

real(dp), dimension(:), pointer, contiguous numericalmodelmodule::numericalmodeltype::rhs => null()
privateinherited

Definition at line 28 of file NumericalModel.f90.

28  real(DP), dimension(:), pointer, contiguous :: rhs => null() !right-hand side vector

◆ trackctl

type(trackcontroltype), pointer prtmodule::prtmodeltype::trackctl
private

Definition at line 47 of file prt.f90.

47  type(TrackControlType), pointer :: trackctl ! track control

◆ x

real(dp), dimension(:), pointer, contiguous numericalmodelmodule::numericalmodeltype::x => null()
privateinherited

Definition at line 27 of file NumericalModel.f90.

27  real(DP), dimension(:), pointer, contiguous :: x => null() !dependent variable (head, conc, etc)

◆ xold

real(dp), dimension(:), pointer, contiguous numericalmodelmodule::numericalmodeltype::xold => null()
privateinherited

Definition at line 31 of file NumericalModel.f90.

31  real(DP), dimension(:), pointer, contiguous :: xold => null() !dependent variable for previous timestep

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