oops::ModelAuxControl< MODEL > Class Template Reference

Auxiliary state related to model (could be e.g. model bias), not used at the moment. More...

#include <ModelAuxControl.h>

Inheritance diagram for oops::ModelAuxControl< MODEL >:

Collaboration diagram for oops::ModelAuxControl< MODEL >:

Public Member Functions
	ModelAuxControl (const Geometry_ &resol, const eckit::Configuration &conf)
	Constructor for specified resol and conf. More...
	ModelAuxControl (const Geometry_ &resol, const ModelAuxControl &other)
	Copies other ModelAuxControl, changing its resolution to resol. More...
	ModelAuxControl (const ModelAuxControl &, const bool copy=true)
	~ModelAuxControl ()
	Destructor (defined explicitly for timing and tracing) More...
const ModelAuxControl_ &	modelauxcontrol () const
	const Accessor More...
ModelAuxControl_ &	modelauxcontrol ()
	Accessor. More...
void	read (const eckit::Configuration &)
	Read this ModelAuxControl from file. More...
void	write (const eckit::Configuration &) const
	Write this ModelAuxControl out to file. More...
double	norm () const
	Norm (used in tests) More...

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

Private Types
typedef MODEL::ModelAuxControl	ModelAuxControl_
typedef Geometry< MODEL >	Geometry_

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

Private Attributes
std::unique_ptr< ModelAuxControl_ >	aux_

Detailed Description

template<typename MODEL>
class oops::ModelAuxControl< MODEL >

Auxiliary state related to model (could be e.g. model bias), not used at the moment.

This class is used to manipulate parameters of the model that can be estimated in the assimilation. This includes model bias but could be used for other parameters. This is sometimes referred to as augmented state or augmented control variable in the literature. This class calls the model's implementation of ModelAuxControl.

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

Member Typedef Documentation

Geometry_

template<typename MODEL >

typedef Geometry<MODEL> oops::ModelAuxControl< MODEL >::Geometry_

private

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

ModelAuxControl_

template<typename MODEL >

typedef MODEL::ModelAuxControl oops::ModelAuxControl< MODEL >::ModelAuxControl_

private

Definition at line 44 of file oops/interface/ModelAuxControl.h.

Constructor & Destructor Documentation

ModelAuxControl() [1/3]

template<typename MODEL >

oops::ModelAuxControl< MODEL >::ModelAuxControl	(	const Geometry_ &	resol,
		const eckit::Configuration &	conf
	)

Constructor for specified resol and conf.

Definition at line 81 of file oops/interface/ModelAuxControl.h.

Here is the call graph for this function:

ModelAuxControl() [2/3]

template<typename MODEL >

oops::ModelAuxControl< MODEL >::ModelAuxControl	(	const Geometry_ &	resol,
		const ModelAuxControl< MODEL > &	other
	)

Copies other ModelAuxControl, changing its resolution to resol.

Definition at line 93 of file oops/interface/ModelAuxControl.h.

Here is the call graph for this function:

ModelAuxControl() [3/3]

template<typename MODEL >

oops::ModelAuxControl< MODEL >::ModelAuxControl ( const ModelAuxControl< MODEL > &  other, const bool  copy = true  )

explicit

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

Definition at line 105 of file oops/interface/ModelAuxControl.h.

Here is the call graph for this function:

~ModelAuxControl()

template<typename MODEL >

oops::ModelAuxControl< MODEL >::~ModelAuxControl

Destructor (defined explicitly for timing and tracing)

Definition at line 117 of file oops/interface/ModelAuxControl.h.

Member Function Documentation

classname()

template<typename MODEL >

static const std::string oops::ModelAuxControl< MODEL >::classname ( )

inlinestatic

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

Here is the caller graph for this function:

modelauxcontrol() [1/2]

template<typename MODEL >

ModelAuxControl_& oops::ModelAuxControl< MODEL >::modelauxcontrol ( )

inline

Accessor.

Definition at line 63 of file oops/interface/ModelAuxControl.h.

modelauxcontrol() [2/2]

template<typename MODEL >

const ModelAuxControl_& oops::ModelAuxControl< MODEL >::modelauxcontrol ( ) const

inline

const Accessor

Definition at line 61 of file oops/interface/ModelAuxControl.h.

Here is the caller graph for this function:

norm()

template<typename MODEL >

double oops::ModelAuxControl< MODEL >::norm

Norm (used in tests)

Definition at line 147 of file oops/interface/ModelAuxControl.h.

operator=()

template<typename MODEL >

ModelAuxControl& oops::ModelAuxControl< MODEL >::operator= ( const ModelAuxControl< MODEL > &  )

private

print()

template<typename MODEL >

void oops::ModelAuxControl< MODEL >::print ( std::ostream &  os ) const

private

Definition at line 158 of file oops/interface/ModelAuxControl.h.

read()

template<typename MODEL >

void oops::ModelAuxControl< MODEL >::read

(

const eckit::Configuration &

conf

)

Read this ModelAuxControl from file.

Definition at line 127 of file oops/interface/ModelAuxControl.h.

write()

template<typename MODEL >

void oops::ModelAuxControl< MODEL >::write

(

const eckit::Configuration &

conf

)

const

Write this ModelAuxControl out to file.

Definition at line 137 of file oops/interface/ModelAuxControl.h.

Member Data Documentation

aux_

template<typename MODEL >

std::unique_ptr<ModelAuxControl_> oops::ModelAuxControl< MODEL >::aux_

private

Definition at line 75 of file oops/interface/ModelAuxControl.h.

---

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

• oops/interface/ModelAuxControl.h