Jb Cost Function. More...

#include <CostJb3D.h>

Inheritance diagram for oops::CostJb3D< MODEL >:

Collaboration diagram for oops::CostJb3D< MODEL >:

[legend]

Public Member Functions
	CostJb3D (const eckit::Configuration &, const Geometry_ &, const Variables &, const util::Duration &, const State_ &)
	Construct \( J_b\). More...

virtual	~CostJb3D ()
	Destructor. More...

void	computeIncrement (const State_ &, const State_ &, const State_ &, Increment_ &) const override
	Get increment from state (usually first guess). More...

void	linearize (const State_ &, const Geometry_ &) override
	Linearize before the linear computations. More...

void	addGradient (const Increment_ &, Increment_ &, Increment_ &) const override
	Add Jb gradient. More...

JqTermTLAD< MODEL > *	initializeJqTLAD () const override
	Empty Jq observer. More...

JqTermTLAD< MODEL > *	initializeJqTL () const override
	Empty TL Jq observer. More...

JqTermTLAD< MODEL > *	initializeJqAD (const Increment_ &) const override
	Empty AD Jq observer. More...

void	Bmult (const Increment_ &, Increment_ &) const override
	Multiply by \( B\) and \( B^{-1}\). More...

void	Bminv (const Increment_ &, Increment_ &) const override

void	randomize (Increment_ &) const override
	Randomize. More...

Increment_ *	newStateIncrement () const override
	Create new increment (set to 0). More...

Public Member Functions inherited from oops::CostJbState< MODEL >
	CostJbState ()
	Constructor. More...

virtual	~CostJbState ()
	Destructor. More...

Private Types
typedef Geometry< MODEL >	Geometry_

typedef Increment< MODEL >	Increment_

typedef State< MODEL >	State_

Private Attributes
const State_ &	xb_

std::unique_ptr< ModelSpaceCovarianceBase< MODEL > >	B_

const util::Duration	winLength_

const Variables	controlvars_

std::unique_ptr< const Geometry_ >	resol_

const util::DateTime	time_

const eckit::LocalConfiguration	conf_

Detailed Description

template<typename MODEL>
class oops::CostJb3D< MODEL >

Jb Cost Function.

The CostJb3D encapsulates the Jb term of the cost function for a 3 dimensional background.

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

Definition at line 43 of file CostJb3D.h.

Member Typedef Documentation

◆ Geometry_

template<typename MODEL >

typedef Geometry<MODEL> oops::CostJb3D< MODEL >::Geometry_

private

Definition at line 44 of file CostJb3D.h.

◆ Increment_

template<typename MODEL >

typedef Increment<MODEL> oops::CostJb3D< MODEL >::Increment_

private

Definition at line 45 of file CostJb3D.h.

◆ State_

template<typename MODEL >

typedef State<MODEL> oops::CostJb3D< MODEL >::State_

private

Definition at line 46 of file CostJb3D.h.

Constructor & Destructor Documentation

◆ CostJb3D()

template<typename MODEL >

oops::CostJb3D< MODEL >::CostJb3D	(	const eckit::Configuration &	config,
		const Geometry_ &	,
		const Variables &	ctlvars,
		const util::Duration &	len,
		const State_ &	xb
	)

Construct \( J_b\).

Definition at line 101 of file CostJb3D.h.

◆ ~CostJb3D()

template<typename MODEL >

virtual oops::CostJb3D< MODEL >::~CostJb3D ( )

inlinevirtual

Destructor.

Definition at line 54 of file CostJb3D.h.

Member Function Documentation

◆ addGradient()

template<typename MODEL >

void oops::CostJb3D< MODEL >::addGradient	(	const Increment_ &	dxFG,
		Increment_ &	grad,
		Increment_ &	gradJb
	)		const

overridevirtual

Add Jb gradient.

Implements oops::CostJbState< MODEL >.

Definition at line 129 of file CostJb3D.h.

◆ Bminv()

template<typename MODEL >

void oops::CostJb3D< MODEL >::Bminv	(	const Increment_ &	dxin,
		Increment_ &	dxout
	)		const

overridevirtual

Implements oops::CostJbState< MODEL >.

Definition at line 144 of file CostJb3D.h.

◆ Bmult()

template<typename MODEL >

void oops::CostJb3D< MODEL >::Bmult	(	const Increment_ &	dxin,
		Increment_ &	dxout
	)		const

overridevirtual

Multiply by \( B\) and \( B^{-1}\).

