MPAS-JEDI
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
mpas::StateMPAS Class Reference

MPAS model state. More...

#include <StateMPAS.h>

Inheritance diagram for mpas::StateMPAS:
Inheritance graph
[legend]
Collaboration diagram for mpas::StateMPAS:
Collaboration graph
[legend]

Public Member Functions

 StateMPAS (const GeometryMPAS &, const oops::Variables &, const util::DateTime &)
 Constructor, destructor. More...
 
 StateMPAS (const GeometryMPAS &, const eckit::Configuration &)
 
 StateMPAS (const GeometryMPAS &, const StateMPAS &)
 
 StateMPAS (const StateMPAS &)
 
 ~StateMPAS ()
 
StateMPAS & operator= (const StateMPAS &)
 Basic operators. More...
 
void zero ()
 For accumulator. More...
 
void accumul (const double &, const StateMPAS &)
 
void changeResolution (const StateMPAS &xx)
 Interpolate full fields. More...
 
StateMPAS & operator+= (const IncrementMPAS &)
 Interactions with Increment. More...
 
size_t serialSize () const override
 Serialization. More...
 
void serialize (std::vector< double > &) const override
 
void deserialize (const std::vector< double > &, size_t &) override
 
void read (const eckit::Configuration &)
 I/O and diagnostics. More...
 
void analytic_init (const eckit::Configuration &, const GeometryMPAS &)
 
void write (const eckit::Configuration &) const
 
double norm () const
 
std::shared_ptr< const GeometryMPAS > geometry () const
 
const util::DateTime & time () const
 
util::DateTime & time ()
 
const util::DateTime & validTime () const
 
util::DateTime & validTime ()
 
const oops::Variables & variables () const
 
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 override
 
oops::Variables stateVars ()
 

Private Attributes

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

Detailed Description

MPAS model state.

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

Definition at line 49 of file StateMPAS.h.

Constructor & Destructor Documentation

◆ StateMPAS() [1/4]

mpas::StateMPAS::StateMPAS ( const GeometryMPAS &  geom,
const oops::Variables &  incvars,
const util::DateTime &  time 
)

Constructor, destructor.

Definition at line 30 of file StateMPAS.cc.

Here is the call graph for this function:

◆ StateMPAS() [2/4]

mpas::StateMPAS::StateMPAS ( const GeometryMPAS &  resol,
const eckit::Configuration &  config 
)

Definition at line 40 of file StateMPAS.cc.

Here is the call graph for this function:

◆ StateMPAS() [3/4]

mpas::StateMPAS::StateMPAS ( const GeometryMPAS &  resol,
const StateMPAS &  other 
)

Definition at line 59 of file StateMPAS.cc.

Here is the call graph for this function:

◆ StateMPAS() [4/4]

mpas::StateMPAS::StateMPAS ( const StateMPAS &  other)

Definition at line 72 of file StateMPAS.cc.

Here is the call graph for this function:

◆ ~StateMPAS()

mpas::StateMPAS::~StateMPAS ( )

Definition at line 82 of file StateMPAS.cc.

Here is the call graph for this function:

Member Function Documentation

◆ accumul()

void mpas::StateMPAS::accumul ( const double &  zz,
const StateMPAS &  xx 
)

Definition at line 207 of file StateMPAS.cc.

Here is the call graph for this function:

◆ analytic_init()

void mpas::StateMPAS::analytic_init ( const eckit::Configuration &  config,
const GeometryMPAS &  geom 
)

Definition at line 164 of file StateMPAS.cc.

Here is the call graph for this function:

◆ changeResolution()

void mpas::StateMPAS::changeResolution ( const StateMPAS &  xx)

Interpolate full fields.

Interpolate full state.

Definition at line 97 of file StateMPAS.cc.

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

◆ classname()

static const std::string mpas::StateMPAS::classname ( )
inlinestatic

Definition at line 53 of file StateMPAS.h.

◆ deserialize()

void mpas::StateMPAS::deserialize ( const std::vector< double > &  vect,
size_t &  index 
)
override

Definition at line 146 of file StateMPAS.cc.

Here is the call graph for this function:

◆ geometry()

std::shared_ptr<const GeometryMPAS> mpas::StateMPAS::geometry ( ) const
inline

Definition at line 85 of file StateMPAS.h.

Here is the caller graph for this function:

◆ norm()

double mpas::StateMPAS::norm ( ) const

Definition at line 211 of file StateMPAS.cc.

Here is the call graph for this function:

◆ operator+=()

StateMPAS & mpas::StateMPAS::operator+= ( const IncrementMPAS &  dx)

Interactions with Increment.

Interactions with Increments.

Definition at line 104 of file StateMPAS.cc.

Here is the call graph for this function:

◆ operator=()

StateMPAS & mpas::StateMPAS::operator= ( const StateMPAS &  rhs)

Basic operators.

Definition at line 89 of file StateMPAS.cc.

Here is the call graph for this function:

◆ print()

void mpas::StateMPAS::print ( std::ostream &  os) const
overrideprivate

Definition at line 175 of file StateMPAS.cc.

Here is the call graph for this function:

◆ read()

void mpas::StateMPAS::read ( const eckit::Configuration &  config)

I/O and diagnostics.

Definition at line 160 of file StateMPAS.cc.

Here is the call graph for this function:

◆ serialize()

void mpas::StateMPAS::serialize ( std::vector< double > &  vect) const
override

Definition at line 131 of file StateMPAS.cc.

Here is the call graph for this function:

◆ serialSize()

size_t mpas::StateMPAS::serialSize ( ) const
override

Serialization.

Definition at line 116 of file StateMPAS.cc.

Here is the call graph for this function:

◆ stateVars()

oops::Variables mpas::StateMPAS::stateVars ( )
private

Temporary Auxilliary Variable Definitions

Definition at line 218 of file StateMPAS.cc.

Here is the caller graph for this function:

◆ time() [1/2]

util::DateTime& mpas::StateMPAS::time ( )
inline

Definition at line 88 of file StateMPAS.h.

◆ time() [2/2]

const util::DateTime& mpas::StateMPAS::time ( ) const
inline

Definition at line 87 of file StateMPAS.h.

◆ toFortran() [1/2]

int& mpas::StateMPAS::toFortran ( )
inline

Definition at line 94 of file StateMPAS.h.

Here is the caller graph for this function:

◆ toFortran() [2/2]

const int& mpas::StateMPAS::toFortran ( ) const
inline

Definition at line 95 of file StateMPAS.h.

◆ updateTime()

void mpas::StateMPAS::updateTime ( const util::Duration &  dt)
inline

Definition at line 92 of file StateMPAS.h.

◆ validTime() [1/2]

util::DateTime& mpas::StateMPAS::validTime ( )
inline

Definition at line 90 of file StateMPAS.h.

◆ validTime() [2/2]

const util::DateTime& mpas::StateMPAS::validTime ( ) const
inline

Definition at line 89 of file StateMPAS.h.

Here is the caller graph for this function:

◆ variables()

const oops::Variables& mpas::StateMPAS::variables ( ) const
inline

Definition at line 91 of file StateMPAS.h.

Here is the caller graph for this function:

◆ write()

void mpas::StateMPAS::write ( const eckit::Configuration &  config) const

Definition at line 171 of file StateMPAS.cc.

Here is the call graph for this function:

◆ zero()

void mpas::StateMPAS::zero ( )

For accumulator.

Definition at line 203 of file StateMPAS.cc.

Here is the call graph for this function:

Member Data Documentation

◆ geom_

std::shared_ptr<const GeometryMPAS> mpas::StateMPAS::geom_
private

Definition at line 100 of file StateMPAS.h.

◆ keyState_

F90state mpas::StateMPAS::keyState_
private

Definition at line 99 of file StateMPAS.h.

◆ time_

util::DateTime mpas::StateMPAS::time_
private

Definition at line 102 of file StateMPAS.h.

◆ vars_

oops::Variables mpas::StateMPAS::vars_
private

Definition at line 101 of file StateMPAS.h.

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