Control variable increment. More...

#include <ControlIncrement.h>

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

Public Member Functions
	CostJbTotal (const CtrlVar_ &, JbState_ *, const eckit::Configuration &, const Geometry_ &, const ObsSpaces_ &odb)
	Construct \( J_b\). More...

	~CostJbTotal ()
	Destructor. More...

void	initialize (const CtrlVar_ &) const
	Initialize before nonlinear model integration. More...

JqTermTLAD_ *	initializeTraj (const CtrlVar_ &, const Geometry_ &, const eckit::Configuration &)

double	finalize (const CtrlVar_ &) const
	Finalize computation after nonlinear model integration. More...

void	finalizeTraj (JqTermTLAD_ *)

JqTermTLAD_ *	initializeTL () const
	Initialize before starting the TL run. More...

void	finalizeTL (JqTermTLAD_ *, const CtrlInc_ &, CtrlInc_ &) const

JqTermTLAD_ *	initializeAD (CtrlInc_ &, const CtrlInc_ &) const
	Initialize before starting the AD run. More...

void	finalizeAD (JqTermTLAD_ *) const

void	multiplyB (const CtrlInc_ &, CtrlInc_ &) const
	Multiply by covariance matrix and its inverse. More...

void	multiplyBinv (const CtrlInc_ &, CtrlInc_ &) const

void	randomize (CtrlInc_ &) const
	Randomize. More...

void	addGradientFG (CtrlInc_ &) const
	Add Jb gradient at first guess. More...

void	addGradientFG (CtrlInc_ &, CtrlInc_ &) const

const CtrlVar_ &	getBackground () const
	Return background. More...

const CtrlInc_ &	getFirstGuess () const
	Return first guess \( x_0-x_b\). More...

const Geometry_ &	resolution () const
	Jb terms for ControlIncrement constructor. More...

const JbState_ &	jbState () const

const ModelAuxCovar_ &	jbModBias () const

const ObsAuxCovars_ &	jbObsBias () const

const util::DateTime &	windowBegin () const

const util::DateTime &	windowEnd () const

Private Types
typedef ControlIncrement< MODEL, OBS >	CtrlInc_

typedef ControlVariable< MODEL, OBS >	CtrlVar_

typedef State< MODEL >	State_

typedef CostJbState< MODEL >	JbState_

typedef JqTermTLAD< MODEL >	JqTermTLAD_

typedef Geometry< MODEL >	Geometry_

typedef ModelAuxCovariance< MODEL >	ModelAuxCovar_

typedef ObsAuxCovariances< OBS >	ObsAuxCovars_

typedef ObsSpaces< OBS >	ObsSpaces_

Private Member Functions
double	evaluate (const CtrlInc_ &) const

Private Attributes
const CtrlVar_ &	xb_

std::unique_ptr< JbState_ >	jb_

ModelAuxCovar_	jbModBias_

ObsAuxCovars_	jbObsBias_

const CtrlVar_ *	fg_

std::unique_ptr< CtrlInc_ >	dxFG_
	First guess increment \(x_0-x_b\) or more generally \( x_i-M(x_{i-1})\). More...

std::unique_ptr< Geometry_ >	resol_
	Inner loop resolution. More...

const util::DateTime	windowBegin_

const util::DateTime	windowEnd_

Detailed Description

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

Control variable increment.

Total Jb cost function for all components of the control variable.

The control variable acts as a container for the inputs of the variational data assimilation cost functions in physical space. That includes the states at the start the assimilation window or of each sub-window but also additional variables such as model bias, VarBC coefficients, or other control variables for algorithms that use them. The control variable increment contains variations of the control variable.

Definition at line 44 of file ControlIncrement.h.

Member Typedef Documentation

◆ CtrlInc_

template<typename MODEL , typename OBS >

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

private

Definition at line 36 of file CostJbTotal.h.

◆ CtrlVar_

template<typename MODEL , typename OBS >

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

private

Definition at line 37 of file CostJbTotal.h.

◆ Geometry_

template<typename MODEL , typename OBS >

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

private

Definition at line 41 of file CostJbTotal.h.

◆ JbState_

template<typename MODEL , typename OBS >

typedef CostJbState<MODEL> oops::CostJbTotal< MODEL, OBS >::JbState_

private

Definition at line 39 of file CostJbTotal.h.

◆ JqTermTLAD_

template<typename MODEL , typename OBS >

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

private

Definition at line 40 of file CostJbTotal.h.

◆ ModelAuxCovar_

template<typename MODEL , typename OBS >

typedef ModelAuxCovariance<MODEL> oops::CostJbTotal< MODEL, OBS >::ModelAuxCovar_

private

Definition at line 42 of file CostJbTotal.h.

◆ ObsAuxCovars_

template<typename MODEL , typename OBS >

typedef ObsAuxCovariances<OBS> oops::CostJbTotal< MODEL, OBS >::ObsAuxCovars_

private

Definition at line 43 of file CostJbTotal.h.

◆ ObsSpaces_

template<typename MODEL , typename OBS >

typedef ObsSpaces<OBS> oops::CostJbTotal< MODEL, OBS >::ObsSpaces_

