MODFLOW 6 version 6.9.0.dev0
USGS Modular Hydrologic Model
Loading...
Searching...
No Matches

Particle tracking (PRT) model. More...

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

Public Member Functions

procedure model_df (this)
 Define packages.
procedure model_ar (this)
 Allocate and read.
procedure model_rp (this)
 Read and prepare (calls package read and prepare routines).
procedure model_ad (this)
 Time step advance (calls package advance subroutines).
procedure model_cq (this, icnvg, isuppress_output)
 Calculate intercell flow (flowja).
procedure model_bd (this, icnvg, isuppress_output)
 Calculate flows and budget.
procedure model_ot (this)
 Print and/or save model output.
procedure model_da (this)
 Deallocate.
procedure model_solve (this, isuppress_output)
 Solve the model.
procedure allocate_scalars (this, modelname)
 Allocate memory for scalars.
procedure allocate_arrays (this)
 Allocate arrays.
procedure model_ad (this)
 Advance the model.
procedure model_solve (this, isuppress_output)
 Solve the model.
procedure model_cq (this, icnvg, isuppress_output)
 Calculate model flows.
procedure model_bd (this, icnvg, isuppress_output)
 Calculate model budget.
procedure model_da (this)
 Deallocate the model.
procedure model_da (this)
 Deallocate.
procedure allocate_scalars (this, modelname)
 Allocate scalar variables.
procedure allocate_scalars (this, modelname)
 Allocate scalar variables.
procedure allocate_arrays (this)
 Allocate array variables.
procedure set_idsoln (this, id)
 Set the solution ID.
procedure has_pending (this)
 Whether the model has any pending work.
procedure model_df (this)
 Define the model.
procedure model_ar (this)
 Allocate and read.
procedure model_rp (this)
 Read and prepare.
procedure model_dt (this)
 Calculate time step length.
procedure model_ot (this)
 Output results.
procedure model_fp (this)
 Final processing.
procedure model_message (this, line, fmt)
 Write line to model iout.
procedure create_lstfile (this, lst_fname, model_fname, defined, headertxt)

Public 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(methoddistype), pointer method_dis => null()
type(methoddisvtype), pointer method_disv => null()
type(particleeventdispatchertype), pointer events => null()
type(particletrackstype), pointer tracks
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
real(dp), dimension(:), pointer, contiguous massstoold => null()
 particle mass storage in cells, old value
real(dp), dimension(:), pointer, contiguous ratesto => null()
 particle mass storage rate in cells
real(dp), dimension(:), pointer, contiguous masstrm => null()
 particle mass terminating in cells, new value
real(dp), dimension(:), pointer, contiguous ratetrm => null()
 particle mass termination rate in cells
type(hashtabletype), pointer trm_ids => null()
 terminated particle ids
character(len=lenmempath) memorypath
 the location in the memory manager where the variables are stored
character(len=lenmodelname), pointer name => null()
 name of the model
character(len=linelength), pointer filename => null()
 input file name
character(len=3), pointer macronym => null()
 3 letter model acronym (GWF, GWT, ...)
integer(i4b), pointer idsoln => null()
 id of the solution model is in
integer(i4b), pointer id => null()
 model id
integer(i4b), pointer iout => null()
 output unit number
integer(i4b), pointer inewton => null()
 newton-raphson flag
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()
 save_flows flag
integer(i4b), pointer nja => null()
 number of connections
integer(i4b), dimension(:), pointer, contiguous ibound => null()
 ibound
real(dp), dimension(:), pointer, contiguous flowja => null()
 intercell flows
type(listtype), pointer bndlist => null()
 array of boundary packages
class(disbasetype), pointer dis => null()
 discretization object

Private Member Functions

procedure, private package_create (this, filtyp, ipakid, ipaknum, pakname, mempath, inunit, iout)
 Create boundary condition packages for this model.
procedure, private ftype_check (this, indis)
 Check to make sure required input files have been specified.
procedure, private prt_ot_flow (this, icbcfl, ibudfl, icbcun)
 Save flows.
procedure, private prt_ot_saveflow (this, nja, flowja, icbcfl, icbcun)
 Save intercell flows.
procedure, private prt_ot_printflow (this, ibudfl, flowja)
 Print intercell flows.
procedure, private prt_ot_dv (this, idvsave, idvprint, ipflag)
 Print dependent variables.
procedure, private prt_ot_bdsummary (this, ibudfl, ipflag)
 Print budget summary.
procedure, private prt_cq_budterms (this)
 Calculate particle mass budget terms.
procedure, private create_packages (this)
 Source package info and begin to process.
procedure, private create_bndpkgs (this, bndpkgs, pkgtypes, pkgnames, mempaths, inunits)
 Source package info and begin to process.
procedure, private create_exg_prp (this)
 Create an exchange PRP package for particles entering this model from other model.
