OOPS
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
lorenz95::IncrementL95 Class Reference

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

#include <IncrementL95.h>

Inheritance diagram for lorenz95::IncrementL95:
Inheritance graph
[legend]
Collaboration diagram for lorenz95::IncrementL95:
Collaboration graph
[legend]

Public Member Functions

 IncrementL95 (const Resolution &, const oops::Variables &, const util::DateTime &)
 Constructor, destructor. More...
 
 IncrementL95 (const Resolution &, const IncrementL95 &)
 
 IncrementL95 (const IncrementL95 &, const bool)
 
virtual ~IncrementL95 ()
 
void diff (const StateL95 &, const StateL95 &)
 Basic operators. More...
 
void zero ()
 
void zero (const util::DateTime &)
 
void ones ()
 
void dirac (const eckit::Configuration &)
 
IncrementL95 & operator= (const IncrementL95 &)
 
IncrementL95 & operator+= (const IncrementL95 &)
 
IncrementL95 & operator-= (const IncrementL95 &)
 
IncrementL95 & operator*= (const double &)
 
void axpy (const double &, const IncrementL95 &, const bool check=true)
 
double dot_product_with (const IncrementL95 &) const
 
void schur_product_with (const IncrementL95 &)
 
void random ()
 
void setAtlas (atlas::FieldSet *) const
 ATLAS. More...
 
void toAtlas (atlas::FieldSet *) const
 
void fromAtlas (atlas::FieldSet *)
 
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 updateTime (const util::Duration &dt)
 
oops::LocalIncrement getLocal (const Iterator &) const
 
void setLocal (const oops::LocalIncrement &, const Iterator &)
 
const FieldL95 & getField () const
 Access to data. More...
 
FieldL95 & getField ()
 
std::shared_ptr< const Resolution > geometry () const
 
std::vector< double > & asVector ()
 
const std::vector< double > & asVector () const
 
void accumul (const double &, const StateL95 &)
 
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 Member Functions

void print (std::ostream &) const override
 

Private Attributes

FieldL95 fld_
 
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 56 of file IncrementL95.h.

Constructor & Destructor Documentation

◆ IncrementL95() [1/3]

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

Constructor, destructor.

Definition at line 45 of file IncrementL95.cc.

Here is the call graph for this function:

◆ IncrementL95() [2/3]

lorenz95::IncrementL95::IncrementL95 ( const Resolution &  resol,
const IncrementL95 &  dx 
)

Definition at line 53 of file IncrementL95.cc.

◆ IncrementL95() [3/3]

lorenz95::IncrementL95::IncrementL95 ( const IncrementL95 &  dx,
const bool  copy 
)

Definition at line 60 of file IncrementL95.cc.

◆ ~IncrementL95()

lorenz95::IncrementL95::~IncrementL95 ( )
virtual

Definition at line 66 of file IncrementL95.cc.

Member Function Documentation

◆ accumul()

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

Definition at line 137 of file IncrementL95.cc.

Here is the call graph for this function:

◆ asVector() [1/2]

std::vector<double>& lorenz95::IncrementL95::asVector ( )
inline

Definition at line 106 of file IncrementL95.h.

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

◆ asVector() [2/2]

const std::vector<double>& lorenz95::IncrementL95::asVector ( ) const
inline

Definition at line 107 of file IncrementL95.h.

Here is the call graph for this function:

◆ axpy()

void lorenz95::IncrementL95::axpy ( const double &  zz,
const IncrementL95 &  rhs,
const bool  check = true 
)

Definition at line 118 of file IncrementL95.cc.

Here is the call graph for this function:

◆ classname()

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

Definition at line 60 of file IncrementL95.h.

◆ deserialize()

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

Definition at line 251 of file IncrementL95.cc.

Here is the call graph for this function:

◆ diff()

void lorenz95::IncrementL95::diff ( const StateL95 &  x1,
const StateL95 &  x2 
)

Basic operators.

Definition at line 72 of file IncrementL95.cc.

Here is the call graph for this function:

◆ dirac()

void lorenz95::IncrementL95::dirac ( const eckit::Configuration &  config)

Definition at line 114 of file IncrementL95.cc.

Here is the call graph for this function:

◆ dot_product_with()

double lorenz95::IncrementL95::dot_product_with ( const IncrementL95 &  other) const

Definition at line 124 of file IncrementL95.cc.

◆ fromAtlas()

