outputcontroldatamodule Module Reference

Output control data module.

Data Types
type	outputcontroldatatype
	Output control data type. More...

Functions/Subroutines
subroutine, public	ocd_cr (ocdobj)
	@ brief Create a new output control data type. More...
subroutine	ocd_rp_check (this, inunit)
	@ brief Check the output control data type for consistency. More...
subroutine	ocd_ot (this, ipflg, kstp, endofperiod, iout, iprint_opt, isav_opt)
	Write to list file and/or save to binary file, depending on settings. More...
subroutine	ocd_da (this)
	Deallocate the output control data type. More...
subroutine	init_dbl (this, cname, dblvec, dis, cdefpsm, cdeffmp, iout, dnodata)
	Initialize the output control data type for double precision data. More...
subroutine	init_int (this, cname, intvec, dis, cdefpsm, cdeffmp, iout, inodata)
	@ brief Initialize the output control data type for integer data. More...
subroutine	allocate (this)
	@ brief Allocate scalar variables More...
subroutine	set_option (this, linein, inunit, iout)
	@ brief Set FILEOUT and PRINT_FORMAT based on an input string. More...

Function/Subroutine Documentation

allocate()

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

private

Parameters

this	OutputControlDataType object

Definition at line 194 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)
 
    this%cname = ''
    this%cdatafmp = ''
    this%idataun = 0
    this%editdesc = ''
    this%nvaluesp = 0
    this%nwidthp = 0
    this%dnodata = dzero
    this%inodata = 0
    this%psm => create_psm()

Here is the call graph for this function:

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  )

private

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 151 of file OutputControlData.f90.

    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%dbldata => dblvec
    this%dis => dis
    this%dnodata = dnodata
    if (cdefpsm /= '') call this%psm%read(cdefpsm, iout)
    call print_format(cdeffmp, this%cdatafmp, &
                      this%editdesc, this%nvaluesp, this%nwidthp, 0)

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

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 172 of file OutputControlData.f90.

    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%intdata => intvec
    this%dis => dis
    this%inodata = inodata
    this%editdesc = 'I'
    if (cdefpsm /= '') call this%psm%read(cdefpsm, iout)
    call print_format(cdeffmp, this%cdatafmp, this%editdesc, this%nvaluesp, &
                      this%nwidthp, 0)

Here is the call graph for this function:

ocd_cr()

subroutine, public outputcontroldatamodule::ocd_cr

(

type(outputcontroldatatype), pointer

ocdobj

)

Parameters

ocdobj

this instance

Definition at line 45 of file OutputControlData.f90.

    type(OutputControlDataType), pointer :: ocdobj !< this instance
    allocate (ocdobj)
    call ocdobj%allocate_scalars()

Here is the caller graph for this function:

ocd_da()

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

private

Definition at line 137 of file OutputControlData.f90.

    class(OutputControlDataType) :: this
 
    deallocate (this%cname)
    deallocate (this%cdatafmp)
    deallocate (this%idataun)
    deallocate (this%editdesc)
    deallocate (this%nvaluesp)
    deallocate (this%nwidthp)
    deallocate (this%dnodata)
    deallocate (this%inodata)

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
	)

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 82 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%psm%should_print(kstp, endofperiod)) then
        iprint = 1
        ipflg = 1
      end if
    end if
 
    ! Determine whether 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%psm%should_save(kstp, endofperiod)) idataun = this%idataun
    end if
 
    ! Record double precision array
    if (associated(this%dbldata)) &
      call this%dis%record_array(this%dbldata, 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)

ocd_rp_check()

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

private

Parameters

	this	this instance
[in]	inunit	output unit number

Definition at line 52 of file OutputControlData.f90.

    ! modules
    use constantsmodule, only: linelength
    use simmodule, only: store_error, count_errors, store_error_unit
    ! dummy
    class(OutputControlDataType) :: this !< this instance
    integer(I4B), intent(in) :: inunit !< output unit number
    ! 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.')"
 
    ! If saving is enabled, make sure an output file was specified
    if (this%psm%save_steps%any()) 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

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
	)

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

Here is the call graph for this function: