MODFLOW 6  version 6.5.0.dev2
MODFLOW 6 Code Documentation
Private Member Functions | Private Attributes | List of all members
prtocmodule::prtoctype Type Reference

@ brief Output control for particle tracking models More...

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

Private Member Functions

procedure oc_ar
 
procedure oc_da => prt_oc_da
 
procedure allocate_scalars => prt_oc_allocate_scalars
 
procedure read_options => prt_oc_read_options
 
procedure oc_df
 
procedure oc_rp
 
procedure oc_ot
 
procedure oc_save
 
procedure oc_print
 
procedure oc_save_unit
 
procedure set_print_flag
 

Private Attributes

integer(i4b), pointer itrkout => null()
 binary output file More...
 
integer(i4b), pointer itrkhdr => null()
 output header file More...
 
integer(i4b), pointer itrkcsv => null()
 CSV output file. More...
 
integer(i4b), pointer itrktls => null()
 track time list input file More...
 
logical(lgp), pointer trackrelease => null()
 whether to track release events More...
 
logical(lgp), pointer tracktransit => null()
 whether to track cell transition events More...
 
logical(lgp), pointer tracktimestep => null()
 whether to track timestep events More...
 
logical(lgp), pointer trackterminate => null()
 whether to track termination events More...
 
logical(lgp), pointer trackweaksink => null()
 whether to track weak sink exit events More...
 
logical(lgp), pointer trackusertime => null()
 whether to track user-specified times More...
 
type(timeselecttype), pointer tracktimes
 user-specified tracking times More...
 
character(len=lenmempath) memorypath
 path to data stored in the memory manager More...
 
character(len=lenmodelname), pointer name_model => null()
 name of the model More...
 
integer(i4b), pointer inunit => null()
 unit number for input file More...
 
integer(i4b), pointer iout => null()
 unit number for output file More...
 
integer(i4b), pointer ibudcsv => null()
 unit number for budget csv output file More...
 
integer(i4b), pointer iperoc => null()
 stress period number for next output control More...
 
integer(i4b), pointer iocrep => null()
 output control repeat flag (period 0 step 0) More...
 
type(outputcontroldatatype), dimension(:), pointer, contiguous ocdobj => null()
 output control objects More...
 
type(blockparsertype) parser
 

Detailed Description

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

Member Function/Subroutine Documentation

◆ allocate_scalars()

procedure prtocmodule::prtoctype::allocate_scalars
private

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

◆ oc_ar()

procedure prtocmodule::prtoctype::oc_ar
private

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

◆ oc_da()

procedure prtocmodule::prtoctype::oc_da
private

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

◆ oc_df()

procedure outputcontrolmodule::outputcontroltype::oc_df
privateinherited

Definition at line 37 of file OutputControl.f90.

◆ oc_ot()

procedure outputcontrolmodule::outputcontroltype::oc_ot
privateinherited

Definition at line 39 of file OutputControl.f90.

◆ oc_print()

procedure outputcontrolmodule::outputcontroltype::oc_print
privateinherited

Definition at line 44 of file OutputControl.f90.

◆ oc_rp()

procedure outputcontrolmodule::outputcontroltype::oc_rp
privateinherited

Definition at line 38 of file OutputControl.f90.

◆ oc_save()

procedure outputcontrolmodule::outputcontroltype::oc_save
privateinherited

Definition at line 43 of file OutputControl.f90.

◆ oc_save_unit()

procedure outputcontrolmodule::outputcontroltype::oc_save_unit
privateinherited

Definition at line 45 of file OutputControl.f90.

◆ read_options()

procedure prtocmodule::prtoctype::read_options
private

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

◆ set_print_flag()

procedure outputcontrolmodule::outputcontroltype::set_print_flag
privateinherited

Definition at line 46 of file OutputControl.f90.

Member Data Documentation

◆ ibudcsv

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

Definition at line 30 of file OutputControl.f90.

30  integer(I4B), pointer :: ibudcsv => null() !< unit number for budget csv output file

◆ inunit

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

Definition at line 28 of file OutputControl.f90.

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

◆ iocrep

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

Definition at line 32 of file OutputControl.f90.

32  integer(I4B), pointer :: iocrep => null() !< output control repeat flag (period 0 step 0)

◆ iout

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

Definition at line 29 of file OutputControl.f90.

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

◆ iperoc

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

Definition at line 31 of file OutputControl.f90.

31  integer(I4B), pointer :: iperoc => null() !< stress period number for next output control

◆ itrkcsv

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

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

24  integer(I4B), pointer :: itrkcsv => null() !< CSV output file

◆ itrkhdr

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

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

23  integer(I4B), pointer :: itrkhdr => null() !< output header file

◆ itrkout

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

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

22  integer(I4B), pointer :: itrkout => null() !< binary output file

◆ itrktls

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

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

25  integer(I4B), pointer :: itrktls => null() !< track time list input file

◆ memorypath

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

Definition at line 26 of file OutputControl.f90.

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

◆ name_model

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

Definition at line 27 of file OutputControl.f90.

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

◆ ocdobj

type(outputcontroldatatype), dimension(:), pointer, contiguous outputcontrolmodule::outputcontroltype::ocdobj => null()
privateinherited

Definition at line 33 of file OutputControl.f90.

33  type(OutputControlDataType), dimension(:), &
34  pointer, contiguous :: ocdobj => null() !< output control objects

◆ parser

type(blockparsertype) outputcontrolmodule::outputcontroltype::parser
privateinherited

Definition at line 35 of file OutputControl.f90.

35  type(BlockParserType) :: parser

◆ trackrelease

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

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

26  logical(LGP), pointer :: trackrelease => null() !< whether to track release events

◆ trackterminate

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

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

29  logical(LGP), pointer :: trackterminate => null() !< whether to track termination events

◆ tracktimes

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

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

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

◆ tracktimestep

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

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

28  logical(LGP), pointer :: tracktimestep => null() !< whether to track timestep events

◆ tracktransit

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

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

27  logical(LGP), pointer :: tracktransit => null() !< whether to track cell transition events

◆ trackusertime

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

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

31  logical(LGP), pointer :: trackusertime => null() !< whether to track user-specified times

◆ trackweaksink

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

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

30  logical(LGP), pointer :: trackweaksink => null() !< whether to track weak sink exit events
The documentation for this type was generated from the following file: