OOPS
Public Member Functions | Static Public Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
oops::State4D< MODEL > Class Template Reference

Four dimensional state. More...

#include <State4D.h>

Inheritance diagram for oops::State4D< MODEL >:
Inheritance graph
[legend]
Collaboration diagram for oops::State4D< MODEL >:
Collaboration graph
[legend]

Public Member Functions

 State4D (const Geometry_ &, const eckit::Configuration &)
 The arguments define the number of sub-windows and the resolution. More...
 
 State4D (const State_ &)
 
void read (const eckit::Configuration &)
 I/O and diagnostics. More...
 
void write (const eckit::Configuration &) const
 
double norm () const
 
bool checkStatesNumber (const unsigned int nn) const
 Get model space control variable. More...
 
size_t size () const
 
State_ & operator[] (const int ii)
 
const State_ & operator[] (const int ii) const
 
Geometry_ geometry () const
 
const Variables & variables () const
 
const std::vector< util::DateTime > validTimes () const
 
void zero ()
 Accumulator. More...
 
void accumul (const double &, const State4D &)
 

Static Public Member Functions

static const std::string classname ()
 

Private Types

typedef Geometry< MODEL > Geometry_
 
typedef State< MODEL > State_
 

Private Member Functions

void print (std::ostream &) const
 

Private Attributes

std::vector< State_ > state4d_
 

Detailed Description

template<typename MODEL>
class oops::State4D< MODEL >

Four dimensional state.

The 4D state is mostly used as part of the VDA control variable.

Definition at line 35 of file State4D.h.

Member Typedef Documentation

◆ Geometry_

template<typename MODEL >
typedef Geometry<MODEL> oops::State4D< MODEL >::Geometry_
private

Definition at line 36 of file State4D.h.

◆ State_

template<typename MODEL >
typedef State<MODEL> oops::State4D< MODEL >::State_
private

Definition at line 37 of file State4D.h.

Constructor & Destructor Documentation

◆ State4D() [1/2]

template<typename MODEL >
oops::State4D< MODEL >::State4D ( const Geometry_ &  resol,
const eckit::Configuration &  config 
)

The arguments define the number of sub-windows and the resolution.

Definition at line 74 of file State4D.h.

◆ State4D() [2/2]

template<typename MODEL >
oops::State4D< MODEL >::State4D ( const State_ &  state3d)
explicit

Definition at line 97 of file State4D.h.

Member Function Documentation

◆ accumul()

template<typename MODEL >
void oops::State4D< MODEL >::accumul ( const double &  zz,
const State4D< MODEL > &  xx 
)

Definition at line 170 of file State4D.h.

Here is the call graph for this function:

◆ checkStatesNumber()

template<typename MODEL >
bool oops::State4D< MODEL >::checkStatesNumber ( const unsigned int  nn) const
inline

Get model space control variable.

Definition at line 52 of file State4D.h.

◆ classname()

template<typename MODEL >
static const std::string oops::State4D< MODEL >::classname ( )
inlinestatic

Definition at line 40 of file State4D.h.

◆ geometry()

template<typename MODEL >
Geometry_ oops::State4D< MODEL >::geometry ( ) const
inline

Definition at line 57 of file State4D.h.

◆ norm()

template<typename MODEL >
double oops::State4D< MODEL >::norm

Definition at line 191 of file State4D.h.

◆ operator[]() [1/2]

template<typename MODEL >
State_& oops::State4D< MODEL >::operator[] ( const int  ii)
inline

Definition at line 54 of file State4D.h.

◆ operator[]() [2/2]

template<typename MODEL >
const State_& oops::State4D< MODEL >::operator[] ( const int  ii) const
inline

Definition at line 55 of file State4D.h.

◆ print()

template<typename MODEL >
void oops::State4D< MODEL >::print ( std::ostream &  outs) const
private

Definition at line 182 of file State4D.h.

◆ read()

template<typename MODEL >
void oops::State4D< MODEL >::read ( const eckit::Configuration &  config)

I/O and diagnostics.

Definition at line 105 of file State4D.h.

◆ size()

template<typename MODEL >
size_t oops::State4D< MODEL >::size ( ) const
inline

Definition at line 53 of file State4D.h.

Here is the caller graph for this function:

◆ validTimes()

template<typename MODEL >
const std::vector< util::DateTime > oops::State4D< MODEL >::validTimes

Definition at line 147 of file State4D.h.

◆ variables()

template<typename MODEL >
const Variables& oops::State4D< MODEL >::variables ( ) const
inline

Definition at line 58 of file State4D.h.

◆ write()

template<typename MODEL >
void oops::State4D< MODEL >::write ( const eckit::Configuration &  config) const

Definition at line 127 of file State4D.h.

Here is the caller graph for this function:

◆ zero()

template<typename MODEL >
void oops::State4D< MODEL >::zero

Accumulator.

Definition at line 159 of file State4D.h.

Member Data Documentation

◆ state4d_

template<typename MODEL >
std::vector<State_> oops::State4D< MODEL >::state4d_
private

Definition at line 68 of file State4D.h.

The documentation for this class was generated from the following file: