Strong Constraint 4D-Var Cost Function. More...

#include <CostFct4DVar.h>

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

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

[legend]

Public Member Functions
	CostFct4DVar (const eckit::Configuration &, const eckit::mpi::Comm &)

	~CostFct4DVar ()

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

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

void	zeroAD (CtrlInc_ &) const override

void	runNL (CtrlVar_ &, PostProcessor< State_ > &) const override

Public Member Functions inherited from oops::CostFunction< MODEL, OBS >
	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_ >())

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

Private Types
typedef Increment< MODEL >	Increment_

typedef ControlIncrement< MODEL, OBS >	CtrlInc_

typedef ControlVariable< MODEL, OBS >	CtrlVar_

typedef CostFunction< MODEL, OBS >	CostFct_

typedef Geometry< MODEL >	Geometry_

typedef State< MODEL >	State_

typedef Model< MODEL >	Model_

typedef LinearModel< MODEL >	LinearModel_

typedef VariableChange< MODEL >	VarCha_

typedef LinearVariableChangeBase< MODEL >	LinVarCha_

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

CostJb3D< MODEL > *	newJb (const eckit::Configuration &, const Geometry_ &, const CtrlVar_ &) const override

CostJo< MODEL, OBS > *	newJo (const eckit::Configuration &) const override

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

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

const Geometry_ &	geometry () const override

Private Attributes
util::Duration	windowLength_

util::DateTime	windowBegin_

util::DateTime	windowEnd_

const eckit::mpi::Comm &	comm_

Geometry_	resol_

Model_	model_

const Variables	ctlvars_

std::shared_ptr< LinearModel_ >	tlm_

VarCha_	an2model_

std::unique_ptr< LinVarCha_ >	inc2model_

Additional Inherited Members
Protected Member Functions inherited from oops::CostFunction< MODEL, OBS >
void	setupTerms (const eckit::Configuration &)

const CtrlVar_ &	background () const

Detailed Description

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

Strong Constraint 4D-Var Cost Function.

This class is not really necessary since it is only a special case of the more general weak constraint 4D-Var cost function with one sub-window. It is provided for readability.

Definition at line 51 of file CostFct4DVar.h.

Member Typedef Documentation

◆ CostFct_

template<typename MODEL , typename OBS >

typedef CostFunction<MODEL, OBS> oops::CostFct4DVar< MODEL, OBS >::CostFct_

private

Definition at line 55 of file CostFct4DVar.h.

◆ CtrlInc_

template<typename MODEL , typename OBS >

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

private

Definition at line 53 of file CostFct4DVar.h.

◆ CtrlVar_

template<typename MODEL , typename OBS >

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

private

Definition at line 54 of file CostFct4DVar.h.

◆ Geometry_

template<typename MODEL , typename OBS >

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

private

Definition at line 56 of file CostFct4DVar.h.

◆ Increment_

template<typename MODEL , typename OBS >

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

private

Definition at line 52 of file CostFct4DVar.h.

◆ LinearModel_

template<typename MODEL , typename OBS >

typedef LinearModel<MODEL> oops::CostFct4DVar< MODEL, OBS >::LinearModel_

private

Definition at line 59 of file CostFct4DVar.h.

◆ LinVarCha_

template<typename MODEL , typename OBS >

typedef LinearVariableChangeBase<MODEL> oops::CostFct4DVar< MODEL, OBS >::LinVarCha_

private

Definition at line 61 of file CostFct4DVar.h.

◆ Model_

template<typename MODEL , typename OBS >

typedef Model<MODEL> oops::CostFct4DVar< MODEL, OBS >::Model_

private

Definition at line 58 of file CostFct4DVar.h.

◆ State_

template<typename MODEL , typename OBS >

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

private

Definition at line 57 of file CostFct4DVar.h.

◆ VarCha_

template<typename MODEL , typename OBS >

typedef VariableChange<MODEL> oops::CostFct4DVar< MODEL, OBS >::VarCha_

private

Definition at line 60 of file CostFct4DVar.h.

Constructor & Destructor Documentation

◆ CostFct4DVar()

template<typename MODEL , typename OBS >

oops::CostFct4DVar< MODEL, OBS >::CostFct4DVar	(	const eckit::Configuration &	config,
		const eckit::mpi::Comm &	comm
	)

Definition at line 104 of file CostFct4DVar.h.

Here is the call graph for this function:

◆ ~CostFct4DVar()

template<typename MODEL , typename OBS >

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

inline

Definition at line 65 of file CostFct4DVar.h.

Member Function Documentation

◆ addIncr()

template<typename MODEL , typename OBS >

void oops::CostFct4DVar< MODEL, OBS >::addIncr	(	CtrlVar_ &	xx,
		const CtrlInc_ &	dx,
		PostProcessor< Increment_ > &
	)		const

overrideprivatevirtual

Implements oops::CostFunction< MODEL, OBS >.

Definition at line 231 of file CostFct4DVar.h.

Here is the call graph for this function:

◆ doLinearize()

template<typename MODEL , typename OBS >

void oops::CostFct4DVar< MODEL, OBS >::doLinearize	(	const Geometry_ &	resol,
		const eckit::Configuration &	innerConf,
		const CtrlVar_ &	bg,
		const CtrlVar_ &	fg,
		PostProcessor< State_ > &	pp,
		PostProcessorTLAD< MODEL > &	pptraj
	)

overrideprivatevirtual

Implements oops::CostFunction< MODEL, OBS >.

Definition at line 164 of file CostFct4DVar.h.

