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

Increment Class: Difference between two states. More...

#include <IncrementMPAS.h>

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

Public Member Functions

 IncrementMPAS (const GeometryMPAS &, const oops::Variables &, const util::DateTime &)
 Constructor, destructor. More...
 
 IncrementMPAS (const GeometryMPAS &, const IncrementMPAS &)
 
 IncrementMPAS (const IncrementMPAS &, const bool)
 
 IncrementMPAS (const IncrementMPAS &)
 
virtual ~IncrementMPAS ()
 
void diff (const StateMPAS &, const StateMPAS &)
 Basic operators. More...
 
void zero ()
 
void zero (const util::DateTime &)
 
void ones ()
 
IncrementMPAS & operator= (const IncrementMPAS &)
 
IncrementMPAS & operator+= (const IncrementMPAS &)
 
IncrementMPAS & operator-= (const IncrementMPAS &)
 
IncrementMPAS & operator*= (const double &)
 
void axpy (const double &, const IncrementMPAS &, const bool check=true)
 
void axpy (const double &, const StateMPAS &, const bool check=true)
 
double dot_product_with (const IncrementMPAS &) const
 
void schur_product_with (const IncrementMPAS &)
 
void random ()
 
void dirac (const eckit::Configuration &)
 
void setAtlas (atlas::FieldSet *) const
 ATLAS. More...
 
void toAtlas (atlas::FieldSet *) const
 
void fromAtlas (atlas::FieldSet *)
 
void read (const eckit::Configuration &)
 I/O and diagnostics. More...
 
void write (const eckit::Configuration &) const
 
double norm () const
 
void updateTime (const util::Duration &dt)
 
void accumul (const double &, const StateMPAS &)
 Other. More...
 
std::shared_ptr< const GeometryMPAS > geometry () const
 
const util::DateTime & time () const
 
util::DateTime & time ()
 
const util::DateTime & validTime () const
 
util::DateTime & validTime ()
 
int & toFortran ()
 
const int & toFortran () const
 
size_t serialSize () const override
 Serialization. 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 Member Functions

void print (std::ostream &) const override
 Data. More...
 

Private Attributes

F90inc keyInc_
 
std::shared_ptr< const GeometryMPAS > geom_
 
oops::Variables vars_
 
util::DateTime time_
 

Detailed Description

Increment Class: Difference between two states.

Some fields that are present in a State may not be present in an Increment. The Increment contains everything that is needed by the tangent-linear and adjoint models.

Definition at line 55 of file IncrementMPAS.h.

Constructor & Destructor Documentation

◆ IncrementMPAS() [1/4]

mpas::IncrementMPAS::IncrementMPAS ( const GeometryMPAS &  geom,
const oops::Variables &  vars,
const util::DateTime &  time 
)

Constructor, destructor.

Definition at line 27 of file IncrementMPAS.cc.

Here is the call graph for this function:

◆ IncrementMPAS() [2/4]

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

Definition at line 37 of file IncrementMPAS.cc.

Here is the call graph for this function:

◆ IncrementMPAS() [3/4]

mpas::IncrementMPAS::IncrementMPAS ( const IncrementMPAS &  other,
const bool  copy 
)

Definition at line 46 of file IncrementMPAS.cc.

Here is the call graph for this function:

◆ IncrementMPAS() [4/4]

mpas::IncrementMPAS::IncrementMPAS ( const IncrementMPAS &  other)

Definition at line 58 of file IncrementMPAS.cc.

Here is the call graph for this function:

◆ ~IncrementMPAS()

mpas::IncrementMPAS::~IncrementMPAS ( )
virtual

Definition at line 66 of file IncrementMPAS.cc.

Here is the call graph for this function:

Member Function Documentation

◆ accumul()

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

Other.

Definition at line 142 of file IncrementMPAS.cc.

Here is the call graph for this function:

◆ axpy() [1/2]

void mpas::IncrementMPAS::axpy ( const double &  zz,
const IncrementMPAS &  dx,
const bool  check = true 
)

Definition at line 130 of file IncrementMPAS.cc.

Here is the call graph for this function:

◆ axpy() [2/2]

void mpas::IncrementMPAS::axpy ( const double &  zz,
const StateMPAS &  xx,
const bool  check = true 
)

Definition at line 136 of file IncrementMPAS.cc.

Here is the call graph for this function:

◆ classname()

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

Definition at line 59 of file IncrementMPAS.h.

◆ deserialize()

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

Definition at line 219 of file IncrementMPAS.cc.

Here is the call graph for this function:

◆ diff()

void mpas::IncrementMPAS::diff ( const StateMPAS &  x1,
const StateMPAS &  x2 
)

Basic operators.

Definition at line 73 of file IncrementMPAS.cc.

Here is the call graph for this function:

◆ dirac()

void mpas::IncrementMPAS::dirac ( const eckit::Configuration &  config)

Definition at line 262 of file IncrementMPAS.cc.

Here is the call graph for this function:

◆ dot_product_with()

double mpas::IncrementMPAS::dot_product_with ( const IncrementMPAS &  other) const

Definition at line 150 of file IncrementMPAS.cc.

Here is the call graph for this function:

◆ fromAtlas()

void mpas::IncrementMPAS::fromAtlas ( atlas::FieldSet *  afieldset)

Definition at line 172 of file IncrementMPAS.cc.

Here is the call graph for this function:

◆ geometry()

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

Definition at line 100 of file IncrementMPAS.h.

◆ norm()

double mpas::IncrementMPAS::norm ( ) const

Definition at line 230 of file IncrementMPAS.cc.

Here is the call graph for this function:

◆ ones()

void mpas::IncrementMPAS::ones ( )

Definition at line 126 of file IncrementMPAS.cc.

Here is the call graph for this function:

◆ operator*=()

IncrementMPAS & mpas::IncrementMPAS::operator*= ( const double &  zz)

Definition at line 112 of file IncrementMPAS.cc.

Here is the call graph for this function:

◆ operator+=()

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

Definition at line 100 of file IncrementMPAS.cc.

Here is the call graph for this function:

◆ operator-=()

IncrementMPAS & mpas::IncrementMPAS::operator-= ( const IncrementMPAS &  dx)

Definition at line 106 of file IncrementMPAS.cc.

Here is the call graph for this function:

◆ operator=()

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

Definition at line 94 of file IncrementMPAS.cc.

Here is the call graph for this function:

◆ print()

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

Data.

Definition at line 236 of file IncrementMPAS.cc.

Here is the call graph for this function:

◆ random()

void mpas::IncrementMPAS::random ( )

Definition at line 156 of file IncrementMPAS.cc.

Here is the call graph for this function:

◆ read()

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

I/O and diagnostics.

Definition at line 179 of file IncrementMPAS.cc.

Here is the call graph for this function:

◆ schur_product_with()

void mpas::IncrementMPAS::schur_product_with ( const IncrementMPAS &  dx)

Definition at line 146 of file IncrementMPAS.cc.

Here is the call graph for this function:

◆ serialize()

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

Definition at line 204 of file IncrementMPAS.cc.

Here is the call graph for this function:

◆ serialSize()

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

Serialization.

Definition at line 189 of file IncrementMPAS.cc.

Here is the call graph for this function:

◆ setAtlas()

void mpas::IncrementMPAS::setAtlas ( atlas::FieldSet *  afieldset) const

ATLAS.

Definition at line 162 of file IncrementMPAS.cc.

Here is the call graph for this function:

◆ time() [1/2]

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

Definition at line 103 of file IncrementMPAS.h.

◆ time() [2/2]

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

Definition at line 102 of file IncrementMPAS.h.

◆ toAtlas()

void mpas::IncrementMPAS::toAtlas ( atlas::FieldSet *  afieldset) const

Definition at line 167 of file IncrementMPAS.cc.

Here is the call graph for this function:

◆ toFortran() [1/2]

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

Definition at line 107 of file IncrementMPAS.h.

Here is the caller graph for this function:

◆ toFortran() [2/2]

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

Definition at line 108 of file IncrementMPAS.h.

◆ updateTime()

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

Definition at line 95 of file IncrementMPAS.h.

◆ validTime() [1/2]

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

Definition at line 105 of file IncrementMPAS.h.

◆ validTime() [2/2]

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

Definition at line 104 of file IncrementMPAS.h.

Here is the caller graph for this function:

◆ write()

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

Definition at line 183 of file IncrementMPAS.cc.

Here is the call graph for this function:

◆ zero() [1/2]

void mpas::IncrementMPAS::zero ( )

Definition at line 117 of file IncrementMPAS.cc.

Here is the call graph for this function:

◆ zero() [2/2]

void mpas::IncrementMPAS::zero ( const util::DateTime &  vt)

Definition at line 121 of file IncrementMPAS.cc.

Here is the call graph for this function:

Member Data Documentation

◆ geom_

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

Definition at line 119 of file IncrementMPAS.h.

◆ keyInc_

F90inc mpas::IncrementMPAS::keyInc_
private

Definition at line 118 of file IncrementMPAS.h.

◆ time_

util::DateTime mpas::IncrementMPAS::time_
private

Definition at line 121 of file IncrementMPAS.h.

◆ vars_

oops::Variables mpas::IncrementMPAS::vars_
private

Definition at line 120 of file IncrementMPAS.h.

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