procedure, private log_namfile_options (this, found)
 Write model namfile options to list file.

Detailed Description

Definition at line 48 of file prt.f90.

Member Function/Subroutine Documentation

◆ allocate_arrays() [1/2]

procedure explicitmodelmodule::explicitmodeltype::allocate_arrays ( class(explicitmodeltype) this)
inherited

Definition at line 31 of file ExplicitModel.f90.

◆ allocate_arrays() [2/2]

procedure prtmodule::prtmodeltype::allocate_arrays ( class(prtmodeltype) this)

Definition at line 87 of file prt.f90.

◆ allocate_scalars() [1/3]

procedure basemodelmodule::basemodeltype::allocate_scalars ( class(basemodeltype) this,
character(len=*), intent(in) modelname )
inherited

Definition at line 41 of file BaseModel.f90.

◆ allocate_scalars() [2/3]

procedure explicitmodelmodule::explicitmodeltype::allocate_scalars ( class(explicitmodeltype) this,
character(len=*), intent(in) modelname )
inherited

Definition at line 30 of file ExplicitModel.f90.

◆ allocate_scalars() [3/3]

procedure prtmodule::prtmodeltype::allocate_scalars ( class(prtmodeltype) this,
character(len=*), intent(in) modelname )

Definition at line 86 of file prt.f90.

◆ create_bndpkgs()

procedure, private prtmodule::prtmodeltype::create_bndpkgs ( class(prtmodeltype) this,
integer(i4b), dimension(:), intent(inout), allocatable bndpkgs,
type(characterstringtype), dimension(:), intent(inout), pointer, contiguous pkgtypes,
type(characterstringtype), dimension(:), intent(inout), pointer, contiguous pkgnames,
type(characterstringtype), dimension(:), intent(inout), pointer, contiguous mempaths,
integer(i4b), dimension(:), intent(inout), pointer, contiguous inunits )
private

Definition at line 97 of file prt.f90.

◆ create_exg_prp()

procedure, private prtmodule::prtmodeltype::create_exg_prp ( class(prtmodeltype) this)
private

Definition at line 98 of file prt.f90.

◆ create_lstfile()

procedure basemodelmodule::basemodeltype::create_lstfile ( class(basemodeltype) this,
character(len=*), intent(inout) lst_fname,
character(len=*), intent(in) model_fname,
logical(lgp), intent(in) defined,
character(len=*), intent(in) headertxt )
inherited

Definition at line 43 of file BaseModel.f90.

◆ create_packages()

procedure, private prtmodule::prtmodeltype::create_packages ( class(prtmodeltype) this)
private

Definition at line 96 of file prt.f90.

◆ ftype_check()

procedure, private prtmodule::prtmodeltype::ftype_check ( class(prtmodeltype) this,
integer(i4b), intent(in) indis )
private

Definition at line 89 of file prt.f90.

◆ has_pending()

procedure explicitmodelmodule::explicitmodeltype::has_pending ( class(explicitmodeltype), intent(in) this)
inherited

Definition at line 33 of file ExplicitModel.f90.

◆ log_namfile_options()

procedure, private prtmodule::prtmodeltype::log_namfile_options ( class(prtmodeltype) this,
type(prtnamparamfoundtype), intent(in) found )
private

Definition at line 99 of file prt.f90.

◆ model_ad() [1/2]

procedure explicitmodelmodule::explicitmodeltype::model_ad ( class(explicitmodeltype) this)
inherited

Definition at line 25 of file ExplicitModel.f90.

◆ model_ad() [2/2]

procedure prtmodule::prtmodeltype::model_ad ( class(prtmodeltype) this)

Definition at line 78 of file prt.f90.

◆ model_ar() [1/2]

procedure basemodelmodule::basemodeltype::model_ar ( class(basemodeltype) this)
inherited

Definition at line 35 of file BaseModel.f90.

◆ model_ar() [2/2]

procedure prtmodule::prtmodeltype::model_ar ( class(prtmodeltype) this)

(1) allocates and reads packages part of this model, (2) allocates memory for arrays part of this model object

Definition at line 76 of file prt.f90.

◆ model_bd() [1/2]

procedure explicitmodelmodule::explicitmodeltype::model_bd ( class(explicitmodeltype) this,
integer(i4b), intent(in) icnvg,
integer(i4b), intent(in) isuppress_output )
inherited

Definition at line 28 of file ExplicitModel.f90.

◆ model_bd() [2/2]

procedure prtmodule::prtmodeltype::model_bd ( class(prtmodeltype) this,
integer(i4b), intent(in) icnvg,
integer(i4b), intent(in) isuppress_output )

(1) Calculate intercell flows (flowja) (2) Calculate package contributions to model budget

Definition at line 80 of file prt.f90.

