outputcontrolmodule Module Reference

Model output control.

Data Types
type	outputcontroltype
	@ brief Controls model output. Overridden for each model type. More...

Functions/Subroutines
subroutine, public	oc_cr (oc, name_model, input_mempath, inunit, iout)
	Create a new output control object. More...
subroutine	oc_df (this)
	@ brief Define the output control type. Placeholder routine. More...
subroutine	oc_rp (this)
	@ brief Read period block options and prepare the output control type. More...
subroutine	oc_ot (this, ipflg)
	@ brief Write output. More...
subroutine	oc_da (this)
	@ brief Deallocate method for OutputControlType More...
subroutine	allocate (this, name_model, input_mempath)
	@ brief Allocate variables for the output control object More...
subroutine	source_options (this)
	@ brief Read the output control options block More...
subroutine	set_ocfile (this, cname, ocfile, iout)
logical function	oc_save (this, cname)
	@ brief Determine if it is time to save. More...
logical function	oc_print (this, cname)
	@ brief Determine if it is time to print. More...
integer(i4b) function	oc_save_unit (this, cname)
	@ brief Determine unit number for saving More...
integer(i4b) function	set_print_flag (this, cname, icnvg, endofperiod)
	@ brief Set the print flag based on convergence and other parameters More...

Function/Subroutine Documentation

allocate()

subroutine outputcontrolmodule::allocate	(	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 191 of file OutputControl.f90.

    ! modules
    use memorymanagermodule, only: mem_allocate
    use memoryhelpermodule, only: create_mem_path
    use memorymanagerextmodule, only: mem_set_value
    ! dummy
    class(OutputControlType) :: this !< this instance
    character(len=*), intent(in) :: name_model !< name of model
    character(len=*), intent(in) :: input_mempath !< input mempath of the package
    logical(LGP) :: found
 
    this%memoryPath = create_mem_path(name_model, 'OC')
 
    allocate (this%name_model)
    allocate (this%input_fname)
    call mem_allocate(this%inunit, 'INUNIT', this%memoryPath)
    call mem_allocate(this%iout, 'IOUT', this%memoryPath)
    call mem_allocate(this%ibudcsv, 'IBUDCSV', this%memoryPath)
    call mem_allocate(this%iperoc, 'IPEROC', this%memoryPath)
    call mem_allocate(this%iocrep, 'IOCREP', this%memoryPath)
 
    this%name_model = name_model
    this%input_mempath = input_mempath
    this%input_fname = ''
    this%inunit = 0
    this%iout = 0
    this%ibudcsv = 0
    this%iperoc = 0
    this%iocrep = 0
 
    if (this%input_mempath /= '') then
      call mem_set_value(this%input_fname, 'INPUT_FNAME', &
                         this%input_mempath, found)
    end if

Here is the call graph for this function:

oc_cr()

subroutine, public outputcontrolmodule::oc_cr	(	type(outputcontroltype), pointer	oc,
		character(len=*), intent(in)	name_model,
		character(len=*), intent(in)	input_mempath,
		integer(i4b), intent(in)	inunit,
		integer(i4b), intent(in)	iout
	)

Parameters

	oc	OutputControlType object
[in]	name_model	name of the model
[in]	input_mempath	input mempath of the package
[in]	inunit	unit number for input
[in]	iout	unit number for output

Definition at line 43 of file OutputControl.f90.

    type(OutputControlType), pointer :: oc !< OutputControlType object
    character(len=*), intent(in) :: name_model !< name of the model
    character(len=*), intent(in) :: input_mempath !< input mempath of the package
    integer(I4B), intent(in) :: inunit !< unit number for input
    integer(I4B), intent(in) :: iout !< unit number for output
 
    allocate (oc)
    call oc%allocate_scalars(name_model, input_mempath)
    oc%inunit = inunit
    oc%iout = iout

oc_da()

subroutine outputcontrolmodule::oc_da

(

class(outputcontroltype)

this

)

Deallocate member variables.

Parameters

this	OutputControlType object

Definition at line 168 of file OutputControl.f90.

    ! modules
    use memorymanagermodule, only: mem_deallocate
    ! dummy
    class(OutputControlType) :: this !< OutputControlType object
    ! local
    integer(I4B) :: i
 
    do i = 1, size(this%ocds)
      call this%ocds(i)%ocd_da()
    end do
    deallocate (this%ocds)
 
    deallocate (this%name_model)
    deallocate (this%input_fname)
    call mem_deallocate(this%inunit)
    call mem_deallocate(this%iout)
    call mem_deallocate(this%ibudcsv)
    call mem_deallocate(this%iperoc)
    call mem_deallocate(this%iocrep)

oc_df()

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

private

Parameters

this	this instance

Definition at line 57 of file OutputControl.f90.

    class(OutputControlType) :: this !< this instance

oc_ot()

subroutine outputcontrolmodule::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 143 of file OutputControl.f90.

    ! modules
    use tdismodule, only: kstp, endofperiod
    ! dummy
    class(OutputControlType) :: this !< OutputControlType object
    integer(I4B), intent(inout) :: ipflg !< flag indicating if data was printed
    ! local
    integer(I4B) :: ipos
    type(OutputControlDataType), pointer :: ocdobjptr
 
    ! Clear printout flag(ipflg).  This flag indicates that an array was
    ! printed to the listing file.
    ipflg = 0
 
    do ipos = 1, size(this%ocds)
      ocdobjptr => this%ocds(ipos)
      call ocdobjptr%ocd_ot(ipflg, kstp, endofperiod, this%iout)
    end do

oc_print()

logical function outputcontrolmodule::oc_print	(	class(outputcontroltype)	this,
		character(len=*), intent(in)	cname
	)

Parameters

	this	OutputControlType object
[in]	cname	character string for data name

Definition at line 341 of file OutputControl.f90.

    ! modules
    use tdismodule, only: kstp, endofperiod
    ! dummy
    class(OutputControlType) :: this !< OutputControlType object
    character(len=*), intent(in) :: cname !< character string for data name
    ! local
    integer(I4B) :: ipos
    logical(LGP) :: found
    class(OutputControlDataType), pointer :: ocdobjptr
 
    oc_print = .false.
    found = .false.
    do ipos = 1, size(this%ocds)
      ocdobjptr => this%ocds(ipos)
      if (cname == trim(ocdobjptr%cname)) then
        found = .true.
        exit
      end if
    end do
    if (found) then
      oc_print = ocdobjptr%psm%should_print(kstp, endofperiod)
    end if

oc_rp()

subroutine outputcontrolmodule::oc_rp ( class(outputcontroltype)  this )

private

Parameters

this	this instance

Definition at line 62 of file OutputControl.f90.

    ! modules
    use tdismodule, only: kper
    use simmodule, only: store_error, store_error_filename
    use memorymanagermodule, only: mem_setptr
    use characterstringmodule, only: characterstringtype
    ! dummy
    class(OutputControlType) :: this !< this instance
    ! local
    class(OutputControlDataType), pointer :: ocdobjptr
    integer(I4B), pointer :: iper
    type(CharacterStringType), dimension(:), &
      pointer, contiguous :: ocactions
    type(CharacterStringType), dimension(:), &
      pointer, contiguous :: rtypes
    type(CharacterStringType), dimension(:), &
      pointer, contiguous :: ocsettings
    integer(I4B), pointer :: nlist
    integer(I4B) :: n, ipos
    character(len=LINELENGTH) :: ocaction, rtype, ocsetting
    logical(LGP) :: found_rtype
    ! formats
    character(len=*), parameter :: fmtboc = &
      &"(1X,/1X,'BEGIN READING OUTPUT CONTROL FOR STRESS PERIOD ',I0)"
    character(len=*), parameter :: fmteoc = &
      &"(/,1X,'END READING OUTPUT CONTROL FOR STRESS PERIOD ',I0)"
    character(len=*), parameter :: fmtroc = &
      "(1X,/1X,'OUTPUT CONTROL FOR STRESS PERIOD ',I0, &
      &' IS REPEATED USING SETTINGS FROM A PREVIOUS STRESS PERIOD.')"
 
    if (this%input_mempath == '') return
    call mem_setptr(iper, 'IPER', this%input_mempath)
    if (iper /= kper) then
      ! previous output control settings are still active
      write (this%iout, fmtroc) kper
      return
    else
      this%iperoc = iper
      write (this%iout, fmtboc) this%iperoc
    end if
 
    ! Clear io flags
    do ipos = 1, size(this%ocds)
      ocdobjptr => this%ocds(ipos)
      call ocdobjptr%psm%init()
    end do
 
    call mem_setptr(nlist, 'NBOUND', this%input_mempath)
    call mem_setptr(ocactions, 'OCACTION', this%input_mempath)
    call mem_setptr(rtypes, 'RTYPE', this%input_mempath)
    call mem_setptr(ocsettings, 'SETTING', this%input_mempath)
 
    do n = 1, nlist
      ocaction = ocactions(n)
      rtype = rtypes(n)
      ocsetting = ocsettings(n)
 
      found_rtype = .false.
      do ipos = 1, size(this%ocds)
        ocdobjptr => this%ocds(ipos)
        if (rtype == trim(ocdobjptr%cname)) then
          found_rtype = .true.
          call ocdobjptr%psm%set(ocaction, ocsetting, this%iout)
          call ocdobjptr%ocd_rp_check(this%input_fname)
        end if
      end do
      if (.not. found_rtype) then
        call store_error('Input OC period block rtype not found:  "'// &
                         trim(rtype)//'".')
        call store_error_filename(this%input_fname)
      end if
    end do
 
    write (this%iout, fmteoc) this%iperoc

Here is the call graph for this function:

oc_save()

logical function outputcontrolmodule::oc_save	(	class(outputcontroltype)	this,
		character(len=*), intent(in)	cname
	)

Parameters

	this	OutputControlType object
[in]	cname	character string for data name

Definition at line 315 of file OutputControl.f90.

    ! modules
    use tdismodule, only: kstp, endofperiod
    ! dummy
    class(OutputControlType) :: this !< OutputControlType object
    character(len=*), intent(in) :: cname !< character string for data name
    ! local
    integer(I4B) :: ipos
    logical(LGP) :: found
    class(OutputControlDataType), pointer :: ocdobjptr
    !
    oc_save = .false.
    found = .false.
    do ipos = 1, size(this%ocds)
      ocdobjptr => this%ocds(ipos)
      if (cname == trim(ocdobjptr%cname)) then
        found = .true.
        exit
      end if
    end do
    if (found) then
      oc_save = ocdobjptr%psm%should_save(kstp, endofperiod)
    end if

oc_save_unit()

integer(i4b) function outputcontrolmodule::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 367 of file OutputControl.f90.

    ! -- modules
    ! -- return
    integer(I4B) :: oc_save_unit
    ! -- dummy
    class(OutputControlType) :: this !< OutputControlType object
    character(len=*), intent(in) :: cname !< character string for data name
    ! -- local
    integer(I4B) :: ipos
    logical(LGP) :: found
    class(OutputControlDataType), pointer :: ocdobjptr
    !
    oc_save_unit = 0
    found = .false.
    do ipos = 1, size(this%ocds)
      ocdobjptr => this%ocds(ipos)
      if (cname == trim(ocdobjptr%cname)) then
        found = .true.
        exit
      end if
    end do
    if (found) then
      oc_save_unit = ocdobjptr%idataun
    end if

set_ocfile()

subroutine outputcontrolmodule::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 288 of file OutputControl.f90.

    ! modules
    use simmodule, only: store_error, store_error_filename
    ! dummy
    class(OutputControlType) :: this !< OutputControlDataType object
    character(len=*), intent(in) :: cname !< data object cname
    character(len=*), intent(in) :: ocfile !< OC output filename
    integer(I4B), intent(in) :: iout !< Unit number for output
    type(OutputControlDataType), pointer :: ocdobjptr
    integer(I4B) :: ipos
    logical(LGP) :: found
    found = .false.
    do ipos = 1, size(this%ocds)
      ocdobjptr => this%ocds(ipos)
      if (cname == trim(ocdobjptr%cname)) then
        found = .true.
        call ocdobjptr%set_ocfile(ocfile, iout)
      end if
    end do
    if (.not. found) then
      call store_error('OC internal error: oc data type not found for name "'// &
                       trim(cname)//'".')
      call store_error_filename(this%input_fname)
    end if

Here is the call graph for this function:

set_print_flag()

integer(i4b) function outputcontrolmodule::set_print_flag ( class(outputcontroltype)  this, character(len=*), intent(in)  cname, integer(i4b), intent(in)  icnvg, logical, intent(in)  endofperiod  )

private

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 394 of file OutputControl.f90.

    ! -- modules
    use simvariablesmodule, only: isimcontinue
    ! -- return
    integer(I4B) :: iprint_flag
    ! -- dummy
    class(OutputControlType) :: this !< OutputControlType object
    character(len=*), intent(in) :: cname !< character string for data name
    integer(I4B), intent(in) :: icnvg !< convergence flag
    logical, intent(in) :: endofperiod !< end of period logical flag
    ! -- local
    !
    ! -- default is to not print
    iprint_flag = 0
    !
    ! -- if the output control file indicates that cname should be printed
    if (this%oc_print(cname)) iprint_flag = 1
    !
    ! -- if it is not a CONTINUE run, then set to print if not converged
    if (isimcontinue == 0) then
      if (icnvg == 0) iprint_flag = 1
    end if
    !
    ! -- if it's the end of the period, then set flag to print
    if (endofperiod) iprint_flag = 1

source_options()

subroutine outputcontrolmodule::source_options

(

class(outputcontroltype)

this

)

Parameters

this	this instance

Definition at line 228 of file OutputControl.f90.

    ! modules
    use memorymanagerextmodule, only: mem_set_value
    ! dummy
    class(OutputControlType) :: this !< this instance
    type(OutputControlDataType), pointer :: ocdobjptr
    character(len=LINELENGTH) :: budgetfn, budgetcsv
    character(len=LINELENGTH) :: prnfmt, print_format
    logical(LGP) :: found_budcsv, found_budget
    logical(LGP), dimension(4) :: found_format
    integer(I4B), pointer :: columns, width, ndigits
    integer(I4B) :: ipos
 
    found_format = .false.
    allocate (columns)
    allocate (width)
    allocate (ndigits)
 
    call mem_set_value(columns, 'COLUMNS', this%input_mempath, &
                       found_format(1))
    call mem_set_value(width, 'WIDTH', this%input_mempath, &
                       found_format(2))
    call mem_set_value(ndigits, 'DIGITS', this%input_mempath, &
                       found_format(3))
    call mem_set_value(prnfmt, 'FORMAT', this%input_mempath, &
                       found_format(4))
    call mem_set_value(budgetcsv, 'BUDGETCSVFILE', this%input_mempath, &
                       found_budcsv)
    call mem_set_value(budgetfn, 'BUDGETFILE', this%input_mempath, &
                       found_budget)
 
    if (found_budcsv) then
      this%ibudcsv = getunit()
      call openfile(this%ibudcsv, this%iout, budgetcsv, 'CSV', &
                    filstat_opt='REPLACE')
    end if
 
    if (found_budget) then
      call this%set_ocfile('BUDGET', budgetfn, this%iout)
    end if
 
    if (found_format(1) .and. &
        found_format(2) .and. &
        found_format(3) .and. &
        found_format(4)) then
      write (print_format, '(a,i0,a,i0,a,i0,a)') 'COLUMNS ', columns, &
        ' WIDTH ', width, ' DIGITS ', ndigits, ' '//trim(prnfmt)//' '
      do ipos = 1, size(this%ocds)
        ocdobjptr => this%ocds(ipos)
        if (ocdobjptr%cname /= 'BUDGET') then
          call ocdobjptr%set_prnfmt(print_format, 0)
        end if
      end do
    end if
 
    deallocate (columns)
    deallocate (width)
    deallocate (ndigits)

Here is the call graph for this function: