outputcontroldatamodule Module Reference

This module contains the OutputControlDataModule. More...

Data Types
type	outputcontroldatatype
	@ brief OutputControlDataType More...

Functions/Subroutines
subroutine, public	ocd_cr (ocdobj)
	@ brief Create OutputControlDataType More...
subroutine	ocd_rp_check (this, inunit)
	@ brief Check OutputControlDataType object More...
subroutine	ocd_ot (this, ipflg, kstp, endofperiod, iout, iprint_opt, isav_opt)
	@ brief Output data More...
subroutine	ocd_da (this)
	@ brief Deallocate OutputControlDataType More...
subroutine	init_dbl (this, cname, dblvec, dis, cdefpsm, cdeffmp, iout, dnodata)
	@ brief Initialize this OutputControlDataType as double precision data More...
subroutine	init_int (this, cname, intvec, dis, cdefpsm, cdeffmp, iout, inodata)
	@ brief Initialize this OutputControlDataType as integer data More...
subroutine	allocate_scalars (this)
	@ brief Allocate OutputControlDataType members More...
subroutine	set_option (this, linein, inunit, iout)
	@ brief Set options for this object based on an input string More...

Detailed Description

This module defines the OutputControlDataType. This type can be assigned to different model variables, such as head or concentration. The variables are then printed and/or saved in a consistent manner.

Function/Subroutine Documentation

allocate_scalars()

subroutine outputcontroldatamodule::allocate_scalars ( class(outputcontroldatatype)  this )

private

Allocate and initialize member variables

Parameters

this	OutputControlDataType object

Definition at line 261 of file OutputControlData.f90.

    ! -- modules
    use constantsmodule, only: dzero
    ! -- dummy
    class(OutputControlDataType) :: this !< OutputControlDataType object
    !
    allocate (this%cname)
    allocate (this%cdatafmp)
    allocate (this%idataun)
    allocate (this%editdesc)
    allocate (this%nvaluesp)
    allocate (this%nwidthp)
    allocate (this%dnodata)
    allocate (this%inodata)
    allocate (this%psmobj)
    !
    this%cname = ''
    this%cdatafmp = ''
    this%idataun = 0
    this%editdesc = ''
    this%nvaluesp = 0
    this%nwidthp = 0
    this%dnodata = dzero
    this%inodata = 0
    !
    ! -- return
    return

init_dbl()

subroutine outputcontroldatamodule::init_dbl	(	class(outputcontroldatatype)	this,
		character(len=*), intent(in)	cname,
		real(dp), dimension(:), intent(in), pointer, contiguous	dblvec,
		class(disbasetype), intent(in), pointer	dis,
		character(len=*), intent(in)	cdefpsm,
		character(len=*), intent(in)	cdeffmp,
		integer(i4b), intent(in)	iout,
		real(dp), intent(in)	dnodata
	)

Initialize this object as a double precision data type

Parameters

	this	OutputControlDataType object
[in]	cname	Name of variable
[in]	dblvec	Data array that will be managed by this object
[in]	dis	Discretization package
[in]	cdefpsm	String for defining the print/save manager
[in]	cdeffmp	String for print format
[in]	iout	Unit number for output
[in]	dnodata	No data value

Definition at line 200 of file OutputControlData.f90.

    ! -- dummy
    class(OutputControlDataType) :: this !< OutputControlDataType object
    character(len=*), intent(in) :: cname !< Name of variable
    real(DP), dimension(:), pointer, contiguous, intent(in) :: dblvec !< Data array that will be managed by this object
    class(DisBaseType), pointer, intent(in) :: dis !< Discretization package
    character(len=*), intent(in) :: cdefpsm !< String for defining the print/save manager
    character(len=*), intent(in) :: cdeffmp !< String for print format
    integer(I4B), intent(in) :: iout !< Unit number for output
    real(DP), intent(in) :: dnodata !< No data value
    !
    this%cname = cname
    this%dblvec => dblvec
    this%dis => dis
    this%dnodata = dnodata
    call this%psmobj%init()
    if (cdefpsm /= '') call this%psmobj%rp(cdefpsm, iout)
    call print_format(cdeffmp, this%cdatafmp, &
                      this%editdesc, this%nvaluesp, this%nwidthp, 0)
    !
    ! -- return
    return

Here is the call graph for this function:

init_int()

subroutine outputcontroldatamodule::init_int ( class(outputcontroldatatype)  this, character(len=*), intent(in)  cname, integer(i4b), dimension(:), intent(in), pointer, contiguous  intvec, class(disbasetype), intent(in), pointer  dis, character(len=*), intent(in)  cdefpsm, character(len=*), intent(in)  cdeffmp, integer(i4b), intent(in)  iout, integer(i4b), intent(in)  inodata  )

private

Initialize this object as an integer data type

Parameters

	this	OutputControlDataType object