private

Definition at line 44 of file CostJbTotal.h.

◆ State_

template<typename MODEL , typename OBS >

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

private

Definition at line 38 of file CostJbTotal.h.

Constructor & Destructor Documentation

◆ CostJbTotal()

template<typename MODEL , typename OBS >

oops::CostJbTotal< MODEL, OBS >::CostJbTotal	(	const CtrlVar_ &	xb,
		JbState_ *	jb,
		const eckit::Configuration &	conf,
		const Geometry_ &	resol,
		const ObsSpaces_ &	odb
	)

Construct \( J_b\).

Definition at line 118 of file CostJbTotal.h.

◆ ~CostJbTotal()

template<typename MODEL , typename OBS >

oops::CostJbTotal< MODEL, OBS >::~CostJbTotal ( )

inline

Destructor.

Definition at line 52 of file CostJbTotal.h.

Member Function Documentation

◆ addGradientFG() [1/2]

template<typename MODEL , typename OBS >

void oops::CostJbTotal< MODEL, OBS >::addGradientFG ( CtrlInc_ & grad ) const

Add Jb gradient at first guess.

Definition at line 239 of file CostJbTotal.h.

◆ addGradientFG() [2/2]

template<typename MODEL , typename OBS >

void oops::CostJbTotal< MODEL, OBS >::addGradientFG	(	CtrlInc_ &	grad,
		CtrlInc_ &	gradJb
	)		const

Definition at line 250 of file CostJbTotal.h.

Here is the call graph for this function:

◆ evaluate()

template<typename MODEL , typename OBS >

double oops::CostJbTotal< MODEL, OBS >::evaluate ( const CtrlInc_ & dx ) const

private

Definition at line 209 of file CostJbTotal.h.

Here is the call graph for this function:

◆ finalize()

template<typename MODEL , typename OBS >

double oops::CostJbTotal< MODEL, OBS >::finalize ( const CtrlVar_ & mx ) const

Finalize computation after nonlinear model integration.

Definition at line 142 of file CostJbTotal.h.

Here is the call graph for this function:

◆ finalizeAD()

template<typename MODEL , typename OBS >

void oops::CostJbTotal< MODEL, OBS >::finalizeAD ( JqTermTLAD_ * jqad ) const

Definition at line 294 of file CostJbTotal.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ finalizeTL()

template<typename MODEL , typename OBS >

void oops::CostJbTotal< MODEL, OBS >::finalizeTL	(	JqTermTLAD_ *	jqtl,
		const CtrlInc_ &	bgns,
		CtrlInc_ &	dx
	)		const

Definition at line 271 of file CostJbTotal.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ finalizeTraj()

template<typename MODEL , typename OBS >

void oops::CostJbTotal< MODEL, OBS >::finalizeTraj ( JqTermTLAD_ * jqlin )

Definition at line 186 of file CostJbTotal.h.

Here is the call graph for this function:

◆ getBackground()

template<typename MODEL , typename OBS >

const CtrlVar_& oops::CostJbTotal< MODEL, OBS >::getBackground ( ) const

inline

Return background.

Definition at line 83 of file CostJbTotal.h.

◆ getFirstGuess()

template<typename MODEL , typename OBS >

const CtrlInc_& oops::CostJbTotal< MODEL, OBS >::getFirstGuess ( ) const

inline

Return first guess \( x_0-x_b\).

Definition at line 86 of file CostJbTotal.h.

◆ initialize()

template<typename MODEL , typename OBS >

void oops::CostJbTotal< MODEL, OBS >::initialize ( const CtrlVar_ & fg ) const

Initialize before nonlinear model integration.

Definition at line 133 of file CostJbTotal.h.

◆ initializeAD()

template<typename MODEL , typename OBS >

JqTermTLAD< MODEL > * oops::CostJbTotal< MODEL, OBS >::initializeAD	(	CtrlInc_ &	bgns,
		const CtrlInc_ &	dx
	)		const

Initialize before starting the AD run.

Definition at line 282 of file CostJbTotal.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initializeTL()

template<typename MODEL , typename OBS >

JqTermTLAD< MODEL > * oops::CostJbTotal< MODEL, OBS >::initializeTL

Initialize before starting the TL run.

Definition at line 261 of file CostJbTotal.h.

Here is the caller graph for this function:

◆ initializeTraj()

template<typename MODEL , typename OBS >

JqTermTLAD< MODEL > * oops::CostJbTotal< MODEL, OBS >::initializeTraj	(	const CtrlVar_ &	fg,
		const Geometry_ &	resol,
		const eckit::Configuration &	inner
	)

Definition at line 166 of file CostJbTotal.h.

Here is the call graph for this function:

◆ jbModBias()

template<typename MODEL , typename OBS >

const ModelAuxCovar_& oops::CostJbTotal< MODEL, OBS >::jbModBias ( ) const

inline

Definition at line 91 of file CostJbTotal.h.

◆ jbObsBias()

template<typename MODEL , typename OBS >

const ObsAuxCovars_& oops::CostJbTotal< MODEL, OBS >::jbObsBias ( ) const

inline

Definition at line 92 of file CostJbTotal.h.

◆ jbState()

template<typename MODEL , typename OBS >

const JbState_& oops::CostJbTotal< MODEL, OBS >::jbState ( ) const

inline

Definition at line 90 of file CostJbTotal.h.

◆ multiplyB()

template<typename MODEL , typename OBS >

void oops::CostJbTotal< MODEL, OBS >::multiplyB	(	const CtrlInc_ &	dxin,
		CtrlInc_ &	dxout
	)		const

Multiply by covariance matrix and its inverse.

Definition at line 303 of file CostJbTotal.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ multiplyBinv()

template<typename MODEL , typename OBS >

void oops::CostJbTotal< MODEL, OBS >::multiplyBinv	(	const CtrlInc_ &	dxin,
		CtrlInc_ &	dxout
	)		const

Definition at line 314 of file CostJbTotal.h.

Here is the call graph for this function:

◆ randomize()

template<typename MODEL , typename OBS >

void oops::CostJbTotal< MODEL, OBS >::randomize ( CtrlInc_ & dx ) const

Randomize.

Definition at line 325 of file CostJbTotal.h.

Here is the call graph for this function:

◆ resolution()

template<typename MODEL , typename OBS >

const Geometry_& oops::CostJbTotal< MODEL, OBS >::resolution ( ) const

inline

Jb terms for ControlIncrement constructor.

Definition at line 89 of file CostJbTotal.h.

◆ windowBegin()

template<typename MODEL , typename OBS >

const util::DateTime& oops::CostJbTotal< MODEL, OBS >::windowBegin ( ) const

inline

Definition at line 93 of file CostJbTotal.h.

◆ windowEnd()

template<typename MODEL , typename OBS >

const util::DateTime& oops::CostJbTotal< MODEL, OBS >::windowEnd ( ) const

inline

Definition at line 94 of file CostJbTotal.h.

Member Data Documentation

◆ dxFG_

template<typename MODEL , typename OBS >

std::unique_ptr<CtrlInc_> oops::CostJbTotal< MODEL, OBS >::dxFG_

private

First guess increment \(x_0-x_b\) or more generally \( x_i-M(x_{i-1})\).

Definition at line 107 of file CostJbTotal.h.

◆ fg_

template<typename MODEL , typename OBS >

const CtrlVar_* oops::CostJbTotal< MODEL, OBS >::fg_

mutableprivate

Definition at line 104 of file CostJbTotal.h.

◆ jb_

template<typename MODEL , typename OBS >

std::unique_ptr<JbState_> oops::CostJbTotal< MODEL, OBS >::jb_

private

Definition at line 100 of file CostJbTotal.h.

◆ jbModBias_

template<typename MODEL , typename OBS >

ModelAuxCovar_ oops::CostJbTotal< MODEL, OBS >::jbModBias_

private

Definition at line 101 of file CostJbTotal.h.

◆ jbObsBias_

template<typename MODEL , typename OBS >

ObsAuxCovars_ oops::CostJbTotal< MODEL, OBS >::jbObsBias_

private

Definition at line 102 of file CostJbTotal.h.

◆ resol_

template<typename MODEL , typename OBS >

std::unique_ptr<Geometry_> oops::CostJbTotal< MODEL, OBS >::resol_

private

Inner loop resolution.

Definition at line 110 of file CostJbTotal.h.

◆ windowBegin_

template<typename MODEL , typename OBS >

const util::DateTime oops::CostJbTotal< MODEL, OBS >::windowBegin_

private

Definition at line 111 of file CostJbTotal.h.

◆ windowEnd_

template<typename MODEL , typename OBS >

const util::DateTime oops::CostJbTotal< MODEL, OBS >::windowEnd_

private

Definition at line 112 of file CostJbTotal.h.

◆ xb_

template<typename MODEL , typename OBS >

const CtrlVar_& oops::CostJbTotal< MODEL, OBS >::xb_

private

Definition at line 99 of file CostJbTotal.h.

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

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

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

Member Typedef Documentation

◆ CtrlInc_

◆ CtrlVar_

◆ Geometry_

◆ JbState_

◆ JqTermTLAD_

◆ ModelAuxCovar_

◆ ObsAuxCovars_

◆ ObsSpaces_

◆ State_

Constructor & Destructor Documentation

◆ CostJbTotal()

◆ ~CostJbTotal()

Member Function Documentation

◆ addGradientFG() [1/2]

◆ addGradientFG() [2/2]

◆ evaluate()

◆ finalize()

◆ finalizeAD()

◆ finalizeTL()

◆ finalizeTraj()

◆ getBackground()

◆ getFirstGuess()

◆ initialize()

◆ initializeAD()

◆ initializeTL()

◆ initializeTraj()

◆ jbModBias()

◆ jbObsBias()

◆ jbState()

◆ multiplyB()

◆ multiplyBinv()

◆ randomize()

◆ resolution()

◆ windowBegin()

◆ windowEnd()

Member Data Documentation

◆ dxFG_

◆ fg_

◆ jb_

◆ jbModBias_

◆ jbObsBias_

◆ resol_

◆ windowBegin_

◆ windowEnd_

◆ xb_

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