Controls model output. Overridden for each model type.
More...
|
| 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.
|
|
| 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 15 of file OutputControl.f90.
◆ allocate_scalars()
| procedure outputcontrolmodule::outputcontroltype::allocate_scalars |
( |
class(outputcontroltype) | this, |
|
|
character(len=*), intent(in) | name_model, |
|
|
character(len=*), intent(in) | input_mempath ) |
- 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.
◆ oc_da()
| procedure outputcontrolmodule::outputcontroltype::oc_da |
( |
class(outputcontroltype) | this | ) |
|
Deallocate member variables.
- Parameters
-
| this | OutputControlType object |
Definition at line 30 of file OutputControl.f90.
◆ oc_df()
| procedure outputcontrolmodule::outputcontroltype::oc_df |
( |
class(outputcontroltype) | this | ) |
|
◆ oc_ot()
| procedure outputcontrolmodule::outputcontroltype::oc_ot |
( |
class(outputcontroltype) | this, |
|
|
integer(i4b), intent(inout) | ipflg ) |
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 ) |
- 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 | ) |
|
◆ oc_save()
| procedure outputcontrolmodule::outputcontroltype::oc_save |
( |
class(outputcontroltype) | this, |
|
|
character(len=*), intent(in) | cname ) |
- 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 ) |
- Parameters
-
| this | OutputControlType object |
| [in] | cname | character string for data name |
Definition at line 36 of file OutputControl.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 ) |
- 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 ) |
- 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()
| procedure outputcontrolmodule::outputcontroltype::source_options |
( |
class(outputcontroltype) | this | ) |
|
◆ ibudcsv
| integer(i4b), pointer outputcontrolmodule::outputcontroltype::ibudcsv => null() |
◆ input_fname
| character(len=linelength), pointer outputcontrolmodule::outputcontroltype::input_fname => null() |
◆ input_mempath
| character(len=lenmempath) outputcontrolmodule::outputcontroltype::input_mempath |
◆ inunit
| integer(i4b), pointer outputcontrolmodule::outputcontroltype::inunit => null() |
◆ iocrep
| integer(i4b), pointer outputcontrolmodule::outputcontroltype::iocrep => null() |
◆ iout
| integer(i4b), pointer outputcontrolmodule::outputcontroltype::iout => null() |
◆ iperoc
| integer(i4b), pointer outputcontrolmodule::outputcontroltype::iperoc => null() |
◆ memorypath
| character(len=lenmempath) outputcontrolmodule::outputcontroltype::memorypath |
◆ name_model
| character(len=lenmodelname), pointer outputcontrolmodule::outputcontroltype::name_model => null() |
◆ ocds
| type(outputcontroldatatype), dimension(:), pointer, contiguous outputcontrolmodule::outputcontroltype::ocds => null() |
The documentation for this type was generated from the following file: