observemodule Module Reference

This module contains the derived types ObserveType and ObsDataType. More...

Data Types
type	observetype
type	obsdatatype
interface	processidsub
	@ brief Process user-provided IDstring More...

Functions/Subroutines
subroutine	resetcurrentvalue (this)
	@ brief Reset current observation value
subroutine	writeto (this, obstab, btagfound, fnamein)
	@ brief Write observation input data
subroutine	resetobsindex (this)
	@ brief Reset a observation index
subroutine	addobsindex (this, indx)
	@ brief Add a observation index
subroutine	da (this)
	@ brief Deallocate a observation
subroutine, public	constructobservation (newobservation, defline, numunit, formatted, indx, obsdata, inunit)
	@ brief Construct a new ObserveType
type(observetype) function, pointer	castasobservetype (obj)
	@ brief Cast a object as a ObserveType
subroutine, public	addobstolist (list, obs)
	@ brief Add a ObserveType to a list
type(observetype) function, pointer, public	getobsfromlist (list, idx)
	@ brief Get an ObserveType from a list

Detailed Description

This module contains the derived types ObserveType and ObsDataType.

• ObserveType – is designed to contain all information and functionality needed for one observation. ObserveType contains a pointer to an ObsDataType object.
• ObsDataType – is for storing package ID, observation type, and a pointer to a subroutine that will be called to process the IDstring provided in Obs input. The ProcessIdPtr member of ObsDataType requires a pointer to an ObserveType object.

Function/Subroutine Documentation

addobsindex()

subroutine observemodule::addobsindex ( class(observetype), intent(inout) this, integer(i4b), intent(in) indx )

private

Subroutine to add the observation index to the observation index array (indxbnds). The observation index count (indxbnds_count) is also incremented by one and the observation index array is expanded, if necessary.

Parameters

[in]

indx

observation index

Definition at line 192 of file Observe.f90.

    ! -- dummy
    class(ObserveType), intent(inout) :: this
    integer(I4B), intent(in) :: indx !< observation index
    !
    ! -- Increment the index count
    this%indxbnds_count = this%indxbnds_count + 1
    !
    ! -- Expand the observation index array, if necessary
    call expandarraywrapper(this%indxbnds_count, this%indxbnds, loginc=.true.)
    !
    ! -- add index to observation index
    this%indxbnds(this%indxbnds_count) = indx

addobstolist()

subroutine, public observemodule::addobstolist	(	type(listtype), intent(inout)	list,
		type(observetype), intent(inout), pointer	obs )

Subroutine to add a ObserveType to a list.

Parameters

[in,out]	list	ObserveType list
[in,out]	obs	ObserveType

Definition at line 318 of file Observe.f90.

    ! -- dummy
    type(ListType), intent(inout) :: list !< ObserveType list
    type(ObserveType), pointer, intent(inout) :: obs !< ObserveType
    ! -- local
    class(*), pointer :: obj
    !
    obj => obs
    call list%Add(obj)

Here is the caller graph for this function:

castasobservetype()

type(observetype) function, pointer observemodule::castasobservetype ( class(*), intent(inout), pointer obj )

private

Function to cast an object as a ObserveType object.

Parameters

[in,out]

obj

object

Returns

returned ObserveType object

Definition at line 298 of file Observe.f90.

    ! -- dummy
    class(*), pointer, intent(inout) :: obj !< object
    ! -- return
    type(ObserveType), pointer :: res !< returned ObserveType object
    !
    res => null()
    if (.not. associated(obj)) return
    !
    select type (obj)
    type is (observetype)
      res => obj
    end select

Here is the caller graph for this function:

constructobservation()

subroutine, public observemodule::constructobservation	(	type(observetype), pointer	newobservation,
		character(len=*), intent(in)	defline,
		integer(i4b), intent(in)	numunit,
		logical, intent(in)	formatted,
		integer(i4b), intent(in)	indx,
		type(obsdatatype), dimension(:), intent(in), pointer	obsdata,
		integer(i4b), intent(in)	inunit )

Subroutine to construct and return an ObserveType object based on the contents of defLine.

Parameters

	newobservation	new ObserveType
[in]	defline	string with observation data
[in]	numunit	Output unit number
[in]	formatted	logical indicating if formatted output will be written
[in]	indx	Index in ObsOutput array
[in]	obsdata	obsData type
[in]	inunit	observation input file unit

