oops::AnalyticInit< OBS > Class Template Reference

Initializes GeoVaLs with analytic formula. More...

#include <AnalyticInit.h>

Inheritance diagram for oops::AnalyticInit< OBS >:

Collaboration diagram for oops::AnalyticInit< OBS >:

Public Member Functions
	AnalyticInit (const eckit::Configuration &)
	constructor (parameters from config) More...
	~AnalyticInit ()
	destructor and copy/move constructors/assignments More...
	AnalyticInit (const AnalyticInit &)=delete
	AnalyticInit (AnalyticInit &&)=delete
AnalyticInit &	operator= (const AnalyticInit &)=delete
AnalyticInit &	operator= (AnalyticInit &&)=delete
void	fillGeoVaLs (const Locations_ &, GeoVaLs_ &) const
	Fill GeoVaLs with values computed by analytic function. More...

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

Private Types
typedef OBS::AnalyticInit	AnalyticInit_
typedef GeoVaLs< OBS >	GeoVaLs_
typedef Locations< OBS >	Locations_

Private Attributes
std::unique_ptr< AnalyticInit_ >	analytic_

Detailed Description

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

Initializes GeoVaLs with analytic formula.

Definition at line 24 of file src/oops/interface/AnalyticInit.h.

Member Typedef Documentation

AnalyticInit_

template<typename OBS >

typedef OBS::AnalyticInit oops::AnalyticInit< OBS >::AnalyticInit_

private

Definition at line 25 of file src/oops/interface/AnalyticInit.h.

GeoVaLs_

template<typename OBS >

typedef GeoVaLs<OBS> oops::AnalyticInit< OBS >::GeoVaLs_

private

Definition at line 26 of file src/oops/interface/AnalyticInit.h.

Locations_

template<typename OBS >

typedef Locations<OBS> oops::AnalyticInit< OBS >::Locations_

private

Definition at line 27 of file src/oops/interface/AnalyticInit.h.

Constructor & Destructor Documentation

AnalyticInit() [1/3]

template<typename OBS >

oops::AnalyticInit< OBS >::AnalyticInit ( const eckit::Configuration &  conf )

explicit

constructor (parameters from config)

Definition at line 52 of file src/oops/interface/AnalyticInit.h.

~AnalyticInit()

template<typename OBS >

oops::AnalyticInit< OBS >::~AnalyticInit

destructor and copy/move constructors/assignments

Definition at line 62 of file src/oops/interface/AnalyticInit.h.

AnalyticInit() [2/3]

template<typename OBS >

oops::AnalyticInit< OBS >::AnalyticInit ( const AnalyticInit< OBS > &  )

delete

AnalyticInit() [3/3]

template<typename OBS >

oops::AnalyticInit< OBS >::AnalyticInit ( AnalyticInit< OBS > &&  )

delete

Member Function Documentation

classname()

template<typename OBS >

static const std::string oops::AnalyticInit< OBS >::classname ( )

inlinestatic

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

fillGeoVaLs()

template<typename OBS >

void oops::AnalyticInit< OBS >::fillGeoVaLs	(	const Locations_ &	locs,
		GeoVaLs_ &	gvals
	)		const

Fill GeoVaLs with values computed by analytic function.

GeoVaLs Analytic Initialization.

AnalyticInit() was introduced in May, 2018 (initially as a GeoVaLs 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 gvals) that represents the output of the State::interpolate() method. The state.state generate 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 91 of file src/oops/interface/AnalyticInit.h.

Here is the call graph for this function:

operator=() [1/2]

template<typename OBS >

AnalyticInit& oops::AnalyticInit< OBS >::operator= ( AnalyticInit< OBS > &&  )

delete

operator=() [2/2]

template<typename OBS >

AnalyticInit& oops::AnalyticInit< OBS >::operator= ( const AnalyticInit< OBS > &  )

delete

Member Data Documentation

analytic_

template<typename OBS >

std::unique_ptr<AnalyticInit_> oops::AnalyticInit< OBS >::analytic_

private

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

---

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

• src/oops/interface/AnalyticInit.h