obsoutputmodule Module Reference

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

Data Types
type	obsoutputtype

Functions/Subroutines
subroutine	resetobsemptyline (this)
	@ brief Reset empty line logical More...
subroutine	writeobslinereturn (this)
	@ brief Write line return for observation More...
type(obsoutputtype) function, pointer	castasobsoutputtype (obj)
	@ brief Cast as ObsOutputType More...
subroutine, public	constructobsoutput (newObsOutput, fname, nunit)
	@ brief Construct and assign ObsOutputType object More...
subroutine, public	addobsoutputtolist (list, obsOutput)
	@ brief Add observation output to a list More...
type(obsoutputtype) function, pointer, public	getobsoutputfromlist (list, idx)
	@ brief Get observation output from a list More...

Detailed Description

This module contains information and methods needed for writing a line of simulated values for observations to an output file. Each block of type continuous in an observation file is associated with an ObsOutputType object. However, the methods are needed only for continuous observations.

Function/Subroutine Documentation

addobsoutputtolist()

subroutine, public obsoutputmodule::addobsoutputtolist	(	type(listtype), intent(inout)	list,
		type(obsoutputtype), intent(inout), pointer	obsOutput
	)

Subroutine to add observation output to a observation list.

Parameters

[in,out]	list	observation list
[in,out]	obsoutput	observation output

Definition at line 124 of file ObsOutput.f90.

    ! -- dummy
    type(ListType), intent(inout) :: list !< observation list
    type(ObsOutputType), pointer, intent(inout) :: obsOutput !< observation output
    ! -- local
    class(*), pointer :: obj
    !
    obj => obsoutput
    call list%Add(obj)
    !
    ! -- return
    return

Here is the caller graph for this function:

castasobsoutputtype()

type(obsoutputtype) function, pointer obsoutputmodule::castasobsoutputtype ( class(*), intent(inout), pointer  obj )

private

Cast an object as an ObsOutputType.

Parameters

[in,out]

obj

input object

Returns

ObsOutputType

Definition at line 80 of file ObsOutput.f90.

    ! -- dummy
    class(*), pointer, intent(inout) :: obj !< input object
    type(ObsOutputType), pointer :: res !< ObsOutputType
    !
    res => null()
    if (.not. associated(obj)) return
    !
    select type (obj)
    type is (obsoutputtype)
      res => obj
    class default
      continue
    end select
    !
    ! -- return
    return

Here is the caller graph for this function:

constructobsoutput()

subroutine, public obsoutputmodule::constructobsoutput	(	type(obsoutputtype), intent(out), pointer	newObsOutput,
		character(len=*), intent(in)	fname,
		integer(i4b), intent(in)	nunit
	)

Subroutine to construct an ObsOutputType object and assign the observation output file name and unit number.

Parameters

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

Definition at line 105 of file ObsOutput.f90.

    ! -- dummy
    type(ObsOutputType), pointer, intent(out) :: newObsOutput
    character(len=*), intent(in) :: fname !< observation output file name
    integer(I4B), intent(in) :: nunit !< observation output unit number
    !
    allocate (newobsoutput)
    newobsoutput%filename = fname
    newobsoutput%nunit = nunit
    !
    ! -- return
    return

Here is the caller graph for this function:

getobsoutputfromlist()

type(obsoutputtype) function, pointer, public obsoutputmodule::getobsoutputfromlist	(	type(listtype), intent(inout)	list,
		integer(i4b), intent(in)	idx
	)

Subroutine to get observation output from a observation list.

Parameters

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

Returns

observation output

Definition at line 143 of file ObsOutput.f90.

    implicit none
    ! -- dummy
    type(ListType), intent(inout) :: list !< observation list
    integer(I4B), intent(in) :: idx !< observation index
    type(ObsOutputType), pointer :: res !< observation output
    ! -- local
    class(*), pointer :: obj
    !
    obj => list%GetItem(idx)
    res => castasobsoutputtype(obj)
    !
    ! --return
    return

Here is the call graph for this function:

Here is the caller graph for this function:

resetobsemptyline()

subroutine obsoutputmodule::resetobsemptyline ( class(obsoutputtype), intent(inout)  this )

private

Subroutine to reset the empty line logical.

Definition at line 46 of file ObsOutput.f90.

    ! -- dummy
    class(ObsOutputType), intent(inout) :: this
    !
    this%empty_line = .true.
    !
    ! -- return
    return

writeobslinereturn()

subroutine obsoutputmodule::writeobslinereturn ( class(obsoutputtype), intent(inout)  this )

private

Subroutine to write a line return for a time step in an observation output file.

Definition at line 62 of file ObsOutput.f90.

    ! -- dummy
    class(ObsOutputType), intent(inout) :: this
    ! -- write a line return to end of observation output line
    !    for this totim
    write (this%nunit, '(a)', advance='YES') ''
    !
    ! --return
    return