◆ model_cq() [1/2]

procedure explicitmodelmodule::explicitmodeltype::model_cq ( class(explicitmodeltype) this,
integer(i4b), intent(in) icnvg,
integer(i4b), intent(in) isuppress_output )
inherited

Definition at line 27 of file ExplicitModel.f90.

◆ model_cq() [2/2]

procedure prtmodule::prtmodeltype::model_cq ( class(prtmodeltype) this,
integer(i4b), intent(in) icnvg,
integer(i4b), intent(in) isuppress_output )

Definition at line 79 of file prt.f90.

◆ model_da() [1/3]

procedure basemodelmodule::basemodeltype::model_da ( class(basemodeltype) this)
inherited

Definition at line 40 of file BaseModel.f90.

◆ model_da() [2/3]

procedure explicitmodelmodule::explicitmodeltype::model_da ( class(explicitmodeltype) this)
inherited

Definition at line 29 of file ExplicitModel.f90.

◆ model_da() [3/3]

procedure prtmodule::prtmodeltype::model_da ( class(prtmodeltype) this)

Definition at line 82 of file prt.f90.

◆ model_df() [1/2]

procedure basemodelmodule::basemodeltype::model_df ( class(basemodeltype) this)
inherited

Definition at line 34 of file BaseModel.f90.

◆ model_df() [2/2]

procedure prtmodule::prtmodeltype::model_df ( class(prtmodeltype) this)

(1) call df routines for each package (2) set variables and pointers

Definition at line 75 of file prt.f90.

◆ model_dt()

procedure basemodelmodule::basemodeltype::model_dt ( class(basemodeltype) this)
inherited

Definition at line 37 of file BaseModel.f90.

◆ model_fp()

procedure basemodelmodule::basemodeltype::model_fp ( class(basemodeltype) this)
inherited

Definition at line 39 of file BaseModel.f90.

◆ model_message()

procedure basemodelmodule::basemodeltype::model_message ( class(basemodeltype) this,
character(len=*), intent(in) line,
character(len=*), intent(in), optional fmt )
inherited

Definition at line 42 of file BaseModel.f90.

◆ model_ot() [1/2]

procedure basemodelmodule::basemodeltype::model_ot ( class(basemodeltype) this)
inherited

Definition at line 38 of file BaseModel.f90.

◆ model_ot() [2/2]

procedure prtmodule::prtmodeltype::model_ot ( class(prtmodeltype) this)

Definition at line 81 of file prt.f90.

◆ model_rp() [1/2]

procedure basemodelmodule::basemodeltype::model_rp ( class(basemodeltype) this)
inherited

Definition at line 36 of file BaseModel.f90.

◆ model_rp() [2/2]

procedure prtmodule::prtmodeltype::model_rp ( class(prtmodeltype) this)

Definition at line 77 of file prt.f90.

◆ model_solve() [1/2]

procedure explicitmodelmodule::explicitmodeltype::model_solve ( class(explicitmodeltype) this,
integer(i4b), intent(in) isuppress_output )
inherited

Definition at line 26 of file ExplicitModel.f90.

◆ model_solve() [2/2]

procedure prtmodule::prtmodeltype::model_solve ( class(prtmodeltype) this,
integer(i4b), intent(in) isuppress_output )

Definition at line 83 of file prt.f90.

◆ package_create()

procedure, private prtmodule::prtmodeltype::package_create ( class(prtmodeltype) this,
character(len=*), intent(in) filtyp,
integer(i4b), intent(in) ipakid,
integer(i4b), intent(in) ipaknum,
character(len=*), intent(in) pakname,
character(len=*), intent(in) mempath,
integer(i4b), intent(in) inunit,
integer(i4b), intent(in) iout )
private

Definition at line 88 of file prt.f90.

◆ prt_cq_budterms()

procedure, private prtmodule::prtmodeltype::prt_cq_budterms ( class(prtmodeltype) this)
private

Definition at line 95 of file prt.f90.

◆ prt_ot_bdsummary()

procedure, private prtmodule::prtmodeltype::prt_ot_bdsummary ( class(prtmodeltype) this,
integer(i4b), intent(in) ibudfl,
integer(i4b), intent(inout) ipflag )
private

Definition at line 94 of file prt.f90.

◆ prt_ot_dv()

procedure, private prtmodule::prtmodeltype::prt_ot_dv ( class(prtmodeltype) this,
integer(i4b), intent(in) idvsave,
integer(i4b), intent(in) idvprint,
integer(i4b), intent(inout) ipflag )
private

Definition at line 93 of file prt.f90.

◆ prt_ot_flow()

procedure, private prtmodule::prtmodeltype::prt_ot_flow ( class(prtmodeltype) this,
integer(i4b), intent(in) icbcfl,
integer(i4b), intent(in) ibudfl,
integer(i4b), intent(in) icbcun )
private