Here is the call graph for this function:

◆ geometry()

template<typename MODEL , typename OBS >

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

inlineoverrideprivatevirtual

Implements oops::CostFunction< MODEL, OBS >.

Definition at line 87 of file CostFct4DVar.h.

◆ newJb()

template<typename MODEL , typename OBS >

CostJb3D< MODEL > * oops::CostFct4DVar< MODEL, OBS >::newJb	(	const eckit::Configuration &	jbConf,
		const Geometry_ &	resol,
		const CtrlVar_ &	xb
	)		const

overrideprivatevirtual

Implements oops::CostFunction< MODEL, OBS >.

Definition at line 124 of file CostFct4DVar.h.

Here is the call graph for this function:

◆ newJc()

template<typename MODEL , typename OBS >

CostTermBase< MODEL, OBS > * oops::CostFct4DVar< MODEL, OBS >::newJc	(	const eckit::Configuration &	jcConf,
		const Geometry_ &	resol
	)		const

overrideprivatevirtual

Implements oops::CostFunction< MODEL, OBS >.

Definition at line 140 of file CostFct4DVar.h.

◆ newJo()

template<typename MODEL , typename OBS >

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

overrideprivatevirtual

Implements oops::CostFunction< MODEL, OBS >.

Definition at line 133 of file CostFct4DVar.h.

◆ runADJ()

template<typename MODEL , typename OBS >

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

overridevirtual

Implements oops::CostFunction< MODEL, OBS >.

Definition at line 213 of file CostFct4DVar.h.

Here is the call graph for this function:

◆ runNL()

template<typename MODEL , typename OBS >

void oops::CostFct4DVar< MODEL, OBS >::runNL	(	CtrlVar_ &	xx,
		PostProcessor< State_ > &	post
	)		const

overridevirtual

Implements oops::CostFunction< MODEL, OBS >.

Definition at line 150 of file CostFct4DVar.h.

Here is the call graph for this function:

◆ runTLM()

template<typename MODEL , typename OBS >

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

overridevirtual

Implements oops::CostFunction< MODEL, OBS >.

Definition at line 185 of file CostFct4DVar.h.

Here is the call graph for this function:

◆ zeroAD()

template<typename MODEL , typename OBS >

void oops::CostFct4DVar< MODEL, OBS >::zeroAD ( CtrlInc_ & dx ) const

overridevirtual

Implements oops::CostFunction< MODEL, OBS >.

Definition at line 204 of file CostFct4DVar.h.

Here is the call graph for this function:

Member Data Documentation

◆ an2model_

template<typename MODEL , typename OBS >

VarCha_ oops::CostFct4DVar< MODEL, OBS >::an2model_

private

Definition at line 97 of file CostFct4DVar.h.

◆ comm_

template<typename MODEL , typename OBS >

const eckit::mpi::Comm& oops::CostFct4DVar< MODEL, OBS >::comm_

private

Definition at line 92 of file CostFct4DVar.h.

◆ ctlvars_

template<typename MODEL , typename OBS >

const Variables oops::CostFct4DVar< MODEL, OBS >::ctlvars_

private

Definition at line 95 of file CostFct4DVar.h.

◆ inc2model_

template<typename MODEL , typename OBS >

std::unique_ptr<LinVarCha_> oops::CostFct4DVar< MODEL, OBS >::inc2model_

private

Definition at line 98 of file CostFct4DVar.h.

◆ model_

template<typename MODEL , typename OBS >

Model_ oops::CostFct4DVar< MODEL, OBS >::model_

private

Definition at line 94 of file CostFct4DVar.h.

◆ resol_

template<typename MODEL , typename OBS >

Geometry_ oops::CostFct4DVar< MODEL, OBS >::resol_

private

Definition at line 93 of file CostFct4DVar.h.

◆ tlm_

template<typename MODEL , typename OBS >

std::shared_ptr<LinearModel_> oops::CostFct4DVar< MODEL, OBS >::tlm_

private

Definition at line 96 of file CostFct4DVar.h.

◆ windowBegin_

template<typename MODEL , typename OBS >

util::DateTime oops::CostFct4DVar< MODEL, OBS >::windowBegin_

private

Definition at line 90 of file CostFct4DVar.h.

◆ windowEnd_

template<typename MODEL , typename OBS >

util::DateTime oops::CostFct4DVar< MODEL, OBS >::windowEnd_

private

Definition at line 91 of file CostFct4DVar.h.

◆ windowLength_

template<typename MODEL , typename OBS >

util::Duration oops::CostFct4DVar< MODEL, OBS >::windowLength_

private

Definition at line 89 of file CostFct4DVar.h.

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

CostFct4DVar.h

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

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

Member Typedef Documentation

◆ CostFct_

◆ CtrlInc_

◆ CtrlVar_

◆ Geometry_

◆ Increment_

◆ LinearModel_

◆ LinVarCha_

◆ Model_

◆ State_

◆ VarCha_

Constructor & Destructor Documentation

◆ CostFct4DVar()

◆ ~CostFct4DVar()

Member Function Documentation

◆ addIncr()

◆ doLinearize()

◆ geometry()

◆ newJb()

◆ newJc()

◆ newJo()

◆ runADJ()

◆ runNL()

◆ runTLM()

◆ zeroAD()

Member Data Documentation

◆ an2model_

◆ comm_

◆ ctlvars_

◆ inc2model_

◆ model_

◆ resol_

◆ tlm_

◆ windowBegin_

◆ windowEnd_

◆ windowLength_

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