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

Output control for particle tracking models. More...

Inheritance diagram for prtocmodule::prtoctype:
Inheritance graph
Collaboration diagram for prtocmodule::prtoctype:
Collaboration graph

Public Member Functions

procedure oc_ar (this, dis, dnodata)
 Setup output control variables.
procedure oc_da (this)
procedure allocate_scalars (this, name_model, input_mempath)
procedure source_options (this)
procedure oc_df (this)
 Define the output control type. Placeholder routine.
procedure oc_rp (this)
 Read period block options and prepare the output control type.
procedure oc_ot (this, ipflg)
 Write output.
procedure oc_da (this)
 Deallocate method for OutputControlType.
procedure allocate_scalars (this, name_model, input_mempath)
 Allocate variables for the output control object.
procedure source_options (this)
 Read the output control options block.
procedure set_ocfile (this, cname, ocfile, iout)
procedure oc_save (this, cname)
 Determine if it is time to save.
procedure oc_print (this, cname)
 Determine if it is time to print.
procedure oc_save_unit (this, cname)
 Determine unit number for saving.
procedure set_print_flag (this, cname, icnvg, endofperiod)
 Set the print flag based on convergence and other parameters.

Public Attributes

integer(i4b), pointer itrkout => null()
 binary output file
integer(i4b), pointer itrkhdr => null()
 output header file
integer(i4b), pointer itrkcsv => null()
 CSV output file.
integer(i4b), pointer itrktls => null()
 track time list input file
logical(lgp), pointer trackrelease => null()
 whether to track release events
logical(lgp), pointer trackfeatexit => null()
 whether to track grid-scale feature exit events
logical(lgp), pointer tracktimestep => null()
 whether to track timestep events
logical(lgp), pointer trackterminate => null()
 whether to track termination events
logical(lgp), pointer trackweaksink => null()
 whether to track weak sink exit events
logical(lgp), pointer trackusertime => null()
 whether to track user-specified times
logical(lgp), pointer tracksubfexit => null()
 whether to track sub-grid-scale feature exit events
logical(lgp), pointer trackdropped => null()
 whether to track drops to water table
integer(i4b), pointer ntracktimes => null()
 number of user-specified tracking times
logical(lgp), pointer dump_event_trace => null()
 whether to dump event trace for debugging
logical(lgp), pointer scratch_buffer => null()
 whether to use scratch file instead of memory for event buffering
type(timeselecttype), pointer tracktimes
 user-specified tracking times
character(len=lenmempath) memorypath
 path to data stored in the memory manager
character(len=lenmempath) input_mempath
 input memory path
character(len=lenmodelname), pointer name_model => null()
 name of the model
character(len=linelength), pointer input_fname => null()
 input file name
integer(i4b), pointer inunit => null()
 unit number for input file
integer(i4b), pointer iout => null()
 unit number for output file
integer(i4b), pointer ibudcsv => null()
 unit number for budget csv output file
integer(i4b), pointer iperoc => null()
 stress period number for next output control
integer(i4b), pointer iocrep => null()
 output control repeat flag (period 0 step 0)
type(outputcontroldatatype), dimension(:), pointer, contiguous ocds => null()
 output control objects

Private Member Functions

procedure, private prt_oc_source_dimensions (this)
 source the dimensions block.
procedure, private prt_oc_source_tracktimes (this)
 source the tracking times block.

Detailed Description

Definition at line 21 of file prt-oc.f90.

Member Function/Subroutine Documentation

◆ allocate_scalars() [1/2]

procedure outputcontrolmodule::outputcontroltype::allocate_scalars ( class(outputcontroltype) this,
character(len=*), intent(in) name_model,
character(len=*), intent(in) input_mempath )
inherited
Parameters
thisthis instance
[in]name_modelname of model
[in]input_mempathinput mempath of the package

Definition at line 31 of file OutputControl.f90.

◆ allocate_scalars() [2/2]

procedure prtocmodule::prtoctype::allocate_scalars ( class(prtoctype) this,
character(len=*), intent(in) name_model,
character(len=*), intent(in) input_mempath )
Parameters
[in]name_modelname of model
[in]input_mempathinput mempath of the package

Definition at line 42 of file prt-oc.f90.

◆ oc_ar()