Definition at line 90 of file prt.f90.

◆ prt_ot_printflow()

procedure, private prtmodule::prtmodeltype::prt_ot_printflow ( class(prtmodeltype) this,
integer(i4b), intent(in) ibudfl,
real(dp), dimension(:), intent(inout) flowja )
private

Definition at line 92 of file prt.f90.

◆ prt_ot_saveflow()

procedure, private prtmodule::prtmodeltype::prt_ot_saveflow ( class(prtmodeltype) this,
integer(i4b), intent(in) nja,
real(dp), dimension(nja), intent(in) flowja,
integer(i4b), intent(in) icbcfl,
integer(i4b), intent(in) icbcun )
private

Definition at line 91 of file prt.f90.

◆ set_idsoln()

procedure explicitmodelmodule::explicitmodeltype::set_idsoln ( class(explicitmodeltype) this,
integer(i4b), intent(in) id )
inherited

Definition at line 32 of file ExplicitModel.f90.

Member Data Documentation

◆ bndlist

type(listtype), pointer basemodelmodule::basemodeltype::bndlist => null()
inherited

Definition at line 31 of file BaseModel.f90.

◆ budget

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

Definition at line 52 of file prt.f90.

◆ dis

class(disbasetype), pointer basemodelmodule::basemodeltype::dis => null()
inherited

Definition at line 32 of file BaseModel.f90.

◆ events

type(particleeventdispatchertype), pointer prtmodule::prtmodeltype::events => null()

Definition at line 56 of file prt.f90.

◆ filename

character(len=linelength), pointer basemodelmodule::basemodeltype::filename => null()
inherited

Definition at line 19 of file BaseModel.f90.

◆ flowja

real(dp), dimension(:), pointer, contiguous basemodelmodule::basemodeltype::flowja => null()
inherited

Definition at line 30 of file BaseModel.f90.

◆ fmi

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

Definition at line 49 of file prt.f90.

◆ ibound

integer(i4b), dimension(:), pointer, contiguous basemodelmodule::basemodeltype::ibound => null()
inherited

Definition at line 29 of file BaseModel.f90.

◆ id

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

Definition at line 22 of file BaseModel.f90.

◆ idsoln

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

Definition at line 21 of file BaseModel.f90.

◆ inadv

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

Definition at line 62 of file prt.f90.

◆ indsp

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

Definition at line 63 of file prt.f90.

◆ inewton

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

Definition at line 24 of file BaseModel.f90.

◆ infmi

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

Definition at line 58 of file prt.f90.

◆ inmip

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

Definition at line 59 of file prt.f90.

◆ inmst

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

Definition at line 61 of file prt.f90.

◆ inmvt

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

Definition at line 60 of file prt.f90.

◆ inoc

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

Definition at line 65 of file prt.f90.

◆ inssm

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

Definition at line 64 of file prt.f90.

◆ iout

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

Definition at line 23 of file BaseModel.f90.

◆ ipakcb

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

Definition at line 27 of file BaseModel.f90.

◆ iprflow

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

Definition at line 26 of file BaseModel.f90.

◆ iprpak

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

Definition at line 25 of file BaseModel.f90.

◆ macronym

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

Definition at line 20 of file BaseModel.f90.

◆ masssto

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

Definition at line 67 of file prt.f90.

◆ massstoold

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

Definition at line 68 of file prt.f90.

◆ masstrm

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

Definition at line 70 of file prt.f90.

◆ memorypath

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

Definition at line 17 of file BaseModel.f90.

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

◆ method

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

Definition at line 53 of file prt.f90.

◆ method_dis

type(methoddistype), pointer prtmodule::prtmodeltype::method_dis => null()

Definition at line 54 of file prt.f90.

◆ method_disv

type(methoddisvtype), pointer prtmodule::prtmodeltype::method_disv => null()

Definition at line 55 of file prt.f90.

◆ mip

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

Definition at line 50 of file prt.f90.

◆ name

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

Definition at line 18 of file BaseModel.f90.

◆ nja

integer(i4b), pointer basemodelmodule::basemodeltype::nja => null()
inherited

Definition at line 28 of file BaseModel.f90.

◆ nprp

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

Definition at line 66 of file prt.f90.

◆ oc

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

Definition at line 51 of file prt.f90.

◆ ratesto

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

Definition at line 69 of file prt.f90.

◆ ratetrm

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

Definition at line 71 of file prt.f90.

◆ tracks

type(particletrackstype), pointer prtmodule::prtmodeltype::tracks

Definition at line 57 of file prt.f90.

57 type(ParticleTracksType), pointer :: tracks ! track output manager

◆ trm_ids

type(hashtabletype), pointer prtmodule::prtmodeltype::trm_ids => null()

Definition at line 72 of file prt.f90.


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