OOPS
Public Member Functions | Static Public Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
oops::GeoVaLs< OBS > Class Template Reference

#include <GeoVaLs.h>

Inheritance diagram for oops::GeoVaLs< OBS >:
Inheritance graph
[legend]
Collaboration diagram for oops::GeoVaLs< OBS >:
Collaboration graph
[legend]

Public Member Functions

 GeoVaLs (const Locations_ &locs, const Variables &, const std::vector< size_t > &sizes)
 
 GeoVaLs (const eckit::Configuration &, const ObsSpace_ &, const Variables &)
 
 GeoVaLs (const GeoVaLs &)
 
 ~GeoVaLs ()
 
const GeoVaLs_ & geovals () const
 Interfacing. More...
 
GeoVaLs_ & geovals ()
 
void zero ()
 Linear algebra and utilities, mostly for writing tests. More...
 
void random ()
 
double rms () const
 
double normalizedrms (const GeoVaLs &) const
 
GeoVaLs & operator= (const GeoVaLs &)
 
GeoVaLs & operator*= (const double &)
 
GeoVaLs & operator+= (const GeoVaLs &)
 
GeoVaLs & operator-= (const GeoVaLs &)
 
GeoVaLs & operator*= (const GeoVaLs &)
 
double dot_product_with (const GeoVaLs &) const
 
void read (const eckit::Configuration &)
 
void write (const eckit::Configuration &) const
 

Static Public Member Functions

static const std::string classname ()
 

Private Types

typedef OBS::GeoVaLs GeoVaLs_
 
typedef ObsSpace< OBS > ObsSpace_
 
typedef Locations< OBS > Locations_
 

Private Member Functions

void print (std::ostream &) const
 

Private Attributes

std::unique_ptr< GeoVaLs_ > gvals_
 

Detailed Description

template<typename OBS>
class oops::GeoVaLs< OBS >

Definition at line 32 of file oops/interface/GeoVaLs.h.

Member Typedef Documentation

◆ GeoVaLs_

template<typename OBS >
typedef OBS::GeoVaLs oops::GeoVaLs< OBS >::GeoVaLs_
private

Definition at line 34 of file oops/interface/GeoVaLs.h.

◆ Locations_

template<typename OBS >
typedef Locations<OBS> oops::GeoVaLs< OBS >::Locations_
private

Definition at line 36 of file oops/interface/GeoVaLs.h.

◆ ObsSpace_

template<typename OBS >
typedef ObsSpace<OBS> oops::GeoVaLs< OBS >::ObsSpace_
private

Definition at line 35 of file oops/interface/GeoVaLs.h.

Constructor & Destructor Documentation

◆ GeoVaLs() [1/3]

template<typename OBS >
oops::GeoVaLs< OBS >::GeoVaLs ( const Locations_ &  locs,
const Variables &  vars,
const std::vector< size_t > &  sizes 
)

Allocate GeoVaLs for locs locations, to be filled with vars variables. Sizes of GeoVaLs for i-th variable at a single location are defined by i-th value of sizes.

Definition at line 76 of file oops/interface/GeoVaLs.h.

Here is the call graph for this function:

◆ GeoVaLs() [2/3]

template<typename OBS >
oops::GeoVaLs< OBS >::GeoVaLs ( const eckit::Configuration &  conf,
const ObsSpace_ &  ospace,
const Variables &  vars 
)

Definition at line 87 of file oops/interface/GeoVaLs.h.

Here is the call graph for this function:

◆ GeoVaLs() [3/3]

template<typename OBS >
oops::GeoVaLs< OBS >::GeoVaLs ( const GeoVaLs< OBS > &  other)

Definition at line 99 of file oops/interface/GeoVaLs.h.

Here is the call graph for this function:

◆ ~GeoVaLs()

template<typename OBS >
oops::GeoVaLs< OBS >::~GeoVaLs

