Cost Function. More...

#include <CostFunction.h>

Inheritance diagram for oops::CostFunction< MODEL, OBS >:

[legend]

Collaboration diagram for oops::CostFunction< MODEL, OBS >:

Public Member Functions
	CostFunction (const eckit::Configuration &)

virtual	~CostFunction ()

double	evaluate (const CtrlVar_ &, const eckit::Configuration &config=eckit::LocalConfiguration(), PostProcessor< State_ > post=PostProcessor< State_ >())

double	linearize (const CtrlVar_ &, const eckit::Configuration &, PostProcessor< State_ > post=PostProcessor< State_ >())

virtual void	runTLM (CtrlInc_ &, PostProcessorTLAD< MODEL > &, PostProcessor< Increment_ > post=PostProcessor< Increment_ >(), const bool idModel=false) const =0

virtual void	runADJ (CtrlInc_ &, PostProcessorTLAD< MODEL > &, PostProcessor< Increment_ > post=PostProcessor< Increment_ >(), const bool idModel=false) const =0

virtual void	zeroAD (CtrlInc_ &) const =0

virtual void	runNL (CtrlVar_ &, PostProcessor< State_ > &) const =0

void	addIncrement (CtrlVar_ &, const CtrlInc_ &, PostProcessor< Increment_ > post=PostProcessor< Increment_ >()) const

void	resetLinearization ()

void	computeGradientFG (CtrlInc_ &) const
	Compute cost function gradient at first guess (without Jb). More...

const JbTotal_ &	jb () const
	Access \( J_b\). More...

const CostBase_ &	jterm (const size_t ii) const
	Access terms of the cost function other than \( J_b\). More...

size_t	nterms () const

double	getCostJb () const

double	getCostJoJc () const

Protected Member Functions
void	setupTerms (const eckit::Configuration &)

const CtrlVar_ &	background () const

Private Types
typedef ControlIncrement< MODEL, OBS >	CtrlInc_

typedef ControlVariable< MODEL, OBS >	CtrlVar_

typedef CostJbTotal< MODEL, OBS >	JbTotal_

typedef CostTermBase< MODEL, OBS >	CostBase_

typedef JqTermTLAD< MODEL >	JqTermTLAD_

typedef Geometry< MODEL >	Geometry_

typedef State< MODEL >	State_

typedef Increment< MODEL >	Increment_

Private Member Functions
virtual void	addIncr (CtrlVar_ &, const CtrlInc_ &, PostProcessor< Increment_ > &) const =0

virtual CostJbState< MODEL > *	newJb (const eckit::Configuration &, const Geometry_ &, const CtrlVar_ &) const =0

virtual CostJo< MODEL, OBS > *	newJo (const eckit::Configuration &) const =0

virtual CostTermBase< MODEL, OBS > *	newJc (const eckit::Configuration &, const Geometry_ &) const =0

virtual void	doLinearize (const Geometry_ &, const eckit::Configuration &, const CtrlVar_ &, const CtrlVar_ &, PostProcessor< State_ > &, PostProcessorTLAD< MODEL > &)=0

virtual const Geometry_ &	geometry () const =0

Private Attributes
std::unique_ptr< const CtrlVar_ >	xb_

std::unique_ptr< JbTotal_ >	jb_

boost::ptr_vector< CostBase_ >	jterms_

double	costJb_

double	costJoJc_

Detailed Description

template<typename MODEL, typename OBS>
class oops::CostFunction< MODEL, OBS >

Cost Function.

The CostFunction defines and manages the computation of all the terms of the variational data assimilation cost function.

Definition at line 53 of file CostFunction.h.

Member Typedef Documentation

◆ CostBase_

template<typename MODEL , typename OBS >

typedef CostTermBase<MODEL, OBS> oops::CostFunction< MODEL, OBS >::CostBase_

private

Definition at line 57 of file CostFunction.h.

◆ CtrlInc_

template<typename MODEL , typename OBS >

typedef ControlIncrement<MODEL, OBS> oops::CostFunction< MODEL, OBS >::CtrlInc_

private

Definition at line 54 of file CostFunction.h.

◆ CtrlVar_

template<typename MODEL , typename OBS >

typedef ControlVariable<MODEL, OBS> oops::CostFunction< MODEL, OBS >::CtrlVar_

private

Definition at line 55 of file CostFunction.h.

◆ Geometry_

template<typename MODEL , typename OBS >

typedef Geometry<MODEL> oops::CostFunction< MODEL, OBS >::Geometry_

private

Definition at line 59 of file CostFunction.h.

◆ Increment_

template<typename MODEL , typename OBS >

typedef Increment<MODEL> oops::CostFunction< MODEL, OBS >::Increment_

private

Definition at line 61 of file CostFunction.h.

◆ JbTotal_

template<typename MODEL , typename OBS >

typedef CostJbTotal<MODEL, OBS> oops::CostFunction< MODEL, OBS >::JbTotal_

private

Definition at line 56 of file CostFunction.h.

◆ JqTermTLAD_

template<typename MODEL , typename OBS >

typedef JqTermTLAD<MODEL> oops::CostFunction< MODEL, OBS >::JqTermTLAD_

private

Definition at line 58 of file CostFunction.h.

◆ State_

template<typename MODEL , typename OBS >

typedef State<MODEL> oops::CostFunction< MODEL, OBS >::State_

private

Definition at line 60 of file CostFunction.h.

Constructor & Destructor Documentation

◆ CostFunction()

template<typename MODEL , typename OBS >

oops::CostFunction< MODEL, OBS >::CostFunction ( const eckit::Configuration & config )

explicit

Definition at line 187 of file CostFunction.h.

◆ ~CostFunction()

template<typename MODEL , typename OBS >

virtual oops::CostFunction< MODEL, OBS >::~CostFunction ( )

inlinevirtual

Definition at line 65 of file CostFunction.h.

Member Function Documentation

◆ addIncr()

template<typename MODEL , typename OBS >

virtual void oops::CostFunction< MODEL, OBS >::addIncr	(	CtrlVar_ &	,
		const CtrlInc_ &	,
		PostProcessor< Increment_ > &
	)		const

privatepure virtual

Implemented in oops::CostFctWeak< MODEL, OBS >, oops::CostFct4DVar< MODEL, OBS >, oops::CostFct4DEnsVar< MODEL, OBS >, and oops::CostFct3DVar< MODEL, OBS >.

◆ addIncrement()

template<typename MODEL , typename OBS >

void oops::CostFunction< MODEL, OBS >::addIncrement	(	CtrlVar_ &	xx,
		const CtrlInc_ &	dx,
		PostProcessor< Increment_ >	post = `PostProcessor<Increment_>()`
	)		const

Definition at line 312 of file CostFunction.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ background()

template<typename MODEL , typename OBS >

const CtrlVar_& oops::CostFunction< MODEL, OBS >::background ( ) const

inlineprotected

Definition at line 100 of file CostFunction.h.

◆ computeGradientFG()

template<typename MODEL , typename OBS >

void oops::CostFunction< MODEL, OBS >::computeGradientFG ( CtrlInc_ & grad ) const

Compute cost function gradient at first guess (without Jb).

Definition at line 288 of file CostFunction.h.

◆ doLinearize()

template<typename MODEL , typename OBS >

virtual void oops::CostFunction< MODEL, OBS >::doLinearize	(	const Geometry_ &	,
		const eckit::Configuration &	,
		const CtrlVar_ &	,
		const CtrlVar_ &	,
		PostProcessor< State_ > &	,
		PostProcessorTLAD< MODEL > &
	)

privatepure virtual

Implemented in oops::CostFctWeak< MODEL, OBS >, oops::CostFct4DVar< MODEL, OBS >, oops::CostFct4DEnsVar< MODEL, OBS >, and oops::CostFct3DVar< MODEL, OBS >.

◆ evaluate()

template<typename MODEL , typename OBS >

double oops::CostFunction< MODEL, OBS >::evaluate	(	const CtrlVar_ &	fguess,
		const eckit::Configuration &	config = `eckit::LocalConfiguration()`,
		PostProcessor< State_ >	post = `PostProcessor<State_>()`
	)

Definition at line 222 of file CostFunction.h.

◆ geometry()