procedure prtocmodule::prtoctype::oc_ar ( class(prtoctype) this,
class(disbasetype), intent(in), pointer dis,
real(dp), intent(in) dnodata )
Parameters
thisPrtOcType object
[in]dismodel discretization package
[in]dnodatano data value

Definition at line 40 of file prt-oc.f90.

◆ oc_da() [1/2]

procedure outputcontrolmodule::outputcontroltype::oc_da ( class(outputcontroltype) this)
inherited

Deallocate member variables.

Parameters
thisOutputControlType object

Definition at line 30 of file OutputControl.f90.

◆ oc_da() [2/2]

procedure prtocmodule::prtoctype::oc_da ( class(prtoctype) this)

Definition at line 41 of file prt-oc.f90.

◆ oc_df()

procedure outputcontrolmodule::outputcontroltype::oc_df ( class(outputcontroltype) this)
inherited
Parameters
thisthis instance

Definition at line 27 of file OutputControl.f90.

◆ oc_ot()

procedure outputcontrolmodule::outputcontroltype::oc_ot ( class(outputcontroltype) this,
integer(i4b), intent(inout) ipflg )
inherited

Go through each output control data type and print and/or save data based on user-specified controls.

Parameters
thisOutputControlType object
[in,out]ipflgflag indicating if data was printed

Definition at line 29 of file OutputControl.f90.

◆ oc_print()

procedure outputcontrolmodule::outputcontroltype::oc_print ( class(outputcontroltype) this,
character(len=*), intent(in) cname )
inherited
Parameters
thisOutputControlType object
[in]cnamecharacter string for data name

Definition at line 35 of file OutputControl.f90.

◆ oc_rp()

procedure outputcontrolmodule::outputcontroltype::oc_rp ( class(outputcontroltype) this)
inherited
Parameters
thisthis instance

Definition at line 28 of file OutputControl.f90.

◆ oc_save()

procedure outputcontrolmodule::outputcontroltype::oc_save ( class(outputcontroltype) this,
character(len=*), intent(in) cname )
inherited
Parameters
thisOutputControlType object
[in]cnamecharacter string for data name

Definition at line 34 of file OutputControl.f90.

◆ oc_save_unit()

procedure outputcontrolmodule::outputcontroltype::oc_save_unit ( class(outputcontroltype) this,
character(len=*), intent(in) cname )
inherited
Parameters
thisOutputControlType object
[in]cnamecharacter string for data name

Definition at line 36 of file OutputControl.f90.

◆ prt_oc_source_dimensions()

procedure, private prtocmodule::prtoctype::prt_oc_source_dimensions ( class(prtoctype), intent(inout) this)
private

Definition at line 44 of file prt-oc.f90.

◆ prt_oc_source_tracktimes()

procedure, private prtocmodule::prtoctype::prt_oc_source_tracktimes ( class(prtoctype), intent(inout) this)
private

Definition at line 45 of file prt-oc.f90.

◆ set_ocfile()

procedure outputcontrolmodule::outputcontroltype::set_ocfile ( class(outputcontroltype) this,
character(len=*), intent(in) cname,
character(len=*), intent(in) ocfile,
integer(i4b), intent(in) iout )
inherited
Parameters
thisOutputControlDataType object
[in]cnamedata object cname
[in]ocfileOC output filename
[in]ioutUnit number for output

Definition at line 33 of file OutputControl.f90.

◆ set_print_flag()

procedure outputcontrolmodule::outputcontroltype::set_print_flag ( class(outputcontroltype) this,
character(len=*), intent(in) cname,
integer(i4b), intent(in) icnvg,
logical, intent(in) endofperiod )
inherited
Parameters
thisOutputControlType object
[in]cnamecharacter string for data name
[in]icnvgconvergence flag
[in]endofperiodend of period logical flag

Definition at line 37 of file OutputControl.f90.

◆ source_options() [1/2]

procedure outputcontrolmodule::outputcontroltype::source_options ( class(outputcontroltype) this)
inherited
Parameters
thisthis instance

Definition at line 32 of file OutputControl.f90.

◆ source_options() [2/2]

procedure prtocmodule::prtoctype::source_options ( class(prtoctype) this)

Definition at line 43 of file prt-oc.f90.

Member Data Documentation

◆ dump_event_trace

logical(lgp), pointer prtocmodule::prtoctype::dump_event_trace => null()

Definition at line 35 of file prt-oc.f90.

