FV3-JEDI
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
fv3jedi::State Class Reference

#include <State.h>

Inheritance diagram for fv3jedi::State:
Inheritance graph
[legend]
Collaboration diagram for fv3jedi::State:
Collaboration graph
[legend]

Public Member Functions

 State (const Geometry &, const oops::Variables &, const util::DateTime &)
 
 State (const Geometry &, const eckit::Configuration &)
 
 State (const Geometry &, const State &)
 
 State (const State &)
 
virtual ~State ()
 
State & operator= (const State &)
 
void zero ()
 
void accumul (const double &, const State &)
 
void changeResolution (const State &xx)
 
State & operator+= (const Increment &)
 
void read (const eckit::Configuration &)
 
void analytic_init (const eckit::Configuration &, const Geometry &)
 
void write (const eckit::Configuration &) const
 
double norm () const
 
size_t serialSize () const
 Serialize and deserialize. More...
 
void serialize (std::vector< double > &) const
 
void deserialize (const std::vector< double > &, size_t &)
 
std::shared_ptr< const Geometry > geometry () const
 
const oops::Variables & variables () const
 
const util::DateTime & time () const
 
util::DateTime & time ()
 
const util::DateTime & validTime () const
 
util::DateTime & validTime ()
 
void updateTime (const util::Duration &dt)
 
int & toFortran ()
 
const int & toFortran () const
 

Static Public Member Functions

static const std::string classname ()
 

Private Member Functions

void print (std::ostream &) const
 

Private Attributes

F90state keyState_
 
std::shared_ptr< const Geometry > geom_
 
oops::Variables vars_
 
util::DateTime time_
 

Detailed Description

Definition at line 45 of file State.h.

Constructor & Destructor Documentation

◆ State() [1/4]

fv3jedi::State::State ( const Geometry &  geom,
const oops::Variables &  vars,
const util::DateTime &  time 
)

Definition at line 31 of file State.cc.

Here is the call graph for this function:

◆ State() [2/4]

fv3jedi::State::State ( const Geometry &  geom,
const eckit::Configuration &  conf 
)

Definition at line 38 of file State.cc.

Here is the call graph for this function:

◆ State() [3/4]

fv3jedi::State::State ( const Geometry &  resol,
const State &  other 
)

Definition at line 58 of file State.cc.

Here is the call graph for this function:

◆ State() [4/4]

fv3jedi::State::State ( const State &  other)

Definition at line 67 of file State.cc.

Here is the call graph for this function:

◆ ~State()

fv3jedi::State::~State ( )
virtual

Definition at line 74 of file State.cc.

Here is the call graph for this function:

Member Function Documentation

◆ accumul()

void fv3jedi::State::accumul ( const double &  zz,
const State &  xx 
)

Definition at line 153 of file State.cc.

Here is the call graph for this function:

◆ analytic_init()

void fv3jedi::State::analytic_init ( const eckit::Configuration &  config,
const Geometry &  geom 
)

Definition at line 104 of file State.cc.

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

◆ changeResolution()

void fv3jedi::State::changeResolution ( const State &  xx)

Definition at line 84 of file State.cc.

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

◆ classname()

static const std::string fv3jedi::State::classname ( )
inlinestatic

Definition at line 47 of file State.h.

◆ deserialize()

void fv3jedi::State::deserialize ( const std::vector< double > &  vect,
size_t &  index 
)

Definition at line 189 of file State.cc.

Here is the call graph for this function:

◆ geometry()

std::shared_ptr<const Geometry> fv3jedi::State::geometry ( ) const
inline

Definition at line 78 of file State.h.

◆ norm()

double fv3jedi::State::norm ( ) const

Definition at line 157 of file State.cc.

Here is the call graph for this function:

◆ operator+=()

State & fv3jedi::State::operator+= ( const Increment &  dx)

Definition at line 89 of file State.cc.

Here is the call graph for this function:

◆ operator=()

State & fv3jedi::State::operator= ( const State &  rhs)

Definition at line 78 of file State.cc.

Here is the call graph for this function:

◆ print()

void fv3jedi::State::print ( std::ostream &  os) const
private

Definition at line 116 of file State.cc.

Here is the call graph for this function:

◆ read()

void fv3jedi::State::read ( const eckit::Configuration &  config)

Definition at line 98 of file State.cc.

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

◆ serialize()

void fv3jedi::State::serialize ( std::vector< double > &  vect) const

Definition at line 174 of file State.cc.

Here is the call graph for this function:

◆ serialSize()

size_t fv3jedi::State::serialSize ( ) const

Serialize and deserialize.

Definition at line 163 of file State.cc.

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

◆ time() [1/2]

util::DateTime& fv3jedi::State::time ( )
inline

Definition at line 82 of file State.h.

◆ time() [2/2]

const util::DateTime& fv3jedi::State::time ( ) const
inline

Definition at line 81 of file State.h.

◆ toFortran() [1/2]

int& fv3jedi::State::toFortran ( )
inline

Definition at line 87 of file State.h.

Here is the caller graph for this function:

◆ toFortran() [2/2]

const int& fv3jedi::State::toFortran ( ) const
inline

Definition at line 88 of file State.h.

◆ updateTime()

void fv3jedi::State::updateTime ( const util::Duration &  dt)
inline

Definition at line 85 of file State.h.

◆ validTime() [1/2]

util::DateTime& fv3jedi::State::validTime ( )
inline

Definition at line 84 of file State.h.

◆ validTime() [2/2]

const util::DateTime& fv3jedi::State::validTime ( ) const
inline

Definition at line 83 of file State.h.

Here is the caller graph for this function:

◆ variables()

const oops::Variables& fv3jedi::State::variables ( ) const
inline

Definition at line 79 of file State.h.

◆ write()

void fv3jedi::State::write ( const eckit::Configuration &  config) const

Definition at line 110 of file State.cc.

Here is the call graph for this function:

◆ zero()

void fv3jedi::State::zero ( )

Definition at line 149 of file State.cc.

Here is the call graph for this function:

Member Data Documentation

◆ geom_

std::shared_ptr<const Geometry> fv3jedi::State::geom_
private

Definition at line 94 of file State.h.

◆ keyState_

F90state fv3jedi::State::keyState_
private

Definition at line 93 of file State.h.

◆ time_

util::DateTime fv3jedi::State::time_
private

Definition at line 96 of file State.h.

◆ vars_

oops::Variables fv3jedi::State::vars_
private

Definition at line 95 of file State.h.

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