UFO
Public Types | Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
ufo::ObsCategoricalTLAD Class Reference

Categorical observation operator TL/AD code. Please refer to the Categorical observation operator for further documentation. More...

#include <ObsCategoricalTLAD.h>

Inheritance diagram for ufo::ObsCategoricalTLAD:
Inheritance graph
[legend]
Collaboration diagram for ufo::ObsCategoricalTLAD:
Collaboration graph
[legend]

Public Types

typedef ObsCategoricalParameters Parameters_
 

Public Member Functions

 ObsCategoricalTLAD (const ioda::ObsSpace &, const Parameters_ &)
 
 ~ObsCategoricalTLAD () override
 
void setTrajectory (const GeoVaLs &, ObsDiagnostics &) override
 Obs Operator. More...
 
void simulateObsTL (const GeoVaLs &, ioda::ObsVector &) const override
 
void simulateObsAD (GeoVaLs &, const ioda::ObsVector &) const override
 
const oops::Variables & requiredVars () const override
 Operator input required from Model. More...
 
- Public Member Functions inherited from ufo::LinearObsOperatorBase
 LinearObsOperatorBase (const ioda::ObsSpace &odb)
 
virtual ~LinearObsOperatorBase ()
 
virtual oops::Variables simulatedVars () const
 List of variables simulated by this operator. More...
 
const ioda::ObsSpace & obsspace () const
 The space containing the observations to be simulated by this operator. 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_
 ObsSpace. More...
 
ObsCategoricalData< LinearObsOperatorBase > data_
 Data handler for the Categorical operator and TL/AD code. More...
 

Detailed Description

Categorical observation operator TL/AD code. Please refer to the Categorical observation operator for further documentation.

Definition at line 35 of file ObsCategoricalTLAD.h.

Member Typedef Documentation

◆ Parameters_

typedef ObsCategoricalParameters ufo::ObsCategoricalTLAD::Parameters_

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

Definition at line 40 of file ObsCategoricalTLAD.h.

Constructor & Destructor Documentation

◆ ObsCategoricalTLAD()

ufo::ObsCategoricalTLAD::ObsCategoricalTLAD ( const ioda::ObsSpace &  odb,
const Parameters_ &  params 
)

Definition at line 28 of file ObsCategoricalTLAD.cc.

◆ ~ObsCategoricalTLAD()

ufo::ObsCategoricalTLAD::~ObsCategoricalTLAD ( )
override

Definition at line 41 of file ObsCategoricalTLAD.cc.

Member Function Documentation

◆ classname()

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

Definition at line 42 of file ObsCategoricalTLAD.h.

◆ print()

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

Implements ufo::LinearObsOperatorBase.

Definition at line 119 of file ObsCategoricalTLAD.cc.

◆ requiredVars()

const oops::Variables& ufo::ObsCategoricalTLAD::requiredVars ( ) const
inlineoverridevirtual

Operator input required from Model.

Implements ufo::LinearObsOperatorBase.

Definition at line 51 of file ObsCategoricalTLAD.h.

◆ setTrajectory()

void ufo::ObsCategoricalTLAD::setTrajectory ( const GeoVaLs &  ,
ObsDiagnostics &   
)
overridevirtual

Obs Operator.

Implements ufo::LinearObsOperatorBase.

Definition at line 47 of file ObsCategoricalTLAD.cc.

◆ simulateObsAD()

void ufo::ObsCategoricalTLAD::simulateObsAD ( GeoVaLs &  geovals,
const ioda::ObsVector &  ovec 
) const
overridevirtual

Implements ufo::LinearObsOperatorBase.

Definition at line 83 of file ObsCategoricalTLAD.cc.

Here is the call graph for this function:

◆ simulateObsTL()

void ufo::ObsCategoricalTLAD::simulateObsTL ( const GeoVaLs &  geovals,
ioda::ObsVector &  ovec 
) const
overridevirtual

Implements ufo::LinearObsOperatorBase.

Definition at line 60 of file ObsCategoricalTLAD.cc.

Member Data Documentation

◆ data_

ObsCategoricalData<LinearObsOperatorBase> ufo::ObsCategoricalTLAD::data_
private

Data handler for the Categorical operator and TL/AD code.

Definition at line 61 of file ObsCategoricalTLAD.h.

◆ odb_

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

ObsSpace.

Definition at line 58 of file ObsCategoricalTLAD.h.

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