◆ ibudcsv

integer(i4b), pointer outputcontrolmodule::outputcontroltype::ibudcsv => null()
inherited

Definition at line 22 of file OutputControl.f90.

◆ input_fname

character(len=linelength), pointer outputcontrolmodule::outputcontroltype::input_fname => null()
inherited

Definition at line 19 of file OutputControl.f90.

◆ input_mempath

character(len=lenmempath) outputcontrolmodule::outputcontroltype::input_mempath
inherited

Definition at line 17 of file OutputControl.f90.

17 character(len=LENMEMPATH) :: input_mempath !< input memory path

◆ inunit

integer(i4b), pointer outputcontrolmodule::outputcontroltype::inunit => null()
inherited

Definition at line 20 of file OutputControl.f90.

◆ iocrep

integer(i4b), pointer outputcontrolmodule::outputcontroltype::iocrep => null()
inherited

Definition at line 24 of file OutputControl.f90.

◆ iout

integer(i4b), pointer outputcontrolmodule::outputcontroltype::iout => null()
inherited

Definition at line 21 of file OutputControl.f90.

◆ iperoc

integer(i4b), pointer outputcontrolmodule::outputcontroltype::iperoc => null()
inherited

Definition at line 23 of file OutputControl.f90.

◆ itrkcsv

integer(i4b), pointer prtocmodule::prtoctype::itrkcsv => null()

Definition at line 24 of file prt-oc.f90.

◆ itrkhdr

integer(i4b), pointer prtocmodule::prtoctype::itrkhdr => null()

Definition at line 23 of file prt-oc.f90.

◆ itrkout

integer(i4b), pointer prtocmodule::prtoctype::itrkout => null()

Definition at line 22 of file prt-oc.f90.

◆ itrktls

integer(i4b), pointer prtocmodule::prtoctype::itrktls => null()

Definition at line 25 of file prt-oc.f90.

◆ memorypath

character(len=lenmempath) outputcontrolmodule::outputcontroltype::memorypath
inherited

Definition at line 16 of file OutputControl.f90.

16 character(len=LENMEMPATH) :: memoryPath !< path to data stored in the memory manager

◆ name_model

character(len=lenmodelname), pointer outputcontrolmodule::outputcontroltype::name_model => null()
inherited

Definition at line 18 of file OutputControl.f90.

◆ ntracktimes

integer(i4b), pointer prtocmodule::prtoctype::ntracktimes => null()

Definition at line 34 of file prt-oc.f90.

◆ ocds

type(outputcontroldatatype), dimension(:), pointer, contiguous outputcontrolmodule::outputcontroltype::ocds => null()
inherited

Definition at line 25 of file OutputControl.f90.

◆ scratch_buffer

logical(lgp), pointer prtocmodule::prtoctype::scratch_buffer => null()

Definition at line 36 of file prt-oc.f90.

◆ trackdropped

logical(lgp), pointer prtocmodule::prtoctype::trackdropped => null()

Definition at line 33 of file prt-oc.f90.

◆ trackfeatexit

logical(lgp), pointer prtocmodule::prtoctype::trackfeatexit => null()

Definition at line 27 of file prt-oc.f90.

◆ trackrelease

logical(lgp), pointer prtocmodule::prtoctype::trackrelease => null()

Definition at line 26 of file prt-oc.f90.

◆ tracksubfexit

logical(lgp), pointer prtocmodule::prtoctype::tracksubfexit => null()

Definition at line 32 of file prt-oc.f90.

◆ trackterminate

logical(lgp), pointer prtocmodule::prtoctype::trackterminate => null()

Definition at line 29 of file prt-oc.f90.

◆ tracktimes

type(timeselecttype), pointer prtocmodule::prtoctype::tracktimes

Definition at line 37 of file prt-oc.f90.

37 type(TimeSelectType), pointer :: tracktimes !< user-specified tracking times

◆ tracktimestep

logical(lgp), pointer prtocmodule::prtoctype::tracktimestep => null()

Definition at line 28 of file prt-oc.f90.

◆ trackusertime

logical(lgp), pointer prtocmodule::prtoctype::trackusertime => null()

Definition at line 31 of file prt-oc.f90.

◆ trackweaksink

logical(lgp), pointer prtocmodule::prtoctype::trackweaksink => null()

Definition at line 30 of file prt-oc.f90.


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