MODFLOW 6 version 6.9.0.dev0
USGS Modular Hydrologic Model
Loading...
Searching...
No Matches
observemodule::observetype Type Reference
Collaboration diagram for observemodule::observetype:
Collaboration graph

Public Member Functions

procedure, public resetcurrentvalue (this)
 Reset current observation value.
procedure, public writeto (this, obstab, btagfound, fnamein)
 Write observation input data.
procedure, public addobsindex (this, indx)
 Add a observation index.
procedure, public resetobsindex (this)
 Reset a observation index.
procedure, public da (this)
 Deallocate a observation.

Public Attributes

integer(i4b), public nodenumber = 0
 observation node number
integer(i4b), public unitnumber = 0
 observation output unit number
character(len=lenobsname), public name = ''
 observation name
character(len=lenobstype), public obstypeid = ''
 observation type id
character(len=200), public idstring = ''
 observation id string
character(len=lenboundname), public featurename = ''
 observation feature name
character(len=lenboundname), public featurename2 = ''
 observation feature name 2
integer(i4b), public nodenumber2 = 0
 observation second nod number
integer(i4b), public jaindex = -2
 observation JA index
integer(i4b), public intpak1 = 0
real(dp), public obsdepth = DZERO
real(dp), public dblpak1 = DZERO
integer(i4b), public indxbnds_count = 0
 number of observations indexes when using boundname
integer(i4b), dimension(:), allocatable, public indxbnds
 node numbers for observations when using boundname
logical, public formattedoutput = .true.
 logical indicating if observation output is formatted
logical, public bndfound = .false.
 logical indicating if a boundname was found
real(dp), public currenttimestependvalue = DZERO
 observation value
real(dp), public currenttimestependtime = DZERO
 observation time
integer(i4b), public indxobsoutput = -1
 index for observation output

Private Attributes

type(obsdatatype), pointer, private obsdatum => null()
 observation Datum

Detailed Description

Definition at line 35 of file Observe.f90.

Member Function/Subroutine Documentation

◆ addobsindex()

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

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]indxobservation index

Definition at line 76 of file Observe.f90.

◆ da()

procedure, public observemodule::observetype::da ( class(observetype), intent(inout) this)

Subroutine to deallocated a observation (ObserveType).

Definition at line 78 of file Observe.f90.

◆ resetcurrentvalue()

procedure, public observemodule::observetype::resetcurrentvalue ( class(observetype), intent(inout) this)

Subroutine to reset the current observation value.

Definition at line 74 of file Observe.f90.

◆ resetobsindex()

procedure, public observemodule::observetype::resetobsindex ( class(observetype), intent(inout) this)

Subroutine to reset the observation index count and array.

Definition at line 77 of file Observe.f90.

◆ writeto()

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

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

Parameters
[in,out]obstabobservation table
[in]btagfoundlogical indicating if boundname was found
[in]fnameinobservation input file name

Definition at line 75 of file Observe.f90.

Member Data Documentation

◆ bndfound

logical, public observemodule::observetype::bndfound = .false.

Definition at line 63 of file Observe.f90.

◆ currenttimestependtime

real(dp), public observemodule::observetype::currenttimestependtime = DZERO

Definition at line 65 of file Observe.f90.

◆ currenttimestependvalue

real(dp), public observemodule::observetype::currenttimestependvalue = DZERO

Definition at line 64 of file Observe.f90.

◆ dblpak1

real(dp), public observemodule::observetype::dblpak1 = DZERO

Definition at line 54 of file Observe.f90.

◆ featurename

character(len=lenboundname), public observemodule::observetype::featurename = ''

Definition at line 44 of file Observe.f90.

◆ featurename2

character(len=lenboundname), public observemodule::observetype::featurename2 = ''

Definition at line 45 of file Observe.f90.

◆ formattedoutput

logical, public observemodule::observetype::formattedoutput = .true.

Definition at line 62 of file Observe.f90.

◆ idstring

character(len=200), public observemodule::observetype::idstring = ''

Definition at line 43 of file Observe.f90.

◆ indxbnds

integer(i4b), dimension(:), allocatable, public observemodule::observetype::indxbnds

Definition at line 59 of file Observe.f90.

59 integer(I4B), allocatable, dimension(:), public :: indxbnds !< node numbers for observations when using boundname

◆ indxbnds_count

integer(i4b), public observemodule::observetype::indxbnds_count = 0

Definition at line 58 of file Observe.f90.

◆ indxobsoutput

integer(i4b), public observemodule::observetype::indxobsoutput = -1

Definition at line 68 of file Observe.f90.

◆ intpak1

integer(i4b), public observemodule::observetype::intpak1 = 0

Definition at line 52 of file Observe.f90.

◆ jaindex

integer(i4b), public observemodule::observetype::jaindex = -2

Definition at line 49 of file Observe.f90.

◆ name

character(len=lenobsname), public observemodule::observetype::name = ''

Definition at line 41 of file Observe.f90.

◆ nodenumber

integer(i4b), public observemodule::observetype::nodenumber = 0

Definition at line 39 of file Observe.f90.

◆ nodenumber2

integer(i4b), public observemodule::observetype::nodenumber2 = 0

Definition at line 48 of file Observe.f90.

◆ obsdatum

type(obsdatatype), pointer, private observemodule::observetype::obsdatum => null()
private

Definition at line 71 of file Observe.f90.

◆ obsdepth

real(dp), public observemodule::observetype::obsdepth = DZERO

Definition at line 53 of file Observe.f90.

◆ obstypeid

character(len=lenobstype), public observemodule::observetype::obstypeid = ''

Definition at line 42 of file Observe.f90.

◆ unitnumber

integer(i4b), public observemodule::observetype::unitnumber = 0

Definition at line 40 of file Observe.f90.


The documentation for this type was generated from the following file:
  • /home/runner/work/modflow6/modflow6/src/Utilities/Observation/Observe.f90