Output control for particle tracking models.
More...
|
| 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.
|
|
| 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
|
Definition at line 21 of file prt-oc.f90.
◆ 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
-
| this | this instance |
| [in] | name_model | name of model |
| [in] | input_mempath | input 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_model | name of model |
| [in] | input_mempath | input 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
-
| this | PrtOcType object |
| [in] | dis | model discretization package |
| [in] | dnodata | no 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
-
| this | OutputControlType object |
Definition at line 30 of file OutputControl.f90.
◆ oc_da() [2/2]
| procedure prtocmodule::prtoctype::oc_da |
( |
class(prtoctype) | this | ) |
|
◆ oc_df()
| procedure outputcontrolmodule::outputcontroltype::oc_df |
( |
class(outputcontroltype) | this | ) |
|
|
inherited |
◆ 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
-
| this | OutputControlType object |
| [in,out] | ipflg | flag 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
-
| this | OutputControlType object |
| [in] | cname | character string for data name |
Definition at line 35 of file OutputControl.f90.
◆ oc_rp()
| procedure outputcontrolmodule::outputcontroltype::oc_rp |
( |
class(outputcontroltype) | this | ) |
|
|
inherited |
◆ oc_save()
| procedure outputcontrolmodule::outputcontroltype::oc_save |
( |
class(outputcontroltype) | this, |
|
|
character(len=*), intent(in) | cname ) |
|
inherited |
- Parameters
-
| this | OutputControlType object |
| [in] | cname | character 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
-
| this | OutputControlType object |
| [in] | cname | character 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 |
◆ prt_oc_source_tracktimes()
| procedure, private prtocmodule::prtoctype::prt_oc_source_tracktimes |
( |
class(prtoctype), intent(inout) | this | ) |
|
|
private |
◆ 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
-
| this | OutputControlDataType object |
| [in] | cname | data object cname |
| [in] | ocfile | OC output filename |
| [in] | iout | Unit 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
-
| this | OutputControlType object |
| [in] | cname | character string for data name |
| [in] | icnvg | convergence flag |
| [in] | endofperiod | end 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 |
◆ source_options() [2/2]
| procedure prtocmodule::prtoctype::source_options |
( |
class(prtoctype) | this | ) |
|
◆ dump_event_trace
| logical(lgp), pointer prtocmodule::prtoctype::dump_event_trace => null() |
◆ ibudcsv
| integer(i4b), pointer outputcontrolmodule::outputcontroltype::ibudcsv => null() |
|
inherited |
◆ input_fname
| character(len=linelength), pointer outputcontrolmodule::outputcontroltype::input_fname => null() |
|
inherited |
◆ input_mempath
| character(len=lenmempath) outputcontrolmodule::outputcontroltype::input_mempath |
|
inherited |
◆ inunit
| integer(i4b), pointer outputcontrolmodule::outputcontroltype::inunit => null() |
|
inherited |
◆ iocrep
| integer(i4b), pointer outputcontrolmodule::outputcontroltype::iocrep => null() |
|
inherited |
◆ iout
| integer(i4b), pointer outputcontrolmodule::outputcontroltype::iout => null() |
|
inherited |
◆ iperoc
| integer(i4b), pointer outputcontrolmodule::outputcontroltype::iperoc => null() |
|
inherited |
◆ itrkcsv
| integer(i4b), pointer prtocmodule::prtoctype::itrkcsv => null() |
◆ itrkhdr
| integer(i4b), pointer prtocmodule::prtoctype::itrkhdr => null() |
◆ itrkout
| integer(i4b), pointer prtocmodule::prtoctype::itrkout => null() |
◆ itrktls
| integer(i4b), pointer prtocmodule::prtoctype::itrktls => null() |
◆ memorypath
| character(len=lenmempath) outputcontrolmodule::outputcontroltype::memorypath |
|
inherited |
◆ name_model
| character(len=lenmodelname), pointer outputcontrolmodule::outputcontroltype::name_model => null() |
|
inherited |
◆ ntracktimes
| integer(i4b), pointer prtocmodule::prtoctype::ntracktimes => null() |
◆ ocds
| type(outputcontroldatatype), dimension(:), pointer, contiguous outputcontrolmodule::outputcontroltype::ocds => null() |
|
inherited |
◆ scratch_buffer
| logical(lgp), pointer prtocmodule::prtoctype::scratch_buffer => null() |
◆ trackdropped
| logical(lgp), pointer prtocmodule::prtoctype::trackdropped => null() |
◆ trackfeatexit
| logical(lgp), pointer prtocmodule::prtoctype::trackfeatexit => null() |
◆ trackrelease
| logical(lgp), pointer prtocmodule::prtoctype::trackrelease => null() |
◆ tracksubfexit
| logical(lgp), pointer prtocmodule::prtoctype::tracksubfexit => null() |
◆ trackterminate
| logical(lgp), pointer prtocmodule::prtoctype::trackterminate => null() |
◆ tracktimes
Definition at line 37 of file prt-oc.f90.
37 type(TimeSelectType), pointer :: tracktimes
◆ tracktimestep
| logical(lgp), pointer prtocmodule::prtoctype::tracktimestep => null() |
◆ trackusertime
| logical(lgp), pointer prtocmodule::prtoctype::trackusertime => null() |
◆ trackweaksink
| logical(lgp), pointer prtocmodule::prtoctype::trackweaksink => null() |
The documentation for this type was generated from the following file:
- /home/runner/work/modflow6/modflow6/src/Model/ParticleTracking/prt-oc.f90