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

Encapsulates the model state. More...

#include <CostJbState.h>

Public Member Functions

 State (const Geometry_ &, const Variables &, const util::DateTime &)
 Constructor, destructor. More...
 
 State (const Geometry_ &, const eckit::Configuration &)
 
 State (const Geometry_ &, const State &)
 
 State (const State &)
 
 State (const State_ &)
 
 ~State ()
 
State & operator= (const State &)
 
State_ & state ()
 Interfacing. More...
 
const State_ & state () const
 
const util::DateTime validTime () const
 Time. More...
 
void updateTime (const util::Duration &dt)
 
void read (const eckit::Configuration &)
 I/O and diagnostics. More...
 
void write (const eckit::Configuration &) const
 
double norm () const
 
Geometry_ geometry () const
 
const Variables & variables () const
 
void zero ()
 Accumulator. More...
 
void accumul (const double &, const State &)
 
size_t serialSize () const override
 Serialize and deserialize. More...
 
void serialize (std::vector< double > &) const override
 
void deserialize (const std::vector< double > &, size_t &) override
 

Static Public Member Functions

static const std::string classname ()
 

Private Types

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

Private Member Functions

void print (std::ostream &) const override
 

Private Attributes

std::unique_ptr< State_ > state_
 
const eckit::mpi::Comm & commTime_
 

Detailed Description

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

Encapsulates the model state.

Definition at line 28 of file CostJbState.h.

Member Typedef Documentation

◆ Geometry_

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

Definition at line 41 of file oops/interface/State.h.

◆ State_

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

Definition at line 40 of file oops/interface/State.h.

Constructor & Destructor Documentation

◆ State() [1/5]

template<typename MODEL >
oops::State< MODEL >::State ( const Geometry_ &  resol,
const Variables &  vars,
const util::DateTime &  time 
)

Constructor, destructor.

Definition at line 88 of file oops/interface/State.h.

Here is the call graph for this function:

◆ State() [2/5]

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

Definition at line 100 of file oops/interface/State.h.

Here is the call graph for this function:

◆ State() [3/5]

template<typename MODEL >
oops::State< MODEL >::State ( const Geometry_ &  resol,
const State< MODEL > &  other 
)

Definition at line 125 of file oops/interface/State.h.

Here is the call graph for this function:

◆ State() [4/5]

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

Definition at line 137 of file oops/interface/State.h.

Here is the call graph for this function:

◆ State() [5/5]

template<typename MODEL >
oops::State< MODEL >::State ( const State_ &  target)
explicit

Definition at line 148 of file oops/interface/State.h.

Here is the call graph for this function:

◆ ~State()

template<typename MODEL >
oops::State< MODEL >::~State

Definition at line 160 of file oops/interface/State.h.

Member Function Documentation

◆ accumul()

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

Definition at line 288 of file oops/interface/State.h.

Here is the caller graph for this function:

◆ classname()

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

Definition at line 44 of file oops/interface/State.h.

Here is the caller graph for this function:

◆ deserialize()

template<typename MODEL >
void oops::State< MODEL >::deserialize ( const std::vector< double > &  vect,
size_t &  current 
)
override

Definition at line 254 of file oops/interface/State.h.

◆ geometry()

template<typename MODEL >
Geometry< MODEL > oops::State< MODEL >::geometry

Definition at line 215 of file oops/interface/State.h.

Here is the caller graph for this function:

◆ norm()

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

Definition at line 201 of file oops/interface/State.h.

Here is the caller graph for this function:

◆ operator=()

template<typename MODEL >
State< MODEL > & oops::State< MODEL >::operator= ( const State< MODEL > &  rhs)

Definition at line 170 of file oops/interface/State.h.

◆ print()

template<typename MODEL >
void oops::State< MODEL >::print ( std::ostream &  os) const
overrideprivate

Definition at line 264 of file oops/interface/State.h.

◆ read()

template<typename MODEL >
void oops::State< MODEL >::read ( const eckit::Configuration &  conf)

I/O and diagnostics.

Definition at line 181 of file oops/interface/State.h.

◆ serialize()

template<typename MODEL >
void oops::State< MODEL >::serialize ( std::vector< double > &  vect) const
override

Definition at line 244 of file oops/interface/State.h.

◆ serialSize()

template<typename MODEL >
size_t oops::State< MODEL >::serialSize
override

Serialize and deserialize.

Definition at line 235 of file oops/interface/State.h.

◆ state() [1/2]

template<typename MODEL >
State_& oops::State< MODEL >::state ( )
inline

Interfacing.

Definition at line 56 of file oops/interface/State.h.

Here is the caller graph for this function:

◆ state() [2/2]

template<typename MODEL >
const State_& oops::State< MODEL >::state ( ) const
inline

Definition at line 57 of file oops/interface/State.h.

◆ updateTime()

template<typename MODEL >
void oops::State< MODEL >::updateTime ( const util::Duration &  dt)
inline

Definition at line 61 of file oops/interface/State.h.

◆ validTime()

template<typename MODEL >
const util::DateTime oops::State< MODEL >::validTime ( ) const
inline

Time.

Definition at line 60 of file oops/interface/State.h.

Here is the caller graph for this function:

◆ variables()

template<typename MODEL >
const Variables & oops::State< MODEL >::variables

Definition at line 226 of file oops/interface/State.h.

Here is the caller graph for this function:

◆ write()

template<typename MODEL >
void oops::State< MODEL >::write ( const eckit::Configuration &  conf) const

Definition at line 191 of file oops/interface/State.h.

Here is the caller graph for this function:

◆ zero()

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

Accumulator.

Definition at line 278 of file oops/interface/State.h.

Here is the caller graph for this function:

Member Data Documentation

◆ commTime_

template<typename MODEL >
const eckit::mpi::Comm& oops::State< MODEL >::commTime_
private

Definition at line 82 of file oops/interface/State.h.

◆ state_

template<typename MODEL >
std::unique_ptr<State_> oops::State< MODEL >::state_
private

Definition at line 81 of file oops/interface/State.h.

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