template<typename MODEL , typename OBS >

virtual const Geometry_& oops::CostFunction< MODEL, OBS >::geometry ( ) const

privatepure virtual

Implemented in oops::CostFctWeak< MODEL, OBS >, oops::CostFct4DVar< MODEL, OBS >, oops::CostFct4DEnsVar< MODEL, OBS >, and oops::CostFct3DVar< MODEL, OBS >.

◆ getCostJb()

template<typename MODEL , typename OBS >

double oops::CostFunction< MODEL, OBS >::getCostJb ( ) const

inline

Definition at line 95 of file CostFunction.h.

◆ getCostJoJc()

template<typename MODEL , typename OBS >

double oops::CostFunction< MODEL, OBS >::getCostJoJc ( ) const

inline

Definition at line 96 of file CostFunction.h.

◆ jb()

template<typename MODEL , typename OBS >

const JbTotal_& oops::CostFunction< MODEL, OBS >::jb ( ) const

inline

Access \( J_b\).

Definition at line 91 of file CostFunction.h.

Here is the caller graph for this function:

◆ jterm()

template<typename MODEL , typename OBS >

const CostBase_& oops::CostFunction< MODEL, OBS >::jterm ( const size_t ii ) const

inline

Access terms of the cost function other than \( J_b\).

Definition at line 93 of file CostFunction.h.

Here is the caller graph for this function:

◆ linearize()

template<typename MODEL , typename OBS >

double oops::CostFunction< MODEL, OBS >::linearize	(	const CtrlVar_ &	fguess,
		const eckit::Configuration &	innerConf,
		PostProcessor< State_ >	post = `PostProcessor<State_>()`
	)

Definition at line 254 of file CostFunction.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ newJb()

template<typename MODEL , typename OBS >

virtual CostJbState<MODEL>* oops::CostFunction< MODEL, OBS >::newJb	(	const eckit::Configuration &	,
		const Geometry_ &	,
		const CtrlVar_ &
	)		const

privatepure virtual

Implemented in oops::CostFctWeak< MODEL, OBS >, oops::CostFct4DVar< MODEL, OBS >, oops::CostFct4DEnsVar< MODEL, OBS >, and oops::CostFct3DVar< MODEL, OBS >.

◆ newJc()

template<typename MODEL , typename OBS >

virtual CostTermBase<MODEL, OBS>* oops::CostFunction< MODEL, OBS >::newJc	(	const eckit::Configuration &	,
		const Geometry_ &
	)		const

privatepure virtual

Implemented in oops::CostFctWeak< MODEL, OBS >, oops::CostFct4DVar< MODEL, OBS >, oops::CostFct4DEnsVar< MODEL, OBS >, and oops::CostFct3DVar< MODEL, OBS >.

◆ newJo()

template<typename MODEL , typename OBS >

virtual CostJo<MODEL, OBS>* oops::CostFunction< MODEL, OBS >::newJo ( const eckit::Configuration & ) const

privatepure virtual

Implemented in oops::CostFctWeak< MODEL, OBS >, oops::CostFct4DVar< MODEL, OBS >, oops::CostFct4DEnsVar< MODEL, OBS >, and oops::CostFct3DVar< MODEL, OBS >.

◆ nterms()

template<typename MODEL , typename OBS >

size_t oops::CostFunction< MODEL, OBS >::nterms ( ) const

inline

Definition at line 94 of file CostFunction.h.

Here is the caller graph for this function:

◆ resetLinearization()

template<typename MODEL , typename OBS >

void oops::CostFunction< MODEL, OBS >::resetLinearization

Definition at line 330 of file CostFunction.h.

Here is the caller graph for this function:

◆ runADJ()

template<typename MODEL , typename OBS >

virtual void oops::CostFunction< MODEL, OBS >::runADJ	(	CtrlInc_ &	,
		PostProcessorTLAD< MODEL > &	,
		PostProcessor< Increment_ >	post = `PostProcessor< Increment_ >()`,
		const bool	idModel = `false`
	)		const

pure virtual

Implemented in oops::CostFct3DVar< MODEL, OBS >, oops::CostFctWeak< MODEL, OBS >, oops::CostFct4DVar< MODEL, OBS >, and oops::CostFct4DEnsVar< MODEL, OBS >.