Definition at line 228 of file Observe.f90.

    ! -- dummy variables
    type(ObserveType), pointer :: newObservation !< new ObserveType
    character(len=*), intent(in) :: defLine !< string with observation data
    integer(I4B), intent(in) :: numunit !< Output unit number
    logical, intent(in) :: formatted !< logical indicating if formatted output will be written
    integer(I4B), intent(in) :: indx !< Index in ObsOutput array
    type(ObsDataType), dimension(:), pointer, intent(in) :: obsData !< obsData type
    integer(I4B), intent(in) :: inunit !< observation input file unit
    ! -- local
    real(DP) :: r
    integer(I4B) :: i
    integer(I4B) :: icol
    integer(I4B) :: iout
    integer(I4B) :: istart
    integer(I4B) :: istop
    integer(I4B) :: n
    !
    ! -- initialize
    iout = 0
    icol = 1
    !
    ! -- Allocate an ObserveType object.
    allocate (newobservation)
    allocate (newobservation%indxbnds(0))
    !
    ! -- Set indxbnds_count to 0
    newobservation%indxbnds_count = 0
    !
    ! -- Define the contents of the ObservationSingleType object based on the
    !    contents of defLine.
    !
    ! -- Get observation name and store it
    call urword(defline, icol, istart, istop, 1, n, r, iout, inunit)
    newobservation%Name = defline(istart:istop)
    !
    ! -- Get observation type, convert it to uppercase, and store it.
    call urword(defline, icol, istart, istop, 1, n, r, iout, inunit)
    newobservation%ObsTypeId = defline(istart:istop)
    !
    ! -- Look up package ID for this observation type and store it
    do i = 1, maxobstypes
      if (obsdata(i)%ObsTypeID == newobservation%ObsTypeId) then
        newobservation%obsDatum => obsdata(i)
        exit
      elseif (obsdata(i)%ObsTypeID == '') then
        exit
      end if
    end do
    !
    ! -- Remaining text is ID [and ID2]; store the remainder of the string
    istart = istop + 1
    istop = len_trim(defline)
    if (istart > istop) then
      istart = istop
    end if
    newobservation%IDstring = defline(istart:istop)
    !
    ! Store UnitNumber, FormattedOutput, and IndxObsOutput
    newobservation%UnitNumber = numunit
    newobservation%FormattedOutput = formatted
    newobservation%IndxObsOutput = indx

Here is the call graph for this function:

Here is the caller graph for this function:

da()

subroutine observemodule::da ( class(observetype), intent(inout) this )

private

Subroutine to deallocated a observation (ObserveType).

Definition at line 212 of file Observe.f90.

    ! -- dummy
    class(ObserveType), intent(inout) :: this
    if (allocated(this%indxbnds)) then
      deallocate (this%indxbnds)
    end if

getobsfromlist()

type(observetype) function, pointer, public observemodule::getobsfromlist	(	type(listtype), intent(inout)	list,
		integer(i4b), intent(in)	idx )

Function to get an ObserveType from a list.

Parameters

[in,out]	list	ObserveType list
[in]	idx	ObserveType list index

Returns

returned ObserveType

Definition at line 334 of file Observe.f90.

    ! -- dummy
    type(ListType), intent(inout) :: list !< ObserveType list
    integer(I4B), intent(in) :: idx !< ObserveType list index
    ! -- return
    type(ObserveType), pointer :: res !< returned ObserveType
    ! -- local
    class(*), pointer :: obj
    !
    obj => list%GetItem(idx)
    res => castasobservetype(obj)

Here is the call graph for this function:

Here is the caller graph for this function:

resetcurrentvalue()

subroutine observemodule::resetcurrentvalue ( class(observetype), intent(inout) this )

private

Subroutine to reset the current observation value.

Definition at line 117 of file Observe.f90.

    ! -- dummy
    class(ObserveType), intent(inout) :: this
    !
    ! -- Reset current value to zero.
    this%CurrentTimeStepEndValue = dzero

resetobsindex()

subroutine observemodule::resetobsindex ( class(observetype), intent(inout) this )

private

Subroutine to reset the observation index count and array.

Definition at line 168 of file Observe.f90.

    ! -- dummy
    class(ObserveType), intent(inout) :: this
    !
    ! -- Reset the index count
    this%indxbnds_count = 0
    !
    ! -- Deallocate observation index array, if necessary
    if (allocated(this%indxbnds)) then
      deallocate (this%indxbnds)
    end if
    !
    ! -- Allocate observation index array to size 0
    allocate (this%indxbnds(0))

writeto()

subroutine observemodule::writeto ( class(observetype), intent(inout) this, type(tabletype), intent(inout) obstab, character(len=*), intent(in) btagfound, character(len=*), intent(in) fnamein )

private

Subroutine to write observation input data to a table in the model list file.

Parameters

[in,out]	obstab	observation table
[in]	btagfound	logical indicating if boundname was found
[in]	fnamein	observation input file name

Definition at line 131 of file Observe.f90.

    ! -- dummy
    class(ObserveType), intent(inout) :: this
    type(TableType), intent(inout) :: obstab !< observation table
    character(len=*), intent(in) :: btagfound !< logical indicating if boundname was found
    character(len=*), intent(in) :: fnamein !< observation input file name
    ! -- local
    character(len=12) :: tag
    character(len=80) :: fnameout
    !
    ! -- write btagfound to tag
    if (len_trim(btagfound) > 12) then
      tag = btagfound(1:12)
    else
      write (tag, '(a12)') btagfound
    end if
    !
    ! -- write fnamein to fnameout
    if (len_trim(fnamein) > 80) then
      fnameout = fnamein(1:80)
    else
      write (fnameout, '(a80)') fnamein
    end if
    !
    ! -- write data to observation table
    call obstab%add_term(this%Name)
    call obstab%add_term(tag//trim(this%ObsTypeId))
    call obstab%add_term('ALL TIMES')
    call obstab%add_term('"'//trim(this%IDstring)//'"')
    call obstab%add_term(fnameout)