[in]	cname	Name of variable
[in]	intvec	Data array that will be managed by this object
[in]	dis	Discretization package
[in]	cdefpsm	String for defining the print/save manager
[in]	cdeffmp	String for print format
[in]	iout	Unit number for output
[in]	inodata	No data value

Definition at line 230 of file OutputControlData.f90.

    ! -- dummy
    class(OutputControlDataType) :: this !< OutputControlDataType object
    character(len=*), intent(in) :: cname !< Name of variable
    integer(I4B), dimension(:), pointer, contiguous, intent(in) :: intvec !< Data array that will be managed by this object
    class(DisBaseType), pointer, intent(in) :: dis !< Discretization package
    character(len=*), intent(in) :: cdefpsm !< String for defining the print/save manager
    character(len=*), intent(in) :: cdeffmp !< String for print format
    integer(I4B), intent(in) :: iout !< Unit number for output
    integer(I4B), intent(in) :: inodata !< No data value
    !
    this%cname = cname
    this%intvec => intvec
    this%dis => dis
    this%inodata = inodata
    this%editdesc = 'I'
    call this%psmobj%init()
    if (cdefpsm /= '') call this%psmobj%rp(cdefpsm, iout)
    call print_format(cdeffmp, this%cdatafmp, this%editdesc, this%nvaluesp, &
                      this%nwidthp, 0)
    !
    ! -- return
    return

Here is the call graph for this function:

ocd_cr()

subroutine, public outputcontroldatamodule::ocd_cr

(

type(outputcontroldatatype), pointer

ocdobj

)

Create by allocating a new OutputControlDataType object

Parameters

ocdobj

OutputControlDataType object

Definition at line 55 of file OutputControlData.f90.

    ! -- dummy
    type(OutputControlDataType), pointer :: ocdobj !< OutputControlDataType object
    !
    ! -- Create the object
    allocate (ocdobj)
    !
    ! -- Allocate scalars
    call ocdobj%allocate_scalars()
    !
    ! -- Return
    return

Here is the caller graph for this function:

ocd_da()

subroutine outputcontroldatamodule::ocd_da ( class(outputcontroldatatype)  this )

private

Deallocate members of this type

Definition at line 174 of file OutputControlData.f90.

    ! -- modules
    use constantsmodule, only: dzero
    ! -- dummy
    class(OutputControlDataType) :: this
    !
    ! -- deallocate
    deallocate (this%cname)
    deallocate (this%cdatafmp)
    deallocate (this%idataun)
    deallocate (this%editdesc)
    deallocate (this%nvaluesp)
    deallocate (this%nwidthp)
    deallocate (this%dnodata)
    deallocate (this%inodata)
    deallocate (this%psmobj)
    !
    ! -- return
    return

ocd_ot()

subroutine outputcontroldatamodule::ocd_ot	(	class(outputcontroldatatype)	this,
		integer(i4b), intent(inout)	ipflg,
		integer(i4b), intent(in)	kstp,
		logical(lgp), intent(in)	endofperiod,
		integer(i4b), intent(in)	iout,
		integer(i4b), intent(in), optional	iprint_opt,
		integer(i4b), intent(in), optional	isav_opt
	)

Depending on the settings, print the data to a listing file and/or save the data to a binary file.

Parameters

	this	OutputControlDataType object
[in,out]	ipflg	Flag indicating if something was printed
[in]	kstp	Current time step
[in]	endofperiod	End of period logical flag
[in]	iout	Unit number for output
[in]	iprint_opt	Optional print flag override
[in]	isav_opt	Optional save flag override

Definition at line 112 of file OutputControlData.f90.

    ! -- dummy
    class(OutputControlDataType) :: this !< OutputControlDataType object
    integer(I4B), intent(inout) :: ipflg !< Flag indicating if something was printed
    integer(I4B), intent(in) :: kstp !< Current time step
    logical(LGP), intent(in) :: endofperiod !< End of period logical flag
    integer(I4B), intent(in) :: iout !< Unit number for output
    integer(I4B), optional, intent(in) :: iprint_opt !< Optional print flag override
    integer(I4B), optional, intent(in) :: isav_opt !< Optional save flag override
    ! -- local
    integer(I4B) :: iprint
    integer(I4B) :: idataun
    !
    ! -- initialize
    iprint = 0
    ipflg = 0
    idataun = 0
    !
    ! -- Determine whether or not to print the array.  The present
    !    check allows a caller to override the print/save manager
    if (present(iprint_opt)) then
      if (iprint_opt /= 0) then
        iprint = 1
        ipflg = 1
      end if
    else
      if (this%psmobj%kstp_to_print(kstp, endofperiod)) then
        iprint = 1
        ipflg = 1
      end if
    end if
    !
    ! -- determine whether or not to save the array to a file
    if (present(isav_opt)) then
      if (isav_opt /= 0) then
        idataun = this%idataun
      end if
    else
      if (this%psmobj%kstp_to_save(kstp, endofperiod)) idataun = this%idataun
    end if
    !
    ! -- Record double precision array
    if (associated(this%dblvec)) &
      call this%dis%record_array(this%dblvec, iout, iprint, idataun, &
                                 this%cname, this%cdatafmp, this%nvaluesp, &
                                 this%nwidthp, this%editdesc, this%dnodata)
    !
    ! -- Record integer array (not supported yet)
    !if(associated(this%intvec)) &
    !call this%dis%record_array(this%intvec, iout, iprint, idataun, &
    !                               this%cname, this%cdatafmp, this%nvaluesp, &
    !                               this%nwidthp, this%editdesc, this%inodata)
    !
    ! -- Return
    return

