@ brief Output control More...

Inheritance diagram for swfocmodule::swfoctype:

Collaboration diagram for swfocmodule::swfoctype:

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

Public Attributes
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

Detailed Description

Concrete implementation of OutputControlType

Definition at line 16 of file swf-oc.f90.

Member Function/Subroutine Documentation

◆ allocate_scalars()

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.

◆ oc_ar()

procedure swfocmodule::swfoctype::oc_ar	(	class(swfoctype)	this,
		real(dp), dimension(:), intent(in), pointer, contiguous	datavec,
		class(disbasetype), intent(in), pointer	dis,
		real(dp), intent(in)	dnodata )

Setup head and budget as output control variables.

Parameters

	this	SwfOcType object
[in]	datavec	data vector
[in]	dis	model discretization package
[in]	dnodata	no data value

Definition at line 18 of file swf-oc.f90.

◆ oc_da()

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_df()

procedure outputcontrolmodule::outputcontroltype::oc_df ( class(outputcontroltype) this )

inherited

Parameters

this	this 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

	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

Parameters

this	this 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

	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.

◆ 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()

procedure outputcontrolmodule::outputcontroltype::source_options ( class(outputcontroltype) this )

inherited

Parameters

this	this instance

Definition at line 32 of file OutputControl.f90.

Member Data Documentation

◆ 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.

◆ 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.

◆ ocds

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

inherited

Definition at line 25 of file OutputControl.f90.

The documentation for this type was generated from the following file:

/home/runner/work/modflow6/modflow6/src/Model/SurfaceWaterFlow/swf-oc.f90

Public Member Functions

Public Attributes

Detailed Description

Member Function/Subroutine Documentation

◆ allocate_scalars()

◆ oc_ar()

◆ oc_da()

◆ oc_df()

◆ oc_ot()

◆ oc_print()

◆ oc_rp()

◆ oc_save()

◆ oc_save_unit()

◆ set_ocfile()

◆ set_print_flag()

◆ source_options()

Member Data Documentation

◆ ibudcsv

◆ input_fname

◆ input_mempath

◆ inunit

◆ iocrep

◆ iout

◆ iperoc

◆ memorypath

◆ name_model

◆ ocds