3D-Var Cost Function More...

#include <CostFct3DVar.h>

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

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

[legend]

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

virtual	~CostFct3DVar ()

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

void	runADJ (CtrlInc_ &, PostProcessorTLAD< MODEL > &, PostProcessor< Increment_ >, const bool) 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_

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_

util::DateTime	windowHalf_

const eckit::mpi::Comm &	comm_

Geometry_	resol_

const Variables	ctlvars_

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

3D-Var Cost Function

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

Definition at line 44 of file CostFct3DVar.h.

Member Typedef Documentation

◆ CostFct_

template<typename MODEL , typename OBS >

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

private

Definition at line 48 of file CostFct3DVar.h.

◆ CtrlInc_

template<typename MODEL , typename OBS >

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

private

Definition at line 46 of file CostFct3DVar.h.

◆ CtrlVar_

template<typename MODEL , typename OBS >

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

private

Definition at line 47 of file CostFct3DVar.h.

◆ Geometry_

template<typename MODEL , typename OBS >

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

private

Definition at line 49 of file CostFct3DVar.h.

◆ Increment_

template<typename MODEL , typename OBS >

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

private

Definition at line 45 of file CostFct3DVar.h.

◆ State_

template<typename MODEL , typename OBS >

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

private

Definition at line 50 of file CostFct3DVar.h.

Constructor & Destructor Documentation

◆ CostFct3DVar()

template<typename MODEL , typename OBS >

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

Definition at line 88 of file CostFct3DVar.h.

Here is the call graph for this function:

◆ ~CostFct3DVar()

template<typename MODEL , typename OBS >

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

inlinevirtual

Definition at line 54 of file CostFct3DVar.h.

Member Function Documentation

◆ addIncr()

template<typename MODEL , typename OBS >

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

overrideprivatevirtual

Implements oops::CostFunction< MODEL, OBS >.

Definition at line 224 of file CostFct3DVar.h.

Here is the call graph for this function:

◆ doLinearize()

template<typename MODEL , typename OBS >

void oops::CostFct3DVar< MODEL, OBS >::doLinearize	(	const Geometry_ &	res,
		const eckit::Configuration &	conf,
		const CtrlVar_ &	,
		const CtrlVar_ &	,
		PostProcessor< State_ > &	pp,
		PostProcessorTLAD< MODEL > &	pptraj
	)

overrideprivatevirtual

Implements oops::CostFunction< MODEL, OBS >.

Definition at line 154 of file CostFct3DVar.h.

Here is the call graph for this function:

◆ geometry()

template<typename MODEL , typename OBS >

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

inlineoverrideprivatevirtual

Implements oops::CostFunction< MODEL, OBS >.

Definition at line 74 of file CostFct3DVar.h.

◆ newJb()

template<typename MODEL , typename OBS >

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

overrideprivatevirtual

Implements oops::CostFunction< MODEL, OBS >.

Definition at line 110 of file CostFct3DVar.h.

Here is the call graph for this function:

◆ newJc()

template<typename MODEL , typename OBS >

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

overrideprivatevirtual

Implements oops::CostFunction< MODEL, OBS >.

Definition at line 128 of file CostFct3DVar.h.

◆ newJo()

template<typename MODEL , typename OBS >

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

overrideprivatevirtual

Implements oops::CostFunction< MODEL, OBS >.

Definition at line 120 of file CostFct3DVar.h.

◆ runADJ()

template<typename MODEL , typename OBS >

void oops::CostFct3DVar< MODEL, OBS >::runADJ	(	CtrlInc_ &	dx,
		PostProcessorTLAD< MODEL > &	cost,
		PostProcessor< Increment_ >	post,
		const bool
	)		const

overridevirtual

Implements oops::CostFunction< MODEL, OBS >.

Definition at line 200 of file CostFct3DVar.h.

Here is the call graph for this function:

◆ runNL()

template<typename MODEL , typename OBS >

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

overridevirtual

Implements oops::CostFunction< MODEL, OBS >.

Definition at line 139 of file CostFct3DVar.h.

Here is the call graph for this function:

◆ runTLM()

template<typename MODEL , typename OBS >

void oops::CostFct3DVar< MODEL, OBS >::runTLM	(	CtrlInc_ &	dx,
		PostProcessorTLAD< MODEL > &	cost,
		PostProcessor< Increment_ >	post,
		const bool
	)		const

overridevirtual

Implements oops::CostFunction< MODEL, OBS >.

Definition at line 166 of file CostFct3DVar.h.

Here is the call graph for this function:

◆ zeroAD()

template<typename MODEL , typename OBS >

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

overridevirtual

Implements oops::CostFunction< MODEL, OBS >.

Definition at line 189 of file CostFct3DVar.h.

Here is the call graph for this function:

Member Data Documentation

◆ comm_

template<typename MODEL , typename OBS >

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

private

Definition at line 80 of file CostFct3DVar.h.

◆ ctlvars_

template<typename MODEL , typename OBS >

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

private

Definition at line 82 of file CostFct3DVar.h.

◆ resol_

template<typename MODEL , typename OBS >

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

private

Definition at line 81 of file CostFct3DVar.h.

◆ windowBegin_

template<typename MODEL , typename OBS >

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

private

Definition at line 77 of file CostFct3DVar.h.

◆ windowEnd_

template<typename MODEL , typename OBS >

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

private

Definition at line 78 of file CostFct3DVar.h.

◆ windowHalf_

template<typename MODEL , typename OBS >

util::DateTime oops::CostFct3DVar< MODEL, OBS >::windowHalf_

private

Definition at line 79 of file CostFct3DVar.h.

◆ windowLength_

template<typename MODEL , typename OBS >

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

private

Definition at line 76 of file CostFct3DVar.h.

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

CostFct3DVar.h

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

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

Member Typedef Documentation

◆ CostFct_

◆ CtrlInc_

◆ CtrlVar_

◆ Geometry_

◆ Increment_

◆ State_

Constructor & Destructor Documentation

◆ CostFct3DVar()

◆ ~CostFct3DVar()

Member Function Documentation

◆ addIncr()

◆ doLinearize()

◆ geometry()

◆ newJb()

◆ newJc()

◆ newJo()

◆ runADJ()

◆ runNL()

◆ runTLM()

◆ zeroAD()

Member Data Documentation

◆ comm_

◆ ctlvars_

◆ resol_

◆ windowBegin_

◆ windowEnd_

◆ windowHalf_

◆ windowLength_

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