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

#include <GeoVaLs.h>

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

Public Member Functions

 GeoVaLs (const Locations_ &, const Variables &)
 
 GeoVaLs (const eckit::Configuration &, const Variables &)
 
 GeoVaLs (const GeoVaLs &)
 
 ~GeoVaLs ()
 
const GeoVaLs_ & geovals () const
 Interfacing. More...
 
GeoVaLs_ & geovals ()
 
void abs ()
 Linear algebra and utilities, mostly for writing tests. More...
 
void zero ()
 
void random ()
 
double norm () const
 
GeoVaLs & operator= (const GeoVaLs &)
 
GeoVaLs & operator*= (const double &)
 
GeoVaLs & operator+= (const GeoVaLs &)
 
GeoVaLs & operator-= (const GeoVaLs &)
 
GeoVaLs & operator/= (const GeoVaLs &)
 GeoVaLs Normalization Operator. More...
 
double dot_product_with (const GeoVaLs &) const
 
void read (const eckit::Configuration &)
 
void analytic_init (const Locations_ &, const eckit::Configuration &)
 GeoVaLs Analytic Initialization. More...
 
void write (const eckit::Configuration &) const
 

Static Public Member Functions

static const std::string classname ()
 

Private Types

typedef MODEL::GeoVaLs GeoVaLs_
 
typedef Locations< MODEL > Locations_
 

Private Member Functions

void print (std::ostream &) const
 

Private Attributes

boost::scoped_ptr< GeoVaLs_ > gvals_
 

Detailed Description

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

Definition at line 30 of file oops/src/oops/interface/GeoVaLs.h.

Member Typedef Documentation

◆ GeoVaLs_

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

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

◆ Locations_

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

Definition at line 33 of file oops/src/oops/interface/GeoVaLs.h.

Constructor & Destructor Documentation

◆ GeoVaLs() [1/3]

template<typename MODEL >
oops::GeoVaLs< MODEL >::GeoVaLs ( const Locations_ &  locs,
const Variables &  vars 
)

Definition at line 71 of file oops/src/oops/interface/GeoVaLs.h.

Here is the call graph for this function:

◆ GeoVaLs() [2/3]

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

Definition at line 81 of file oops/src/oops/interface/GeoVaLs.h.

Here is the call graph for this function:

◆ GeoVaLs() [3/3]

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

Definition at line 92 of file oops/src/oops/interface/GeoVaLs.h.

Here is the call graph for this function:

◆ ~GeoVaLs()

template<typename MODEL >
oops::GeoVaLs< MODEL >::~GeoVaLs ( )

Definition at line 102 of file oops/src/oops/interface/GeoVaLs.h.

Member Function Documentation

◆ abs()

template<typename MODEL >
void oops::GeoVaLs< MODEL >::abs ( )

Linear algebra and utilities, mostly for writing tests.

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

◆ analytic_init()

template<typename MODEL >
void oops::GeoVaLs< MODEL >::analytic_init ( const Locations_ &  locs,
const eckit::Configuration &  conf 
)

GeoVaLs Analytic Initialization.

analytic_init() was introduced in May, 2018 (initially as a constructor) for use with the interpolation test. The interpolation test requires an initialization of a GeoVaLs object based on the same analytic formulae used for the State initialization (see test::TestStateInterpolation() for further information). This in turn requires information about the vertical profile in addition to the latitude and longitude positional information in the Locations object. Currently, this information about the vertical profile is obtained from an existing GeoVaLs object (passed as other) that represents the output of the State::interpolate()
method. The State.StateGenerate section of the configuration file is also passed to this constructor to provide further information required for the analytic initialization.

Date
May, 2018: created as a constructor (M. Miesch, JCSDA)
June, 2018: moved to a method (M. Miesch, JCSDA)
See also
test::TestStateInterpolation()

Definition at line 265 of file oops/src/oops/interface/GeoVaLs.h.

Here is the call graph for this function:

◆ classname()

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

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

Here is the caller graph for this function:

◆ dot_product_with()

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

Definition at line 112 of file oops/src/oops/interface/GeoVaLs.h.

◆ geovals() [1/2]

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

Interfacing.

Definition at line 45 of file oops/src/oops/interface/GeoVaLs.h.

Here is the caller graph for this function:

◆ geovals() [2/2]

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

Definition at line 46 of file oops/src/oops/interface/GeoVaLs.h.

◆ norm()

template<typename MODEL >
double oops::GeoVaLs< MODEL >::norm ( ) const

Definition at line 204 of file oops/src/oops/interface/GeoVaLs.h.

◆ operator*=()

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

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

◆ operator+=()

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

Definition at line 134 of file oops/src/oops/interface/GeoVaLs.h.

◆ operator-=()

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

Definition at line 145 of file oops/src/oops/interface/GeoVaLs.h.

◆ operator/=()

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

GeoVaLs Normalization Operator.

This is a normalization operator that first computes the normalization factor for each variable based on the rms amplitude of that variable across all locations in the reference GeoVaLs object (rhs). Then each element of the input GeoVals object (*this) is divided by these normalization factors.

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

◆ operator=()

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

Definition at line 123 of file oops/src/oops/interface/GeoVaLs.h.

◆ print()

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

Definition at line 276 of file oops/src/oops/interface/GeoVaLs.h.

◆ random()

template<typename MODEL >
void oops::GeoVaLs< MODEL >::random ( )

Definition at line 215 of file oops/src/oops/interface/GeoVaLs.h.

◆ read()

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

Definition at line 225 of file oops/src/oops/interface/GeoVaLs.h.

◆ write()

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

Definition at line 235 of file oops/src/oops/interface/GeoVaLs.h.

Here is the caller graph for this function:

◆ zero()

template<typename MODEL >
void oops::GeoVaLs< MODEL >::zero ( )

Definition at line 194 of file oops/src/oops/interface/GeoVaLs.h.

Member Data Documentation

◆ gvals_

template<typename MODEL >
boost::scoped_ptr<GeoVaLs_> oops::GeoVaLs< MODEL >::gvals_
private

Definition at line 65 of file oops/src/oops/interface/GeoVaLs.h.

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