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

MODEL-agnostic part of tangent-linear and adjoint of the nonlinear observation (forward) operator ObsOperator. More...

#include <LinearObsOperator.h>

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

Public Types

typedef LinearObsOper_::Parameters_ Parameters_
 A subclass of oops::Parameters holding the configuration settings of the operator. More...
 

Public Member Functions

 LinearObsOperator (const ObsSpace_ &obsspace, const Parameters_ &parameters)
 
 ~LinearObsOperator ()
 
void setTrajectory (const GeoVaLs_ &x0, const ObsAuxControl_ &obsaux)
 
void simulateObsTL (const GeoVaLs_ &dx, ObsVector_ &dy, const ObsAuxIncrement_ &dobsaux) const
 
void simulateObsAD (GeoVaLs_ &dx, const ObsVector_ &dy, ObsAuxIncrement_ &dobsaux) const
 
const Variables & requiredVars () const
 

Static Public Member Functions

static const std::string classname ()
 

Private Types

typedef OBS::LinearObsOperator LinearObsOper_
 
typedef GeoVaLs< OBS > GeoVaLs_
 
typedef ObsAuxControl< OBS > ObsAuxControl_
 
typedef ObsAuxIncrement< OBS > ObsAuxIncrement_
 
typedef ObsSpace< OBS > ObsSpace_
 
typedef ObsVector< OBS > ObsVector_
 

Private Member Functions

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

Private Attributes

std::unique_ptr< LinearObsOper_ > oper_
 Pointer to the implementation of LinearObsOperator. More...
 

Detailed Description

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

MODEL-agnostic part of tangent-linear and adjoint of the nonlinear observation (forward) operator ObsOperator.

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: 

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

Definition at line 42 of file oops/interface/LinearObsOperator.h.

Member Typedef Documentation

◆ GeoVaLs_

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

Definition at line 46 of file oops/interface/LinearObsOperator.h.

◆ LinearObsOper_

template<typename OBS >
typedef OBS::LinearObsOperator oops::LinearObsOperator< OBS >::LinearObsOper_
private

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

◆ ObsAuxControl_

template<typename OBS >
typedef ObsAuxControl<OBS> oops::LinearObsOperator< OBS >::ObsAuxControl_
private

Definition at line 47 of file oops/interface/LinearObsOperator.h.

◆ ObsAuxIncrement_

template<typename OBS >
typedef ObsAuxIncrement<OBS> oops::LinearObsOperator< OBS >::ObsAuxIncrement_
private

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

◆ ObsSpace_

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

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

◆ ObsVector_

template<typename OBS >
typedef ObsVector<OBS> oops::LinearObsOperator< OBS >::ObsVector_
private

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

◆ Parameters_

template<typename OBS >
typedef LinearObsOper_::Parameters_ oops::LinearObsOperator< OBS >::Parameters_

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

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

Constructor & Destructor Documentation

◆ LinearObsOperator()

template<typename OBS >
oops::LinearObsOperator< OBS >::LinearObsOperator ( const ObsSpace_ &  obsspace,
const Parameters_ &  parameters 
)

Set up TL and AD of observation operator for the obsspace observations, with parameters defined in parameters.

Definition at line 108 of file oops/interface/LinearObsOperator.h.

Here is the call graph for this function:

◆ ~LinearObsOperator()

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

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

Member Function Documentation

◆ classname()

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

Definition at line 56 of file oops/interface/LinearObsOperator.h.

Here is the caller graph for this function:

◆ print()

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

Print, used for logging.

Definition at line 170 of file oops/interface/LinearObsOperator.h.

◆ requiredVars()

template<typename OBS >
const Variables & oops::LinearObsOperator< OBS >::requiredVars

Variables required from the model Increment to compute TL or AD of the obs operator. These variables will be provided in GeoVaLs passed to simulateObsTL and simulateObsAD. Note: these Variables may be different from variables returned by ObsOperator::requiredVars(), which will be provided in GeoVaLs passed to setTrajectory.

Definition at line 161 of file oops/interface/LinearObsOperator.h.

◆ setTrajectory()

template<typename OBS >
void oops::LinearObsOperator< OBS >::setTrajectory ( const GeoVaLs_ &  x0,
const ObsAuxControl_ &  obsaux 
)

Sets up the trajectory for future calls of simulateObsTL or simulateObsAD. The implementations could e.g. save the trajectory x0, or compute and save the Jacobian of observation operator around x0. Always called before simulateObsTL or simulateObsAD.

Parameters
[in]x0trajectory for linearization of obs operator, State interpolated to observations locations (defined by ObsOperator::locations())
[in]obsauxadditional obs operator input, used in the minimization in Variational DA, e.g. bias correction coefficients or obs operator parameters.

Definition at line 129 of file oops/interface/LinearObsOperator.h.

Here is the call graph for this function:

◆ simulateObsAD()

template<typename OBS >
void oops::LinearObsOperator< OBS >::simulateObsAD ( GeoVaLs_ &  dx,
const ObsVector_ &  dy,
ObsAuxIncrement_ &  dobsaux 
) const

Apply adjoint of the observation operator linearized around the trajectory that was passed to setTrajectory method (which is always called before simulateObsAD).

Parameters
[out]dxoutput of the AD obs operator, Increment interpolated to observations locations.
[in]dyinput of the AD obs operator, perturbation to the ObsVector.
[out]dobsauxadditional output of the AD obs operator, e.g. perturbation to bias coefficients or obs operator parameters.

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

Here is the call graph for this function:

◆ simulateObsTL()

template<typename OBS >
void oops::LinearObsOperator< OBS >::simulateObsTL ( const GeoVaLs_ &  dx,
ObsVector_ &  dy,
const ObsAuxIncrement_ &  dobsaux 
) const

Apply tangent-linear of the observation operator linearized around the trajectory that was passed to setTrajectory method (which is always called before simulateObsTL).

Parameters
[in]dxinput to the TL obs operator, Increment interpolated to observations locations.
[out]dyoutput of the TL obs operator.
[in]dobsauxadditional input to the TL obs operator, e.g. perturbation to bias coefficients or obs operator parameters.

Definition at line 139 of file oops/interface/LinearObsOperator.h.

Here is the call graph for this function:

Member Data Documentation

◆ oper_

template<typename OBS >
std::unique_ptr<LinearObsOper_> oops::LinearObsOperator< OBS >::oper_
private

Pointer to the implementation of LinearObsOperator.

Definition at line 102 of file oops/interface/LinearObsOperator.h.

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