ufo::GeoVaLs Class Reference

GeoVaLs: geophysical values at locations. More...

#include <GeoVaLs.h>

Inheritance diagram for ufo::GeoVaLs:

Collaboration diagram for ufo::GeoVaLs:

Public Member Functions
	GeoVaLs (const ioda::Locations &, const oops::Variables &)
	GeoVaLs (const eckit::Configuration &, const oops::Variables &)
	GeoVaLs (const GeoVaLs &)
	Copy constructor. More...
	~GeoVaLs ()
void	abs ()
	Absolute value. 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. More...
double	dot_product_with (const GeoVaLs &other) const
void	read (const eckit::Configuration &)
void	analytic_init (const ioda::Locations &, const eckit::Configuration &)
	Analytic initialization for GeoVaLs. More...
void	write (const eckit::Configuration &) const
int &	toFortran ()
const int &	toFortran () const

Static Public Member Functions
static const std::string	classname ()

Private Member Functions
void	print (std::ostream &) const

Private Attributes
F90goms	keyGVL_
oops::Variables	vars_

Detailed Description

GeoVaLs: geophysical values at locations.

Definition at line 32 of file ufo/src/ufo/GeoVaLs.h.

Constructor & Destructor Documentation

GeoVaLs() [1/3]

ufo::GeoVaLs::GeoVaLs	(	const ioda::Locations &	locs,
		const oops::Variables &	vars
	)

Definition at line 23 of file GeoVaLs.cc.

Here is the call graph for this function:

GeoVaLs() [2/3]

ufo::GeoVaLs::GeoVaLs	(	const eckit::Configuration &	config,
		const oops::Variables &	vars
	)

Definition at line 32 of file GeoVaLs.cc.

Here is the call graph for this function:

GeoVaLs() [3/3]

ufo::GeoVaLs::GeoVaLs

(

const GeoVaLs &

other

)

Copy constructor.

Definition at line 51 of file GeoVaLs.cc.

Here is the call graph for this function:

~GeoVaLs()

ufo::GeoVaLs::~GeoVaLs

(

)

Definition at line 62 of file GeoVaLs.cc.

Here is the call graph for this function:

Member Function Documentation

abs()

void ufo::GeoVaLs::abs

(

)

Absolute value.

Definition at line 92 of file GeoVaLs.cc.

Here is the call graph for this function:

analytic_init()

void ufo::GeoVaLs::analytic_init	(	const ioda::Locations &	locs,
		const eckit::Configuration &	config
	)

Analytic initialization for GeoVaLs.

This ufo::GeoVaLs constructor was introduced in May, 2018 for use with the interpolation test. If "analytic_init" is not specified in the configuration then this does nothing. If "analytic_init" is specified, then the values are replaced by values computed directly from one of several idealized analytic states.

Date

May, 2018: Created (M. Miesch, JCSDA)

June, 2018: Split off from constructor into independent method (M. Miesch, JCSDA)

Definition at line 78 of file GeoVaLs.cc.

Here is the call graph for this function:

classname()

static const std::string ufo::GeoVaLs::classname ( )

inlinestatic

Definition at line 35 of file ufo/src/ufo/GeoVaLs.h.

dot_product_with()

double ufo::GeoVaLs::dot_product_with

(

const GeoVaLs &

other

)

const

Definition at line 137 of file GeoVaLs.cc.

Here is the call graph for this function:

norm()

double ufo::GeoVaLs::norm

(

)

const

Definition at line 96 of file GeoVaLs.cc.

Here is the call graph for this function:

operator*=()

GeoVaLs & ufo::GeoVaLs::operator*=

(

const double

zz

)

Definition at line 106 of file GeoVaLs.cc.

Here is the call graph for this function:

operator+=()

GeoVaLs & ufo::GeoVaLs::operator+=

(

const GeoVaLs &

other

)

Definition at line 116 of file GeoVaLs.cc.

Here is the call graph for this function:

operator-=()

GeoVaLs & ufo::GeoVaLs::operator-=

(

const GeoVaLs &

other

)

Definition at line 121 of file GeoVaLs.cc.

Here is the call graph for this function:

operator/=()

GeoVaLs & ufo::GeoVaLs::operator/=

(

const GeoVaLs &

other

)

GeoVaLs normalization.

This operator is used to normalize each element of the input GeoVaLs object (LHS) with the rms values of each variable on the RHS, across all locations

Definition at line 132 of file GeoVaLs.cc.

Here is the call graph for this function:

operator=()

GeoVaLs & ufo::GeoVaLs::operator=

(

const GeoVaLs &

rhs

)

Definition at line 111 of file GeoVaLs.cc.

Here is the call graph for this function:

print()

void ufo::GeoVaLs::print ( std::ostream &  os ) const

private

Verbose print statement (debug mode)

If the min value across all variables is positive, then this may be an error measurement. If so, compute the rms over the vertical profile and tell the user where the maximum rms value occurs, in terms of the observation number and the variable number. This is intended to help with debugging.

Definition at line 143 of file GeoVaLs.cc.

Here is the call graph for this function:

random()

void ufo::GeoVaLs::random

(

)

Definition at line 102 of file GeoVaLs.cc.

Here is the call graph for this function:

read()

void ufo::GeoVaLs::read

(

const eckit::Configuration &

config

)

Definition at line 172 of file GeoVaLs.cc.

Here is the call graph for this function:

toFortran() [1/2]

int& ufo::GeoVaLs::toFortran ( )

inline

Definition at line 60 of file ufo/src/ufo/GeoVaLs.h.

Here is the caller graph for this function:

toFortran() [2/2]

const int& ufo::GeoVaLs::toFortran ( ) const

inline

Definition at line 61 of file ufo/src/ufo/GeoVaLs.h.

write()

void ufo::GeoVaLs::write

(

const eckit::Configuration &

config

)

const

Definition at line 178 of file GeoVaLs.cc.

Here is the call graph for this function:

zero()

void ufo::GeoVaLs::zero

(

)

Definition at line 87 of file GeoVaLs.cc.

Here is the call graph for this function:

Member Data Documentation

keyGVL_

F90goms ufo::GeoVaLs::keyGVL_

private

Definition at line 66 of file ufo/src/ufo/GeoVaLs.h.

vars_

oops::Variables ufo::GeoVaLs::vars_

private

Definition at line 67 of file ufo/src/ufo/GeoVaLs.h.

---

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

• ufo/src/ufo/GeoVaLs.h
• GeoVaLs.cc