oops::ObsAuxControl< OBS > Class Template Reference

Auxiliary state related to observations, templated on <OBS> More...

#include <ObsAuxControl.h>

Inheritance diagram for oops::ObsAuxControl< OBS >:

Collaboration diagram for oops::ObsAuxControl< OBS >:

Public Types
typedef ObsAuxControl_::Parameters_	Parameters_

Public Member Functions
	ObsAuxControl (const ObsSpace< OBS > &os, const Parameters_ &params)
	Constructor for specified ObsSpace os and params. More...
	ObsAuxControl (const ObsAuxControl &, const bool copy=true)
	~ObsAuxControl ()
	Destructor (defined explicitly for timing and tracing) More...
const ObsAuxControl_ &	obsauxcontrol () const
	const Accessor More...
ObsAuxControl_ &	obsauxcontrol ()
	Accessor. More...
void	read (const Parameters_ &)
	Read this ObsAuxControl from file. More...
void	write (const Parameters_ &) const
	Write this ObsAuxControl out to file. More...
double	norm () const
	Norm (used in tests) More...
const Variables &	requiredVars () const
	Return required inputs variables from Model. More...
const Variables &	requiredHdiagnostics () const
	Return required observations diagnostics. More...
ObsAuxControl &	operator= (const ObsAuxControl &rhs)
	Assign operator from other ObsAuxControl rhs. More...

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

Private Types
typedef OBS::ObsAuxControl	ObsAuxControl_

Private Member Functions
void	print (std::ostream &) const

Private Attributes
std::unique_ptr< ObsAuxControl_ >	aux_

Detailed Description

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

Auxiliary state related to observations, templated on <OBS>

This is currently only used for bias correction coefficients, but can be used for other cases. This class calls the <OBS> implementation of ObsAuxControl.

Definition at line 35 of file oops/interface/ObsAuxControl.h.

Member Typedef Documentation

ObsAuxControl_

template<typename OBS >

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

private

Definition at line 37 of file oops/interface/ObsAuxControl.h.

Parameters_

template<typename OBS >

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

Definition at line 40 of file oops/interface/ObsAuxControl.h.

Constructor & Destructor Documentation

ObsAuxControl() [1/2]

template<typename OBS >

oops::ObsAuxControl< OBS >::ObsAuxControl	(	const ObsSpace< OBS > &	os,
		const Parameters_ &	params
	)

Constructor for specified ObsSpace os and params.

Definition at line 80 of file oops/interface/ObsAuxControl.h.

Here is the call graph for this function:

ObsAuxControl() [2/2]

template<typename OBS >

oops::ObsAuxControl< OBS >::ObsAuxControl ( const ObsAuxControl< OBS > &  other, const bool  copy = true  )

explicit

Creates ObsAuxControl with the same structure as other. Copies other if copy is true, otherwise creates zero ObsAuxControl

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

Here is the call graph for this function:

~ObsAuxControl()

template<typename OBS >

oops::ObsAuxControl< OBS >::~ObsAuxControl

Destructor (defined explicitly for timing and tracing)

Definition at line 103 of file oops/interface/ObsAuxControl.h.

Member Function Documentation

classname()

template<typename OBS >

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

inlinestatic

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

Here is the caller graph for this function:

norm()

template<typename OBS >

double oops::ObsAuxControl< OBS >::norm

Norm (used in tests)

Definition at line 133 of file oops/interface/ObsAuxControl.h.

obsauxcontrol() [1/2]

template<typename OBS >

ObsAuxControl_& oops::ObsAuxControl< OBS >::obsauxcontrol ( )

inline

Accessor.

Definition at line 55 of file oops/interface/ObsAuxControl.h.

obsauxcontrol() [2/2]

template<typename OBS >

const ObsAuxControl_& oops::ObsAuxControl< OBS >::obsauxcontrol ( ) const

inline

const Accessor

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

Here is the caller graph for this function:

operator=()

template<typename OBS >

ObsAuxControl< OBS > & oops::ObsAuxControl< OBS >::operator=

(

const ObsAuxControl< OBS > &

rhs

)

Assign operator from other ObsAuxControl rhs.

Definition at line 163 of file oops/interface/ObsAuxControl.h.

print()

template<typename OBS >

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

private

Definition at line 174 of file oops/interface/ObsAuxControl.h.

read()

template<typename OBS >

void oops::ObsAuxControl< OBS >::read

(

const Parameters_ &

params

)

Read this ObsAuxControl from file.

Definition at line 113 of file oops/interface/ObsAuxControl.h.

requiredHdiagnostics()

template<typename OBS >

const Variables & oops::ObsAuxControl< OBS >::requiredHdiagnostics

Return required observations diagnostics.

Definition at line 154 of file oops/interface/ObsAuxControl.h.

requiredVars()

template<typename OBS >

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

Return required inputs variables from Model.

Definition at line 144 of file oops/interface/ObsAuxControl.h.

write()

template<typename OBS >

void oops::ObsAuxControl< OBS >::write

(

const Parameters_ &

params

)

const

Write this ObsAuxControl out to file.

Definition at line 123 of file oops/interface/ObsAuxControl.h.

Member Data Documentation

aux_

template<typename OBS >

std::unique_ptr<ObsAuxControl_> oops::ObsAuxControl< OBS >::aux_

private

Definition at line 74 of file oops/interface/ObsAuxControl.h.

---

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

• oops/interface/ObsAuxControl.h