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

#include <CostFctWeak.h>

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

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

[legend]

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

	~CostFctWeak ()

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	runTLM (CtrlInc_ &, const bool idModel=false) const

void	runADJ (CtrlInc_ &, const bool idModel=false) const

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

CostJbJq< 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	subWinLength_

util::DateTime	subWinBegin_

util::DateTime	subWinEnd_

size_t	nsubwin_

size_t	mysubwin_

std::unique_ptr< Geometry_ >	resol_

std::unique_ptr< Model_ >	model_

const Variables	ctlvars_

std::shared_ptr< LinearModel_ >	tlm_

std::unique_ptr< VarCha_ >	an2model_

std::unique_ptr< LinVarCha_ >	inc2model_

eckit::mpi::Comm *	commSpace_

eckit::mpi::Comm *	commTime_

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::CostFctWeak< MODEL, OBS >

Weak Constraint 4D-Var Cost Function.

General weak constraint constraint 4D-Var cost function.

Definition at line 53 of file CostFctWeak.h.

Member Typedef Documentation

◆ CostFct_

template<typename MODEL , typename OBS >

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

private

Definition at line 57 of file CostFctWeak.h.

◆ CtrlInc_

template<typename MODEL , typename OBS >

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

private

Definition at line 55 of file CostFctWeak.h.

◆ CtrlVar_

template<typename MODEL , typename OBS >

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

private

Definition at line 56 of file CostFctWeak.h.

◆ Geometry_

template<typename MODEL , typename OBS >

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

private

Definition at line 58 of file CostFctWeak.h.

◆ Increment_

template<typename MODEL , typename OBS >

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

private

Definition at line 54 of file CostFctWeak.h.

◆ LinearModel_

template<typename MODEL , typename OBS >

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

private

Definition at line 61 of file CostFctWeak.h.

◆ LinVarCha_

template<typename MODEL , typename OBS >

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

private

Definition at line 63 of file CostFctWeak.h.

◆ Model_

template<typename MODEL , typename OBS >

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

private

Definition at line 60 of file CostFctWeak.h.

◆ State_

template<typename MODEL , typename OBS >

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

private

Definition at line 59 of file CostFctWeak.h.

◆ VarCha_

template<typename MODEL , typename OBS >

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

private

Definition at line 62 of file CostFctWeak.h.

Constructor & Destructor Documentation

◆ CostFctWeak()

template<typename MODEL , typename OBS >

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

Definition at line 111 of file CostFctWeak.h.

Here is the call graph for this function:

◆ ~CostFctWeak()

template<typename MODEL , typename OBS >

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

inline

Definition at line 67 of file CostFctWeak.h.

Member Function Documentation

◆ addIncr()

template<typename MODEL , typename OBS >

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

overrideprivatevirtual

Implements oops::CostFunction< MODEL, OBS >.

Definition at line 317 of file CostFctWeak.h.

Here is the call graph for this function:

◆ doLinearize()

template<typename MODEL , typename OBS >

void oops::CostFctWeak< 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 201 of file CostFctWeak.h.

Here is the call graph for this function:

◆ geometry()

template<typename MODEL , typename OBS >

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

inlineoverrideprivatevirtual

Implements oops::CostFunction< MODEL, OBS >.

Definition at line 91 of file CostFctWeak.h.

◆ newJb()

template<typename MODEL , typename OBS >

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

overrideprivatevirtual

Implements oops::CostFunction< MODEL, OBS >.

Definition at line 160 of file CostFctWeak.h.

Here is the call graph for this function:

◆ newJc()

template<typename MODEL , typename OBS >

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

overrideprivatevirtual

Implements oops::CostFunction< MODEL, OBS >.

Definition at line 177 of file CostFctWeak.h.

◆ newJo()

template<typename MODEL , typename OBS >

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

overrideprivatevirtual

Implements oops::CostFunction< MODEL, OBS >.

Definition at line 169 of file CostFctWeak.h.

◆ runADJ() [1/2]

template<typename MODEL , typename OBS >

void oops::CostFctWeak< MODEL, OBS >::runADJ	(	CtrlInc_ &	dx,
		const bool	idModel = `false`
	)		const

Definition at line 295 of file CostFctWeak.h.

Here is the call graph for this function:

◆ runADJ() [2/2]

template<typename MODEL , typename OBS >

void oops::CostFctWeak< 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 274 of file CostFctWeak.h.

Here is the call graph for this function:

