Jb + Jq Cost Function. More...

#include <CostJbJq.h>

Inheritance diagram for oops::CostJbJq< MODEL >:

Collaboration diagram for oops::CostJbJq< MODEL >:

[legend]

Public Member Functions
	CostJbJq (const eckit::Configuration &, const eckit::mpi::Comm &, const Geometry_ &, const Variables &, const State_ &)
	Construct \( J_b\). More...

virtual	~CostJbJq ()
	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
	Finalize \( J_q\) after the model run. More...

JqTermTLAD< MODEL > *	initializeJqTL () const override
	Finalize \( J_q\) after the TL run. More...

JqTermTLAD< MODEL > *	initializeJqAD (const Increment_ &) const override
	Initialize \( J_q\) forcing before the AD run. 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
std::unique_ptr< ModelSpaceCovarianceBase< MODEL > >	B_

const State_ &	xb_

const Variables	ctlvars_

std::unique_ptr< const Geometry_ >	resol_

const eckit::LocalConfiguration	conf_

const eckit::mpi::Comm &	commTime_

const bool	first_

Detailed Description

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

Jb + Jq Cost Function.

CostJbJq encapsulates the generalized Jb term of the cost weak constraint 4D-Var function (ie Jb+Jq).

Definition at line 39 of file CostJbJq.h.

Member Typedef Documentation

◆ Geometry_

template<typename MODEL >

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

private

Definition at line 40 of file CostJbJq.h.

◆ Increment_

template<typename MODEL >

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

private

Definition at line 41 of file CostJbJq.h.

◆ State_

template<typename MODEL >

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

private

Definition at line 42 of file CostJbJq.h.

Constructor & Destructor Documentation

◆ CostJbJq()

template<typename MODEL >

oops::CostJbJq< MODEL >::CostJbJq	(	const eckit::Configuration &	config,
		const eckit::mpi::Comm &	comm,
		const Geometry_ &	resolouter,
		const Variables &	ctlvars,
		const State_ &	xb
	)

Construct \( J_b\).

Definition at line 97 of file CostJbJq.h.

◆ ~CostJbJq()

template<typename MODEL >

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

inlinevirtual

Destructor.

Definition at line 50 of file CostJbJq.h.

Member Function Documentation

◆ addGradient()

template<typename MODEL >

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

overridevirtual

Add Jb gradient.

Implements oops::CostJbState< MODEL >.

Definition at line 156 of file CostJbJq.h.

◆ Bminv()

template<typename MODEL >

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

overridevirtual

Implements oops::CostJbState< MODEL >.

Definition at line 213 of file CostJbJq.h.

◆ Bmult()

template<typename MODEL >

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

overridevirtual

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

Implements oops::CostJbState< MODEL >.

Definition at line 204 of file CostJbJq.h.

◆ computeIncrement()

template<typename MODEL >

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

overridevirtual

Get increment from state (usually first guess).

Implements oops::CostJbState< MODEL >.

Definition at line 126 of file CostJbJq.h.

Here is the call graph for this function:

◆ initializeJqAD()

template<typename MODEL >

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

overridevirtual

Initialize \( J_q\) forcing before the AD run.

Implements oops::CostJbState< MODEL >.

Definition at line 193 of file CostJbJq.h.

Here is the call graph for this function:

◆ initializeJqTL()

template<typename MODEL >

JqTermTLAD< MODEL > * oops::CostJbJq< MODEL >::initializeJqTL

overridevirtual

Finalize \( J_q\) after the TL run.

Implements oops::CostJbState< MODEL >.

Definition at line 183 of file CostJbJq.h.

◆ initializeJqTLAD()

template<typename MODEL >

JqTermTLAD< MODEL > * oops::CostJbJq< MODEL >::initializeJqTLAD

overridevirtual

Finalize \( J_q\) after the model run.

Implements oops::CostJbState< MODEL >.

Definition at line 175 of file CostJbJq.h.

◆ linearize()

template<typename MODEL >

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

overridevirtual

Linearize before the linear computations.

Implements oops::CostJbState< MODEL >.

Definition at line 109 of file CostJbJq.h.

Here is the call graph for this function:

◆ newStateIncrement()

template<typename MODEL >

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

overridevirtual

Create new increment (set to 0).

Implements oops::CostJbState< MODEL >.

Definition at line 231 of file CostJbJq.h.

◆ randomize()

template<typename MODEL >

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

overridevirtual

Randomize.

Implements oops::CostJbState< MODEL >.

Definition at line 222 of file CostJbJq.h.

Member Data Documentation

◆ B_

template<typename MODEL >

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

private

Definition at line 82 of file CostJbJq.h.

◆ commTime_

template<typename MODEL >

const eckit::mpi::Comm& oops::CostJbJq< MODEL >::commTime_

private

Definition at line 87 of file CostJbJq.h.

◆ conf_

template<typename MODEL >

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

private

Definition at line 86 of file CostJbJq.h.

◆ ctlvars_

template<typename MODEL >

const Variables oops::CostJbJq< MODEL >::ctlvars_

private

Definition at line 84 of file CostJbJq.h.

◆ first_

template<typename MODEL >

const bool oops::CostJbJq< MODEL >::first_

private

Definition at line 88 of file CostJbJq.h.

◆ resol_

template<typename MODEL >

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

private

Definition at line 85 of file CostJbJq.h.

◆ xb_

template<typename MODEL >

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

private

Definition at line 83 of file CostJbJq.h.

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

CostJbJq.h

Public Member Functions

Private Types

Private Attributes

Detailed Description

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

Member Typedef Documentation

◆ Geometry_

◆ Increment_

◆ State_

Constructor & Destructor Documentation

◆ CostJbJq()

◆ ~CostJbJq()

Member Function Documentation

◆ addGradient()

◆ Bminv()

◆ Bmult()

◆ computeIncrement()

◆ initializeJqAD()

◆ initializeJqTL()

◆ initializeJqTLAD()

◆ linearize()

◆ newStateIncrement()

◆ randomize()

Member Data Documentation

◆ B_

◆ commTime_

◆ conf_

◆ ctlvars_

◆ first_

◆ resol_

◆ xb_

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