FV3 Bundle
lorenz95::StateL95 Class Reference

L95 model state. More...

#include <StateL95.h>

Inheritance diagram for lorenz95::StateL95:
[legend]
Collaboration diagram for lorenz95::StateL95:
[legend]

Public Member Functions

 StateL95 (const Resolution &, const oops::Variables &, const util::DateTime &)
 Constructor, destructor. More...
 
 StateL95 (const Resolution &, const oops::Variables &, const eckit::Configuration &)
 
 StateL95 (const Resolution &, const StateL95 &)
 
 StateL95 (const StateL95 &)
 
virtual ~StateL95 ()
 
StateL95operator= (const StateL95 &)
 Basic operators. More...
 
void getValues (const LocsL95 &, const oops::Variables &, GomL95 &) const
 Get state values at obs locations. More...
 
void getValues (const LocsL95 &, const oops::Variables &, GomL95 &, Nothing &) const
 
StateL95operator+= (const IncrementL95 &)
 Interactions with increments. More...
 
const FieldL95getField () const
 
FieldL95getField ()
 
boost::shared_ptr< const Resolutiongeometry () const
 
void read (const eckit::Configuration &)
 Utilities. More...
 
void write (const eckit::Configuration &) const
 
double norm () const
 
const util::DateTime & validTime () const
 
util::DateTime & validTime ()
 
void zero ()
 For accumulator. More...
 
void accumul (const double &, const StateL95 &)
 

Static Public Member Functions

static const std::string classname ()
 

Private Member Functions

void print (std::ostream &) const
 

Private Attributes

FieldL95 fld_
 
util::DateTime time_
 

Detailed Description

L95 model state.

A State contains everything that is needed to propagate the state forward in time.

Definition at line 50 of file StateL95.h.

Constructor & Destructor Documentation

◆ StateL95() [1/4]

lorenz95::StateL95::StateL95 ( const Resolution resol,
const oops::Variables ,
const util::DateTime &  vt 
)

Constructor, destructor.

Definition at line 41 of file src/lorenz95/StateL95.cc.

◆ StateL95() [2/4]

lorenz95::StateL95::StateL95 ( const Resolution resol,
const oops::Variables ,
const eckit::Configuration &  conf 
)

Definition at line 48 of file src/lorenz95/StateL95.cc.

Here is the call graph for this function:

◆ StateL95() [3/4]

lorenz95::StateL95::StateL95 ( const Resolution resol,
const StateL95 xx 
)

Definition at line 61 of file src/lorenz95/StateL95.cc.

◆ StateL95() [4/4]

lorenz95::StateL95::StateL95 ( const StateL95 xx)

Definition at line 68 of file src/lorenz95/StateL95.cc.

◆ ~StateL95()

lorenz95::StateL95::~StateL95 ( )
virtual

Definition at line 74 of file src/lorenz95/StateL95.cc.

Member Function Documentation

◆ accumul()

void lorenz95::StateL95::accumul ( const double &  zz,
const StateL95 xx 
)

Definition at line 176 of file src/lorenz95/StateL95.cc.

Here is the call graph for this function:

◆ classname()

static const std::string lorenz95::StateL95::classname ( )
inlinestatic

Definition at line 53 of file StateL95.h.

◆ geometry()

boost::shared_ptr<const Resolution> lorenz95::StateL95::geometry ( ) const
inline

Definition at line 73 of file StateL95.h.

Here is the call graph for this function:

◆ getField() [1/2]

const FieldL95& lorenz95::StateL95::getField ( ) const
inline

Definition at line 71 of file StateL95.h.

Here is the caller graph for this function:

◆ getField() [2/2]

FieldL95& lorenz95::StateL95::getField ( )
inline

Definition at line 72 of file StateL95.h.

◆ getValues() [1/2]

void lorenz95::StateL95::getValues ( const LocsL95 locs,
const oops::Variables ,
GomL95 vals 
) const

Get state values at obs locations.

Definition at line 88 of file src/lorenz95/StateL95.cc.

Here is the call graph for this function:

◆ getValues() [2/2]

void lorenz95::StateL95::getValues ( const LocsL95 locs,
const oops::Variables ,
GomL95 vals,
Nothing  
) const

Definition at line 92 of file src/lorenz95/StateL95.cc.

Here is the call graph for this function:

◆ norm()

double lorenz95::StateL95::norm ( ) const
inline

Definition at line 80 of file StateL95.h.

Here is the call graph for this function:

◆ operator+=()

StateL95 & lorenz95::StateL95::operator+= ( const IncrementL95 dx)

Interactions with increments.

Interactions with Increments.

Definition at line 99 of file src/lorenz95/StateL95.cc.

Here is the call graph for this function:

◆ operator=()

StateL95 & lorenz95::StateL95::operator= ( const StateL95 rhs)

Basic operators.

Definition at line 80 of file src/lorenz95/StateL95.cc.

◆ print()

void lorenz95::StateL95::print ( std::ostream &  os) const
private

Definition at line 165 of file src/lorenz95/StateL95.cc.

◆ read()

void lorenz95::StateL95::read ( const eckit::Configuration &  config)

Utilities.

Definition at line 107 of file src/lorenz95/StateL95.cc.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ validTime() [1/2]

const util::DateTime& lorenz95::StateL95::validTime ( ) const
inline

Definition at line 81 of file StateL95.h.

Here is the caller graph for this function:

◆ validTime() [2/2]

util::DateTime& lorenz95::StateL95::validTime ( )
inline

Definition at line 82 of file StateL95.h.

◆ write()

void lorenz95::StateL95::write ( const eckit::Configuration &  config) const

Definition at line 130 of file src/lorenz95/StateL95.cc.

Here is the call graph for this function:

◆ zero()

void lorenz95::StateL95::zero ( )

For accumulator.

Definition at line 172 of file src/lorenz95/StateL95.cc.

Here is the call graph for this function:

Member Data Documentation

◆ fld_

FieldL95 lorenz95::StateL95::fld_
private

Definition at line 90 of file StateL95.h.

◆ time_

util::DateTime lorenz95::StateL95::time_
private

Definition at line 91 of file StateL95.h.


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