Here is the caller graph for this function:

◆ runNL()

template<typename MODEL , typename OBS >

virtual void oops::CostFunction< MODEL, OBS >::runNL	(	CtrlVar_ &	,
		PostProcessor< State_ > &
	)		const

pure virtual

Implemented in oops::CostFctWeak< MODEL, OBS >, oops::CostFct4DVar< MODEL, OBS >, oops::CostFct4DEnsVar< MODEL, OBS >, and oops::CostFct3DVar< MODEL, OBS >.

◆ runTLM()

template<typename MODEL , typename OBS >

virtual void oops::CostFunction< MODEL, OBS >::runTLM	(	CtrlInc_ &	,
		PostProcessorTLAD< MODEL > &	,
		PostProcessor< Increment_ >	post = `PostProcessor< Increment_ >()`,
		const bool	idModel = `false`
	)		const

pure virtual

Implemented in oops::CostFct3DVar< MODEL, OBS >, oops::CostFctWeak< MODEL, OBS >, oops::CostFct4DVar< MODEL, OBS >, and oops::CostFct4DEnsVar< MODEL, OBS >.

Here is the caller graph for this function:

◆ setupTerms()

template<typename MODEL , typename OBS >

void oops::CostFunction< MODEL, OBS >::setupTerms ( const eckit::Configuration & config )

protected

Definition at line 194 of file CostFunction.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ zeroAD()

template<typename MODEL , typename OBS >

virtual void oops::CostFunction< MODEL, OBS >::zeroAD ( CtrlInc_ & ) const

pure virtual

Implemented in oops::CostFctWeak< MODEL, OBS >, oops::CostFct4DVar< MODEL, OBS >, oops::CostFct4DEnsVar< MODEL, OBS >, and oops::CostFct3DVar< MODEL, OBS >.

Here is the caller graph for this function:

Member Data Documentation

◆ costJb_

template<typename MODEL , typename OBS >

double oops::CostFunction< MODEL, OBS >::costJb_

mutableprivate

Definition at line 120 of file CostFunction.h.

◆ costJoJc_

template<typename MODEL , typename OBS >

double oops::CostFunction< MODEL, OBS >::costJoJc_

mutableprivate

Definition at line 121 of file CostFunction.h.

◆ jb_

template<typename MODEL , typename OBS >

std::unique_ptr<JbTotal_> oops::CostFunction< MODEL, OBS >::jb_

private

Definition at line 117 of file CostFunction.h.

◆ jterms_

template<typename MODEL , typename OBS >

boost::ptr_vector<CostBase_> oops::CostFunction< MODEL, OBS >::jterms_

private

Definition at line 118 of file CostFunction.h.

◆ xb_

template<typename MODEL , typename OBS >

std::unique_ptr<const CtrlVar_> oops::CostFunction< MODEL, OBS >::xb_

private

Definition at line 116 of file CostFunction.h.

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

CostFunction.h

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

template<typename MODEL, typename OBS> class oops::CostFunction< MODEL, OBS >

Member Typedef Documentation

◆ CostBase_

◆ CtrlInc_

◆ CtrlVar_

◆ Geometry_

◆ Increment_

◆ JbTotal_

◆ JqTermTLAD_

◆ State_

Constructor & Destructor Documentation

◆ CostFunction()

◆ ~CostFunction()

Member Function Documentation

◆ addIncr()

◆ addIncrement()

◆ background()

◆ computeGradientFG()

◆ doLinearize()

◆ evaluate()

◆ geometry()

◆ getCostJb()

◆ getCostJoJc()

◆ jb()

◆ jterm()

◆ linearize()

◆ newJb()

◆ newJc()

◆ newJo()

◆ nterms()

◆ resetLinearization()

◆ runADJ()

◆ runNL()

◆ runTLM()

◆ setupTerms()

◆ zeroAD()

Member Data Documentation

◆ costJb_

◆ costJoJc_

◆ jb_

◆ jterms_

◆ xb_

template<typename MODEL, typename OBS>
class oops::CostFunction< MODEL, OBS >