◆ runNL()

template<typename MODEL , typename OBS >

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

overridevirtual

Implements oops::CostFunction< MODEL, OBS >.

Definition at line 187 of file CostFctWeak.h.

Here is the call graph for this function:

◆ runTLM() [1/2]

template<typename MODEL , typename OBS >

void oops::CostFctWeak< MODEL, OBS >::runTLM	(	CtrlInc_ &	dx,
		const bool	idModel = `false`
	)		const

Definition at line 243 of file CostFctWeak.h.

Here is the call graph for this function:

◆ runTLM() [2/2]

template<typename MODEL , typename OBS >

void oops::CostFctWeak< 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 222 of file CostFctWeak.h.

Here is the call graph for this function:

◆ zeroAD()

template<typename MODEL , typename OBS >

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

overridevirtual

Implements oops::CostFunction< MODEL, OBS >.

Definition at line 265 of file CostFctWeak.h.

Here is the call graph for this function:

Member Data Documentation

◆ an2model_

template<typename MODEL , typename OBS >

std::unique_ptr<VarCha_> oops::CostFctWeak< MODEL, OBS >::an2model_

private

Definition at line 102 of file CostFctWeak.h.

◆ commSpace_

template<typename MODEL , typename OBS >

eckit::mpi::Comm* oops::CostFctWeak< MODEL, OBS >::commSpace_

private

Definition at line 104 of file CostFctWeak.h.

◆ commTime_

template<typename MODEL , typename OBS >

eckit::mpi::Comm* oops::CostFctWeak< MODEL, OBS >::commTime_

private

Definition at line 105 of file CostFctWeak.h.

◆ ctlvars_

template<typename MODEL , typename OBS >

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

private

Definition at line 100 of file CostFctWeak.h.

◆ inc2model_

template<typename MODEL , typename OBS >

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

private

Definition at line 103 of file CostFctWeak.h.

◆ model_

template<typename MODEL , typename OBS >

std::unique_ptr<Model_> oops::CostFctWeak< MODEL, OBS >::model_

private

Definition at line 99 of file CostFctWeak.h.

◆ mysubwin_

template<typename MODEL , typename OBS >

size_t oops::CostFctWeak< MODEL, OBS >::mysubwin_

private

Definition at line 97 of file CostFctWeak.h.

◆ nsubwin_

template<typename MODEL , typename OBS >

size_t oops::CostFctWeak< MODEL, OBS >::nsubwin_

private

Definition at line 96 of file CostFctWeak.h.

◆ resol_

template<typename MODEL , typename OBS >

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

private

Definition at line 98 of file CostFctWeak.h.

◆ subWinBegin_

template<typename MODEL , typename OBS >

util::DateTime oops::CostFctWeak< MODEL, OBS >::subWinBegin_

private

Definition at line 94 of file CostFctWeak.h.

◆ subWinEnd_

template<typename MODEL , typename OBS >

util::DateTime oops::CostFctWeak< MODEL, OBS >::subWinEnd_

private

Definition at line 95 of file CostFctWeak.h.

◆ subWinLength_

template<typename MODEL , typename OBS >

util::Duration oops::CostFctWeak< MODEL, OBS >::subWinLength_

private

Definition at line 93 of file CostFctWeak.h.

◆ tlm_

template<typename MODEL , typename OBS >

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

private

Definition at line 101 of file CostFctWeak.h.

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

CostFctWeak.h

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

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

Member Typedef Documentation

◆ CostFct_

◆ CtrlInc_

◆ CtrlVar_

◆ Geometry_

◆ Increment_

◆ LinearModel_

◆ LinVarCha_

◆ Model_

◆ State_

◆ VarCha_

Constructor & Destructor Documentation

◆ CostFctWeak()

◆ ~CostFctWeak()

Member Function Documentation

◆ addIncr()

◆ doLinearize()

◆ geometry()

◆ newJb()

◆ newJc()

◆ newJo()

◆ runADJ() [1/2]

◆ runADJ() [2/2]

◆ runNL()

◆ runTLM() [1/2]

◆ runTLM() [2/2]

◆ zeroAD()

Member Data Documentation

◆ an2model_

◆ commSpace_

◆ commTime_

◆ ctlvars_

◆ inc2model_

◆ model_

◆ mysubwin_

◆ nsubwin_

◆ resol_

◆ subWinBegin_

◆ subWinEnd_

◆ subWinLength_

◆ tlm_

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