ocd_rp_check()

subroutine outputcontroldatamodule::ocd_rp_check ( class(outputcontroldatatype)  this, integer(i4b), intent(in)  inunit  )

private

Perform a consistency check

Parameters

	this	OutputControlDataType object
[in]	inunit	Unit number for input

Definition at line 74 of file OutputControlData.f90.

    ! -- modules
    use constantsmodule, only: linelength
    use simmodule, only: store_error, count_errors, store_error_unit
    ! -- dummy
    class(OutputControlDataType) :: this !< OutputControlDataType object
    integer(I4B), intent(in) :: inunit !< Unit number for input
    ! -- locals
    character(len=LINELENGTH) :: errmsg
    ! -- formats
    character(len=*), parameter :: fmtocsaveerr = &
      "(1X,'REQUESTING TO SAVE ',A,' BUT ',A,' SAVE FILE NOT SPECIFIED. ', &
       &A,' SAVE FILE MUST BE SPECIFIED IN OUTPUT CONTROL OPTIONS.')"
    !
    ! -- Check to make sure save file was specified
    if (this%psmobj%save_detected) then
      if (this%idataun == 0) then
        write (errmsg, fmtocsaveerr) trim(adjustl(this%cname)), &
          trim(adjustl(this%cname)), &
          trim(adjustl(this%cname))
        call store_error(errmsg)
      end if
    end if
    !
    if (count_errors() > 0) then
      call store_error_unit(inunit)
    end if
    !
    ! -- return
    return

Here is the call graph for this function:

set_option()

subroutine outputcontroldatamodule::set_option	(	class(outputcontroldatatype)	this,
		character(len=*), intent(in)	linein,
		integer(i4b), intent(in)	inunit,
		integer(i4b), intent(in)	iout
	)

Set FILEOUT and PRINT_FORMAT options for this object.

Parameters

	this	OutputControlDataType object
[in]	linein	Character string with options
[in]	inunit	Unit number for input
[in]	iout	Unit number for output

Definition at line 295 of file OutputControlData.f90.

    ! -- modules
    use constantsmodule, only: mnormal
    use openspecmodule, only: access, form
    use inputoutputmodule, only: urword, getunit, openfile
    use simmodule, only: store_error, store_error_unit, count_errors
    ! -- dummy
    class(OutputControlDataType) :: this !< OutputControlDataType object
    character(len=*), intent(in) :: linein !< Character string with options
    integer(I4B), intent(in) :: inunit !< Unit number for input
    integer(I4B), intent(in) :: iout !< Unit number for output
    ! -- local
    character(len=len(linein)) :: line
    integer(I4B) :: lloc, istart, istop, ival
    real(DP) :: rval
    ! -- format
    character(len=*), parameter :: fmtocsave = &
      "(4X,A,' INFORMATION WILL BE WRITTEN TO:', &
      &/,6X,'UNIT NUMBER: ', I0,/,6X, 'FILE NAME: ', A)"
    !
    line(:) = linein(:)
    lloc = 1
    call urword(line, lloc, istart, istop, 1, ival, rval, 0, 0)
    select case (line(istart:istop))
    case ('FILEOUT')
      call urword(line, lloc, istart, istop, 0, ival, rval, 0, 0)
      this%idataun = getunit()
      write (iout, fmtocsave) trim(adjustl(this%cname)), this%idataun, &
        line(istart:istop)
      call openfile(this%idataun, iout, line(istart:istop), 'DATA(BINARY)', &
                    form, access, 'REPLACE', mnormal)
    case ('PRINT_FORMAT')
      call urword(line, lloc, istart, istop, 1, ival, rval, 0, 0)
      call print_format(line(istart:), this%cdatafmp, this%editdesc, &
                        this%nvaluesp, this%nwidthp, inunit)
    case default
      call store_error('Looking for FILEOUT or PRINT_FORMAT.  Found:')
      call store_error(trim(adjustl(line)))
      call store_error_unit(inunit)
    end select
    !
    ! -- return
    return

Here is the call graph for this function: