UFO
ufo::ObsBackgroundErrorIdentity Class Reference

An observation operator calculating ObsDiagnostics representing single-level background errors of simulated variables. More...

#include <ObsBackgroundErrorIdentity.h>

Inheritance diagram for ufo::ObsBackgroundErrorIdentity:
Collaboration diagram for ufo::ObsBackgroundErrorIdentity:

Public Types

typedef ObsBackgroundErrorIdentityParameters Parameters_
 

Public Member Functions

 ObsBackgroundErrorIdentity (const ioda::ObsSpace &, const Parameters_ &)
 
virtual ~ObsBackgroundErrorIdentity ()
 
void simulateObs (const GeoVaLs &, ioda::ObsVector &, ObsDiagnostics &) const override
 Obs Operator. More...
 
const oops::Variables & requiredVars () const override
 Operator input required from Model. More...
 
oops::Variables simulatedVars () const override
 List of variables simulated by this operator. More...
 
- Public Member Functions inherited from ufo::ObsOperatorBase
 ObsOperatorBase (const ioda::ObsSpace &odb, const eckit::Configuration &=eckit::LocalConfiguration())
 
virtual ~ObsOperatorBase ()
 
virtual std::unique_ptr< Locationslocations () const
 Locations for GeoVaLs. More...
 

Static Public Member Functions

static const std::string classname ()
 

Private Member Functions

void print (std::ostream &) const override
 

Private Attributes

const ioda::ObsSpace & odb_
 
Parameters_ parameters_
 
oops::Variables requiredVars_
 

Detailed Description

An observation operator calculating ObsDiagnostics representing single-level background errors of simulated variables.

It should be used as a component of the Composite observation operator (with another component handling the calculation of model equivalents of observation). It populates all requested ObsDiagnostics called <var>_background_error, where <var> is the name of a simulated variable, by copying the <var>_background_error GeoVaL at the observation locations.

If the variables option is present, the operator does not calculate the background errors of all simulated variables in the ObsSpace, but only those listed in the variables option.

See ObsBackgroundErrorIdentityParameters for the description of YAML configuration options accepted by this operator.

Example configuration:

obs operator:
  name: Composite
  components:
  # operator used to evaluate H(x)
  - name: identity
    vertical coordinate: geopotential_height  # coordinate used for obs value interpolation
  # operator used to evaluate background errors
  - name: BackgroundErrorIdentity 

Definition at line 72 of file ObsBackgroundErrorIdentity.h.

Member Typedef Documentation

◆ Parameters_

The type of parameters accepted by the constructor of this operator. This typedef is used by the ObsOperatorFactory.

Definition at line 77 of file ObsBackgroundErrorIdentity.h.

Constructor & Destructor Documentation

◆ ObsBackgroundErrorIdentity()

ufo::ObsBackgroundErrorIdentity::ObsBackgroundErrorIdentity ( const ioda::ObsSpace &  odb,
const Parameters_ parameters 
)

Definition at line 29 of file ObsBackgroundErrorIdentity.cc.

◆ ~ObsBackgroundErrorIdentity()

ufo::ObsBackgroundErrorIdentity::~ObsBackgroundErrorIdentity ( )
virtual

Definition at line 45 of file ObsBackgroundErrorIdentity.cc.

Member Function Documentation

◆ classname()

static const std::string ufo::ObsBackgroundErrorIdentity::classname ( )
inlinestatic

Definition at line 79 of file ObsBackgroundErrorIdentity.h.

◆ print()

void ufo::ObsBackgroundErrorIdentity::print ( std::ostream &  os) const
overrideprivatevirtual

Implements ufo::ObsOperatorBase.

Definition at line 75 of file ObsBackgroundErrorIdentity.cc.

◆ requiredVars()

const oops::Variables & ufo::ObsBackgroundErrorIdentity::requiredVars ( ) const
overridevirtual

Operator input required from Model.

Implements ufo::ObsOperatorBase.

Definition at line 66 of file ObsBackgroundErrorIdentity.cc.

◆ simulatedVars()

oops::Variables ufo::ObsBackgroundErrorIdentity::simulatedVars ( ) const
overridevirtual

List of variables simulated by this operator.

The default implementation returns the list of all simulated variables in the ObsSpace.

Reimplemented from ufo::ObsOperatorBase.

Definition at line 70 of file ObsBackgroundErrorIdentity.cc.

◆ simulateObs()

void ufo::ObsBackgroundErrorIdentity::simulateObs ( const GeoVaLs ,
ioda::ObsVector &  ,
ObsDiagnostics  
) const
overridevirtual

Obs Operator.

Implements ufo::ObsOperatorBase.

Definition at line 49 of file ObsBackgroundErrorIdentity.cc.

Here is the call graph for this function:

Member Data Documentation

◆ odb_

const ioda::ObsSpace& ufo::ObsBackgroundErrorIdentity::odb_
private

Definition at line 95 of file ObsBackgroundErrorIdentity.h.

◆ parameters_

Parameters_ ufo::ObsBackgroundErrorIdentity::parameters_
private

Definition at line 96 of file ObsBackgroundErrorIdentity.h.

◆ requiredVars_

oops::Variables ufo::ObsBackgroundErrorIdentity::requiredVars_
private

Definition at line 97 of file ObsBackgroundErrorIdentity.h.


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