MODEL-agnostic part of nonlinear observation (forward) operator. The full nonlinear observation operator from State x to ObsVector is: ObsOperator ( GetValues (State) ) ObsOperator uses GeoVaLs (result of GetValues(State) - model State at observations locations) as input data to compute forward operator. More...

#include <ObsOperator.h>

Inheritance diagram for oops::ObsOperator< OBS >:

[legend]

Collaboration diagram for oops::ObsOperator< OBS >:

[legend]

Public Types
typedef ObsOperator_::Parameters_	Parameters_
	A subclass of oops::Parameters holding the configuration settings of the operator. More...

Public Member Functions
	ObsOperator (const ObsSpace_ &obsspace, const Parameters_ &parameters)

	~ObsOperator ()

void	simulateObs (const GeoVaLs_ &x_int, ObsVector_ &y, const ObsAuxControl_ &obsaux, ObsVector_ &obsbias, ObsDiags_ &obsdiags) const

const Variables &	requiredVars () const

Locations_	locations () const
	Locations used for computing GeoVaLs that will be passed to simulateObs. More...

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

Private Types
typedef OBS::ObsOperator	ObsOperator_

typedef GeoVaLs< OBS >	GeoVaLs_

typedef ObsDiagnostics< OBS >	ObsDiags_

typedef Locations< OBS >	Locations_

typedef ObsAuxControl< OBS >	ObsAuxControl_

typedef ObsVector< OBS >	ObsVector_

typedef ObsSpace< OBS >	ObsSpace_

Private Member Functions
void	print (std::ostream &) const
	Print, used for logging. More...

Private Attributes
std::unique_ptr< ObsOperator_ >	oper_
	Pointer to the implementation of ObsOperator. More...

Detailed Description

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

MODEL-agnostic part of nonlinear observation (forward) operator. The full nonlinear observation operator from State x to ObsVector is: ObsOperator ( GetValues (State) ) ObsOperator uses GeoVaLs (result of GetValues(State) - model State at observations locations) as input data to compute forward operator.

Note: each implementation should typedef Parameters_ to the name of a subclass of oops::Parameters holding its configuration settings and provide a constructor with the following signature:

ObsOperator(const OBS::ObsSpace &, const Parameters_ &);

Definition at line 45 of file oops/interface/ObsOperator.h.

Member Typedef Documentation

◆ GeoVaLs_

template<typename OBS >

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

private

Definition at line 49 of file oops/interface/ObsOperator.h.

◆ Locations_

template<typename OBS >

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

private

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

◆ ObsAuxControl_

template<typename OBS >

typedef ObsAuxControl<OBS> oops::ObsOperator< OBS >::ObsAuxControl_

private

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

◆ ObsDiags_

template<typename OBS >

typedef ObsDiagnostics<OBS> oops::ObsOperator< OBS >::ObsDiags_

private

Definition at line 50 of file oops/interface/ObsOperator.h.

◆ ObsOperator_

template<typename OBS >

typedef OBS::ObsOperator oops::ObsOperator< OBS >::ObsOperator_

private

Definition at line 48 of file oops/interface/ObsOperator.h.

◆ ObsSpace_

template<typename OBS >

typedef ObsSpace<OBS> oops::ObsOperator< OBS >::ObsSpace_

private

Definition at line 54 of file oops/interface/ObsOperator.h.

◆ ObsVector_

template<typename OBS >

typedef ObsVector<OBS> oops::ObsOperator< OBS >::ObsVector_

private

Definition at line 53 of file oops/interface/ObsOperator.h.

◆ Parameters_

template<typename OBS >

typedef ObsOperator_::Parameters_ oops::ObsOperator< OBS >::Parameters_

A subclass of oops::Parameters holding the configuration settings of the operator.

Definition at line 58 of file oops/interface/ObsOperator.h.

Constructor & Destructor Documentation

◆ ObsOperator()

template<typename OBS >

oops::ObsOperator< OBS >::ObsOperator	(	const ObsSpace_ &	obsspace,
		const Parameters_ &	parameters
	)

Set up observation operator for the obsspace observations, with parameters defined in parameters

Definition at line 98 of file oops/interface/ObsOperator.h.

Here is the call graph for this function:

◆ ~ObsOperator()

template<typename OBS >

oops::ObsOperator< OBS >::~ObsOperator

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

Member Function Documentation

◆ classname()

template<typename OBS >

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

inlinestatic

Definition at line 60 of file oops/interface/ObsOperator.h.

Here is the caller graph for this function:

◆ locations()

template<typename OBS >

Locations< OBS > oops::ObsOperator< OBS >::locations

Locations used for computing GeoVaLs that will be passed to simulateObs.

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

Here is the caller graph for this function:

◆ print()

template<typename OBS >

void oops::ObsOperator< OBS >::print ( std::ostream & os ) const

private

Print, used for logging.

Definition at line 150 of file oops/interface/ObsOperator.h.

◆ requiredVars()

template<typename OBS >

const Variables & oops::ObsOperator< OBS >::requiredVars

Variables required from the model State to compute obs operator. These variables will be provided in GeoVaLs passed to simulateObs.

Definition at line 132 of file oops/interface/ObsOperator.h.

Here is the caller graph for this function:

◆ simulateObs()

template<typename OBS >

void oops::ObsOperator< OBS >::simulateObs	(	const GeoVaLs_ &	x_int,
		ObsVector_ &	y,
		const ObsAuxControl_ &	obsaux,
		ObsVector_ &	obsbias,
		ObsDiags_ &	obsdiags
	)		const

Compute forward operator y = ObsOperator (x).

Parameters

[in]	x	obs operator input, State interpolated to observations locations.
[out]	y	result of computing obs operator on `x`.
[in]	obsaux	additional input for computing H(x), used in the minimization in Variational DA, e.g. bias correction coefficients or obs operator parameters.
[out]	obsbias	bias correction of the departure between `y` and the observed values; when `obsbias` is non-zero, it is added to `y` within the obs operator
[out]	obsdiags	additional diagnostics output from computing obs operator that is not used in the assimilation, and can be used by ObsFilters.

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

Here is the call graph for this function:

Member Data Documentation

◆ oper_

template<typename OBS >

std::unique_ptr<ObsOperator_> oops::ObsOperator< OBS >::oper_

private

Pointer to the implementation of ObsOperator.

Definition at line 92 of file oops/interface/ObsOperator.h.

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

oops/interface/ObsOperator.h

Public Types

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

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

Member Typedef Documentation

◆ GeoVaLs_

◆ Locations_

◆ ObsAuxControl_

◆ ObsDiags_

◆ ObsOperator_

◆ ObsSpace_

◆ ObsVector_

◆ Parameters_

Constructor & Destructor Documentation

◆ ObsOperator()

◆ ~ObsOperator()

Member Function Documentation

◆ classname()

◆ locations()

◆ print()

◆ requiredVars()

◆ simulateObs()

Member Data Documentation

◆ oper_

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