obsoutputlistmodule Module Reference

This module defines the derived type ObsOutputListType. More...

Data Types
type	obsoutputlisttype

Functions/Subroutines
subroutine	resetallobsemptylines (this)
	@ brief Reset empty line logical for all observations More...
integer(i4b) function	count (this)
	@ brief Count the number of ObsOutputType objects More...
logical function	containsfile (this, fname)
	@ brief Determine if a file name is in the list of ObsOutputType objects More...
subroutine	add (this, fname, nunit)
	@ brief Add a ObsOutputType object to the list More...
subroutine	writeallobslinereturns (this)
	@ brief Write line returns for all ObsOutputListType More...
type(obsoutputtype) function, pointer	get (this, indx)
	@ brief Get an item from a ObsOutputListType More...
subroutine	clear (this)
	@ brief Clear a ObsOutputListType More...
subroutine	deallocobsoutputlist (this)
	@ brief Deallocate a ObsOutputListType More...

Detailed Description

This module contains a list of ObsOutputType objects and methods needed for coordinating between an ObsType object and its ObsOutputType objects. Like ObsOutputType, ObsOutputListType is needed only for processing continuous observations.

Function/Subroutine Documentation

add()

subroutine obsoutputlistmodule::add ( class(obsoutputlisttype), intent(inout)  this, character(len=*), intent(in)  fname, integer(i4b), intent(in)  nunit  )

private

Subroutine to add a new ObsOutputType object to the ObsOutputList and assign ObsOutputType members.

Parameters

[in]	fname	observation output file name
[in]	nunit	observation output unit number

Definition at line 113 of file ObsOutputList.f90.

    ! -- dummy
    class(ObsOutputListType), intent(inout) :: this
    character(len=*), intent(in) :: fname !< observation output file name
    integer(I4B), intent(in) :: nunit !< observation output unit number
    ! -- local
    type(ObsOutputType), pointer :: obsOutput => null()
    !
    call constructobsoutput(obsoutput, fname, nunit)
    call addobsoutputtolist(this%ObsOutputs, obsoutput)
    !
    ! -- return
    return

Here is the call graph for this function:

clear()

subroutine obsoutputlistmodule::clear ( class(obsoutputlisttype), intent(inout)  this )

private

Subroutine to clear a ObsOutputListType list.

Definition at line 176 of file ObsOutputList.f90.

    ! -- dummy
    class(ObsOutputListType), intent(inout) :: this
    !
    call this%ObsOutputs%Clear()
    !
    ! -- return
    return

containsfile()

logical function obsoutputlistmodule::containsfile ( class(obsoutputlisttype), intent(inout)  this, character(len=*), intent(in)  fname  )

private

Function to determine if a file name is in the list of ObsOutptType objects.

Parameters

[in]

fname

observation output file name

Definition at line 85 of file ObsOutputList.f90.

    ! -- dummy
    class(ObsOutputListType), intent(inout) :: this
    character(len=*), intent(in) :: fname !< observation output file name
    ! -- local
    type(ObsOutputType), pointer :: obsOutput => null()
    integer(I4B) :: i, n
    !
    containsfile = .false.
    n = this%Count()
    loop1: do i = 1, n
      obsoutput => this%Get(i)
      if (same_word(obsoutput%filename, fname)) then
        containsfile = .true.
        exit loop1
      end if
    end do loop1
    !
    ! -- return
    return

Here is the call graph for this function:

count()

integer(i4b) function obsoutputlistmodule::count ( class(obsoutputlisttype), intent(inout)  this )

private

Subroutine to return the number of ObsOutputType objects in the list.

Returns

number of ObsOutputType objects

Definition at line 67 of file ObsOutputList.f90.

    ! -- return
    integer(I4B) :: count !< number of ObsOutputType objects
    ! -- dummy
    class(ObsOutputListType), intent(inout) :: this
    !
    count = this%ObsOutputs%Count()
    !
    ! -- return
    return

deallocobsoutputlist()

subroutine obsoutputlistmodule::deallocobsoutputlist ( class(obsoutputlisttype), intent(inout)  this )

private

Subroutine to deallocate a ObsOutputListType list.

Definition at line 191 of file ObsOutputList.f90.

    ! -- dummy
    class(ObsOutputListType), intent(inout) :: this
    ! -- local
    integer :: i, n
    type(ObsOutputType), pointer :: obsoutput => null()
    !
    n = this%Count()
    do i = 1, n
      obsoutput => getobsoutputfromlist(this%ObsOutputs, i)
      !call obsoutput%DeallocObsOutput()
    end do
    !
    call this%ObsOutputs%Clear(.true.)
    !
    ! -- return
    return

Here is the call graph for this function:

get()

type(obsoutputtype) function, pointer obsoutputlistmodule::get ( class(obsoutputlisttype), intent(inout)  this, integer(i4b), intent(in)  indx  )

private

Function to get a ObsOutputType from a ObsOutputListType list.

Parameters

[in]

indx

index for ObsOutputType object

Definition at line 158 of file ObsOutputList.f90.

    ! -- dummy
    class(ObsOutputListType), intent(inout) :: this
    integer(I4B), intent(in) :: indx !< index for ObsOutputType object
    ! result
    type(ObsOutputType), pointer :: obsOutput
    !
    obsoutput => getobsoutputfromlist(this%ObsOutputs, indx)
    !
    ! -- return
    return

Here is the call graph for this function:

resetallobsemptylines()

subroutine obsoutputlistmodule::resetallobsemptylines ( class(obsoutputlisttype), intent(inout)  this )

private

Subroutine to reset the empty line logical for all ObsOutputType objects in the list.

Definition at line 45 of file ObsOutputList.f90.

    ! -- dummy
    class(ObsOutputListType), intent(inout) :: this
    ! -- local
    integer(I4B) :: i, num
    type(ObsOutputType), pointer :: obsOutput => null()
    !
    num = this%Count()
    do i = 1, num
      obsoutput => this%Get(i)
      call obsoutput%ResetObsEmptyLine()
    end do
    !
    ! -- return
    return

writeallobslinereturns()

subroutine obsoutputlistmodule::writeallobslinereturns ( class(obsoutputlisttype), intent(inout)  this )

private

Subroutine to write line returns for a time step for all observation output files in a ObsOutputListType.

Definition at line 134 of file ObsOutputList.f90.

    ! -- dummy
    class(ObsOutputListType), intent(inout) :: this
    ! -- local
    type(ObsOutputType), pointer :: obsOutput => null()
    integer(I4B) :: i, num
    !
    num = this%Count()
    do i = 1, num
      obsoutput => this%Get(i)
      if (obsoutput%FormattedOutput) then
        call obsoutput%WriteObsLineReturn()
      end if
    end do
    !
    ! -- return
    return