Implements oops::CostJbState< MODEL >.

Definition at line 137 of file CostJb3D.h.

◆ computeIncrement()

template<typename MODEL >

void oops::CostJb3D< MODEL >::computeIncrement	(	const State_ &	xb,
		const State_ &	fg,
		const State_ &	,
		Increment_ &	dx
	)		const

overridevirtual

Get increment from state (usually first guess).

Implements oops::CostJbState< MODEL >.

Definition at line 121 of file CostJb3D.h.

Here is the call graph for this function:

◆ initializeJqAD()

template<typename MODEL >

JqTermTLAD<MODEL>* oops::CostJb3D< MODEL >::initializeJqAD ( const Increment_ & ) const

inlineoverridevirtual

Empty AD Jq observer.

Implements oops::CostJbState< MODEL >.

Definition at line 73 of file CostJb3D.h.

◆ initializeJqTL()

template<typename MODEL >

JqTermTLAD<MODEL>* oops::CostJb3D< MODEL >::initializeJqTL ( ) const

inlineoverridevirtual

Empty TL Jq observer.

Implements oops::CostJbState< MODEL >.

Definition at line 70 of file CostJb3D.h.

◆ initializeJqTLAD()

template<typename MODEL >

JqTermTLAD<MODEL>* oops::CostJb3D< MODEL >::initializeJqTLAD ( ) const

inlineoverridevirtual

Empty Jq observer.

Implements oops::CostJbState< MODEL >.

Definition at line 67 of file CostJb3D.h.

◆ linearize()

template<typename MODEL >

void oops::CostJb3D< MODEL >::linearize	(	const State_ &	fg,
		const Geometry_ &	lowres
	)

overridevirtual

Linearize before the linear computations.

Implements oops::CostJbState< MODEL >.

Definition at line 113 of file CostJb3D.h.

◆ newStateIncrement()

template<typename MODEL >

Increment< MODEL > * oops::CostJb3D< MODEL >::newStateIncrement

overridevirtual

Create new increment (set to 0).

Implements oops::CostJbState< MODEL >.

Definition at line 159 of file CostJb3D.h.

◆ randomize()

template<typename MODEL >

void oops::CostJb3D< MODEL >::randomize ( Increment_ & dx ) const

overridevirtual

Randomize.

Implements oops::CostJbState< MODEL >.

Definition at line 151 of file CostJb3D.h.

Member Data Documentation

◆ B_

template<typename MODEL >

std::unique_ptr< ModelSpaceCovarianceBase<MODEL> > oops::CostJb3D< MODEL >::B_

private

Definition at line 87 of file CostJb3D.h.

◆ conf_

template<typename MODEL >

const eckit::LocalConfiguration oops::CostJb3D< MODEL >::conf_

private

Definition at line 92 of file CostJb3D.h.

◆ controlvars_

template<typename MODEL >

const Variables oops::CostJb3D< MODEL >::controlvars_

private

Definition at line 89 of file CostJb3D.h.

◆ resol_

template<typename MODEL >

std::unique_ptr<const Geometry_> oops::CostJb3D< MODEL >::resol_

private

Definition at line 90 of file CostJb3D.h.

◆ time_

template<typename MODEL >

const util::DateTime oops::CostJb3D< MODEL >::time_

private

Definition at line 91 of file CostJb3D.h.

◆ winLength_

template<typename MODEL >

const util::Duration oops::CostJb3D< MODEL >::winLength_

private

Definition at line 88 of file CostJb3D.h.

◆ xb_

template<typename MODEL >

const State_& oops::CostJb3D< MODEL >::xb_

private

Definition at line 86 of file CostJb3D.h.

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

CostJb3D.h

Public Member Functions

Private Types

Private Attributes

Detailed Description

template<typename MODEL> class oops::CostJb3D< MODEL >

Member Typedef Documentation

◆ Geometry_

◆ Increment_

◆ State_

Constructor & Destructor Documentation

◆ CostJb3D()

◆ ~CostJb3D()

Member Function Documentation

◆ addGradient()

◆ Bminv()

◆ Bmult()

◆ computeIncrement()

◆ initializeJqAD()

◆ initializeJqTL()

◆ initializeJqTLAD()

◆ linearize()

◆ newStateIncrement()

◆ randomize()

Member Data Documentation

◆ B_

◆ conf_

◆ controlvars_

◆ resol_

◆ time_

◆ winLength_

◆ xb_

template<typename MODEL>
class oops::CostJb3D< MODEL >