Definition at line 109 of file oops/interface/GeoVaLs.h.

Member Function Documentation

◆ classname()

template<typename OBS >
static const std::string oops::GeoVaLs< OBS >::classname ( )
inlinestatic

Definition at line 39 of file oops/interface/GeoVaLs.h.

Here is the caller graph for this function:

◆ dot_product_with()

template<typename OBS >
double oops::GeoVaLs< OBS >::dot_product_with ( const GeoVaLs< OBS > &  other) const

Definition at line 119 of file oops/interface/GeoVaLs.h.

◆ geovals() [1/2]

template<typename OBS >
GeoVaLs_& oops::GeoVaLs< OBS >::geovals ( )
inline

Definition at line 52 of file oops/interface/GeoVaLs.h.

◆ geovals() [2/2]

template<typename OBS >
const GeoVaLs_& oops::GeoVaLs< OBS >::geovals ( ) const
inline

Interfacing.

Definition at line 51 of file oops/interface/GeoVaLs.h.

Here is the caller graph for this function:

◆ normalizedrms()

template<typename OBS >
double oops::GeoVaLs< OBS >::normalizedrms ( const GeoVaLs< OBS > &  rhs) const

Definition at line 196 of file oops/interface/GeoVaLs.h.

◆ operator*=() [1/2]

template<typename OBS >
GeoVaLs< OBS > & oops::GeoVaLs< OBS >::operator*= ( const double &  zz)

Definition at line 174 of file oops/interface/GeoVaLs.h.

◆ operator*=() [2/2]

template<typename OBS >
GeoVaLs< OBS > & oops::GeoVaLs< OBS >::operator*= ( const GeoVaLs< OBS > &  rhs)

Definition at line 163 of file oops/interface/GeoVaLs.h.

◆ operator+=()

template<typename OBS >
GeoVaLs< OBS > & oops::GeoVaLs< OBS >::operator+= ( const GeoVaLs< OBS > &  rhs)

Definition at line 141 of file oops/interface/GeoVaLs.h.

◆ operator-=()

template<typename OBS >
GeoVaLs< OBS > & oops::GeoVaLs< OBS >::operator-= ( const GeoVaLs< OBS > &  rhs)

Definition at line 152 of file oops/interface/GeoVaLs.h.

◆ operator=()

template<typename OBS >
GeoVaLs< OBS > & oops::GeoVaLs< OBS >::operator= ( const GeoVaLs< OBS > &  rhs)

Definition at line 130 of file oops/interface/GeoVaLs.h.

◆ print()

template<typename OBS >
void oops::GeoVaLs< OBS >::print ( std::ostream &  os) const
private

Definition at line 247 of file oops/interface/GeoVaLs.h.

◆ random()

template<typename OBS >
void oops::GeoVaLs< OBS >::random

Definition at line 217 of file oops/interface/GeoVaLs.h.

◆ read()

template<typename OBS >
void oops::GeoVaLs< OBS >::read ( const eckit::Configuration &  conf)

Definition at line 227 of file oops/interface/GeoVaLs.h.

◆ rms()

template<typename OBS >
double oops::GeoVaLs< OBS >::rms

Definition at line 185 of file oops/interface/GeoVaLs.h.

◆ write()

template<typename OBS >
void oops::GeoVaLs< OBS >::write ( const eckit::Configuration &  conf) const

Definition at line 237 of file oops/interface/GeoVaLs.h.

Here is the caller graph for this function:

◆ zero()

template<typename OBS >
void oops::GeoVaLs< OBS >::zero

Linear algebra and utilities, mostly for writing tests.

Definition at line 207 of file oops/interface/GeoVaLs.h.

Member Data Documentation

◆ gvals_

template<typename OBS >
std::unique_ptr<GeoVaLs_> oops::GeoVaLs< OBS >::gvals_
private

Definition at line 70 of file oops/interface/GeoVaLs.h.

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