FV3 Bundle
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 <CostJbState.h>

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

Public Member Functions

 State4D (const eckit::Configuration &, const Variables &, const Geometry_ &)
 The arguments define the number of sub-windows and the resolution. More...
 
 State4D (const State4D &)
 
 ~State4D ()
 
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
 

Static Public Member Functions

static const std::string classname ()
 

Private Types

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

Private Member Functions

State4D & operator= (const State4D &)
 
void print (std::ostream &) const
 

Private Attributes

boost::ptr_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 29 of file CostJbState.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 eckit::Configuration &  config,
const Variables &  vars,
const Geometry_ &  resol 
)

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

Definition at line 68 of file State4D.h.

◆ State4D() [2/2]

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

Definition at line 86 of file State4D.h.

◆ ~State4D()

template<typename MODEL >
oops::State4D< MODEL >::~State4D ( )

Definition at line 95 of file State4D.h.

Member Function Documentation

◆ checkStatesNumber()

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

Get model space control variable.

Definition at line 53 of file State4D.h.

Here is the caller graph for this function:

◆ classname()

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

Definition at line 40 of file State4D.h.

◆ norm()

template<typename MODEL >
double oops::State4D< MODEL >::norm ( ) const

Definition at line 141 of file State4D.h.

◆ operator=()

template<typename MODEL >
State4D& oops::State4D< MODEL >::operator= ( const State4D< MODEL > &  )
private

◆ operator[]() [1/2]

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

Definition at line 55 of file State4D.h.

◆ operator[]() [2/2]

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

Definition at line 56 of file State4D.h.

◆ print()

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

Definition at line 132 of file State4D.h.

◆ read()

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

I/O and diagnostics.

Definition at line 102 of file State4D.h.

◆ size()

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

Definition at line 54 of file State4D.h.

Here is the caller graph for this function:

◆ write()

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

Definition at line 117 of file State4D.h.

Member Data Documentation

◆ state4d_

template<typename MODEL >
boost::ptr_vector<State_> oops::State4D< MODEL >::state4d_
private

Definition at line 62 of file State4D.h.

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