void lorenz95::IncrementL95::fromAtlas ( atlas::FieldSet *  )

Definition at line 230 of file IncrementL95.cc.

◆ geometry()

std::shared_ptr<const Resolution> lorenz95::IncrementL95::geometry ( ) const
inline

Definition at line 102 of file IncrementL95.h.

Here is the call graph for this function:

◆ getField() [1/2]

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

Definition at line 101 of file IncrementL95.h.

◆ getField() [2/2]

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

Access to data.

Definition at line 100 of file IncrementL95.h.

Here is the caller graph for this function:

◆ getLocal()

oops::LocalIncrement lorenz95::IncrementL95::getLocal ( const Iterator &  i) const

Definition at line 204 of file IncrementL95.cc.

Here is the call graph for this function:

◆ norm()

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

Definition at line 91 of file IncrementL95.h.

Here is the call graph for this function:

◆ ones()

void lorenz95::IncrementL95::ones ( )

Definition at line 110 of file IncrementL95.cc.

Here is the call graph for this function:

◆ operator*=()

IncrementL95 & lorenz95::IncrementL95::operator*= ( const double &  zz)

Definition at line 96 of file IncrementL95.cc.

◆ operator+=()

IncrementL95 & lorenz95::IncrementL95::operator+= ( const IncrementL95 &  rhs)

Definition at line 84 of file IncrementL95.cc.

◆ operator-=()

IncrementL95 & lorenz95::IncrementL95::operator-= ( const IncrementL95 &  rhs)

Definition at line 90 of file IncrementL95.cc.

◆ operator=()

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

Definition at line 78 of file IncrementL95.cc.

◆ print()

void lorenz95::IncrementL95::print ( std::ostream &  os) const
overrideprivate

Definition at line 199 of file IncrementL95.cc.

◆ random()

void lorenz95::IncrementL95::random ( )

Definition at line 133 of file IncrementL95.cc.

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

◆ read()

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

Utilities.

Definition at line 143 of file IncrementL95.cc.

Here is the call graph for this function:

◆ schur_product_with()

void lorenz95::IncrementL95::schur_product_with ( const IncrementL95 &  rhs)

Definition at line 129 of file IncrementL95.cc.

Here is the call graph for this function:

◆ serialize()

void lorenz95::IncrementL95::serialize ( std::vector< double > &  vect) const
override

Definition at line 243 of file IncrementL95.cc.

Here is the call graph for this function:

◆ serialSize()

size_t lorenz95::IncrementL95::serialSize ( ) const
override

Serialize and deserialize.

Serialize - deserialize.

Definition at line 236 of file IncrementL95.cc.

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

◆ setAtlas()

void lorenz95::IncrementL95::setAtlas ( atlas::FieldSet *  ) const

ATLAS.

Convert to/from ATLAS fieldset.

Definition at line 222 of file IncrementL95.cc.

◆ setLocal()

void lorenz95::IncrementL95::setLocal ( const oops::LocalIncrement &  gp,
const Iterator &  i 
)

Definition at line 214 of file IncrementL95.cc.

Here is the call graph for this function:

◆ toAtlas()

void lorenz95::IncrementL95::toAtlas ( atlas::FieldSet *  ) const

Definition at line 226 of file IncrementL95.cc.

◆ updateTime()

void lorenz95::IncrementL95::updateTime ( const util::Duration &  dt)
inline

Definition at line 94 of file IncrementL95.h.

◆ validTime() [1/2]

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

Definition at line 93 of file IncrementL95.h.

◆ validTime() [2/2]

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

Definition at line 92 of file IncrementL95.h.

Here is the caller graph for this function:

◆ write()

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

Definition at line 169 of file IncrementL95.cc.

Here is the call graph for this function:

◆ zero() [1/2]

void lorenz95::IncrementL95::zero ( )

Definition at line 101 of file IncrementL95.cc.

Here is the call graph for this function:

◆ zero() [2/2]

void lorenz95::IncrementL95::zero ( const util::DateTime &  vt)

Definition at line 105 of file IncrementL95.cc.

Here is the call graph for this function:

Member Data Documentation

◆ fld_

FieldL95 lorenz95::IncrementL95::fld_
private

Definition at line 118 of file IncrementL95.h.

◆ time_

util::DateTime lorenz95::IncrementL95::time_
private

Definition at line 119 of file IncrementL95.h.

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