Base Class for Cost Function Terms. More...

#include <CostTermBase.h>

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

Public Member Functions
virtual	~CostTermBase ()
	Destructor. More...

virtual void	setPostProc (const ControlVariable< MODEL, OBS > &, const eckit::Configuration &, PostProc_ &)=0
	Initialize and set post-processors to collect data during nonlinear model integration. More...

virtual double	computeCost ()=0
	Finish computation of cost function term after nonlinear model integration. More...

virtual void	setPostProcTraj (const ControlVariable< MODEL, OBS > &, const eckit::Configuration &, const Geometry_ &, PostProcTLAD_ &)=0
	Set post-processors for nonlinear model integration and save linearisation trajectory. More...

virtual void	computeCostTraj ()=0
	Finish cost computation and trajectory handling after nonlinear model integration. More...

virtual void	setPostProcTL (const ControlIncrement< MODEL, OBS > &, PostProcTLAD_ &) const =0
	Initialize and set TL post-processors to collect data during TL model integration. More...

virtual void	computeCostTL (const ControlIncrement< MODEL, OBS > &, GeneralizedDepartures &) const =0
	Finish cost computation after TL model integration. More...

virtual void	computeCostAD (std::shared_ptr< const GeneralizedDepartures >, ControlIncrement< MODEL, OBS > &, PostProcTLAD_ &) const =0
	Adjoint of computeCostTL (initialize and set post-processors adjoint to force AD model) More...

virtual void	setPostProcAD () const =0
	Adjoint ot setPostProcTL (clean-up) More...

virtual std::unique_ptr< GeneralizedDepartures >	multiplyCovar (const GeneralizedDepartures &) const =0
	Multiply by covariance (or weight) matrix and its inverse. More...

virtual std::unique_ptr< GeneralizedDepartures >	multiplyCoInv (const GeneralizedDepartures &) const =0

virtual std::unique_ptr< GeneralizedDepartures >	newDualVector () const =0
	Provide new dual space vector (for example a Departure for Jo). More...

virtual std::unique_ptr< GeneralizedDepartures >	newGradientFG () const =0
	Gradient at first guess. More...

virtual void	resetLinearization ()=0
	Reset trajectory. More...

Private Types
typedef Geometry< MODEL >	Geometry_

typedef State< MODEL >	State_

typedef PostProcessor< State_ >	PostProc_

typedef PostProcessorTLAD< MODEL >	PostProcTLAD_

Detailed Description

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

Base Class for Cost Function Terms.

Abstract base class for the terms of the cost function (other than Jb).

Definition at line 36 of file CostTermBase.h.

Member Typedef Documentation

◆ Geometry_

template<typename MODEL , typename OBS >

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

private

Definition at line 37 of file CostTermBase.h.

◆ PostProc_

template<typename MODEL , typename OBS >

typedef PostProcessor<State_> oops::CostTermBase< MODEL, OBS >::PostProc_

private

Definition at line 39 of file CostTermBase.h.

◆ PostProcTLAD_

template<typename MODEL , typename OBS >

typedef PostProcessorTLAD<MODEL> oops::CostTermBase< MODEL, OBS >::PostProcTLAD_

private

Definition at line 40 of file CostTermBase.h.

◆ State_

template<typename MODEL , typename OBS >

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

private

Definition at line 38 of file CostTermBase.h.

Constructor & Destructor Documentation

◆ ~CostTermBase()

template<typename MODEL , typename OBS >

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

inlinevirtual

Destructor.

Definition at line 44 of file CostTermBase.h.

Member Function Documentation

◆ computeCost()

template<typename MODEL , typename OBS >

virtual double oops::CostTermBase< MODEL, OBS >::computeCost ( )

pure virtual

Finish computation of cost function term after nonlinear model integration.

Implemented in oops::CostJo< MODEL, OBS >, and oops::CostJcDFI< MODEL, OBS >.

◆ computeCostAD()

template<typename MODEL , typename OBS >

virtual void oops::CostTermBase< MODEL, OBS >::computeCostAD	(	std::shared_ptr< const GeneralizedDepartures >	,
		ControlIncrement< MODEL, OBS > &	,
		PostProcTLAD_ &
	)		const

pure virtual

Adjoint of computeCostTL (initialize and set post-processors adjoint to force AD model)

Implemented in oops::CostJo< MODEL, OBS >, and oops::CostJcDFI< MODEL, OBS >.

Here is the caller graph for this function:

◆ computeCostTL()

template<typename MODEL , typename OBS >

virtual void oops::CostTermBase< MODEL, OBS >::computeCostTL	(	const ControlIncrement< MODEL, OBS > &	,
		GeneralizedDepartures &
	)		const

pure virtual

Finish cost computation after TL model integration.

Implemented in oops::CostJo< MODEL, OBS >, and oops::CostJcDFI< MODEL, OBS >.

Here is the caller graph for this function:

◆ computeCostTraj()

template<typename MODEL , typename OBS >

virtual void oops::CostTermBase< MODEL, OBS >::computeCostTraj ( )

pure virtual

Finish cost computation and trajectory handling after nonlinear model integration.

Implemented in oops::CostJo< MODEL, OBS >, and oops::CostJcDFI< MODEL, OBS >.

◆ multiplyCoInv()

template<typename MODEL , typename OBS >

virtual std::unique_ptr<GeneralizedDepartures> oops::CostTermBase< MODEL, OBS >::multiplyCoInv ( const GeneralizedDepartures & ) const

pure virtual

Implemented in oops::CostJo< MODEL, OBS >, and oops::CostJcDFI< MODEL, OBS >.

Here is the caller graph for this function:

◆ multiplyCovar()

template<typename MODEL , typename OBS >

virtual std::unique_ptr<GeneralizedDepartures> oops::CostTermBase< MODEL, OBS >::multiplyCovar ( const GeneralizedDepartures & ) const

pure virtual

Multiply by covariance (or weight) matrix and its inverse.

Implemented in oops::CostJo< MODEL, OBS >, and oops::CostJcDFI< MODEL, OBS >.

◆ newDualVector()

template<typename MODEL , typename OBS >

virtual std::unique_ptr<GeneralizedDepartures> oops::CostTermBase< MODEL, OBS >::newDualVector ( ) const

pure virtual

Provide new dual space vector (for example a Departure for Jo).

Implemented in oops::CostJo< MODEL, OBS >, and oops::CostJcDFI< MODEL, OBS >.

Here is the caller graph for this function:

◆ newGradientFG()

template<typename MODEL , typename OBS >

virtual std::unique_ptr<GeneralizedDepartures> oops::CostTermBase< MODEL, OBS >::newGradientFG ( ) const

pure virtual

Gradient at first guess.

Implemented in oops::CostJo< MODEL, OBS >, and oops::CostJcDFI< MODEL, OBS >.

◆ resetLinearization()

template<typename MODEL , typename OBS >

virtual void oops::CostTermBase< MODEL, OBS >::resetLinearization ( )

pure virtual

Reset trajectory.

Implemented in oops::CostJo< MODEL, OBS >, and oops::CostJcDFI< MODEL, OBS >.

◆ setPostProc()

template<typename MODEL , typename OBS >

virtual void oops::CostTermBase< MODEL, OBS >::setPostProc	(	const ControlVariable< MODEL, OBS > &	,
		const eckit::Configuration &	,
		PostProc_ &
	)

pure virtual

Initialize and set post-processors to collect data during nonlinear model integration.

Implemented in oops::CostJo< MODEL, OBS >, and oops::CostJcDFI< MODEL, OBS >.

◆ setPostProcAD()

template<typename MODEL , typename OBS >

virtual void oops::CostTermBase< MODEL, OBS >::setPostProcAD ( ) const

pure virtual

Adjoint ot setPostProcTL (clean-up)

Implemented in oops::CostJo< MODEL, OBS >, and oops::CostJcDFI< MODEL, OBS >.

Here is the caller graph for this function:

◆ setPostProcTL()

template<typename MODEL , typename OBS >

virtual void oops::CostTermBase< MODEL, OBS >::setPostProcTL	(	const ControlIncrement< MODEL, OBS > &	,
		PostProcTLAD_ &
	)		const

pure virtual

Initialize and set TL post-processors to collect data during TL model integration.

Implemented in oops::CostJo< MODEL, OBS >, and oops::CostJcDFI< MODEL, OBS >.

Here is the caller graph for this function:

◆ setPostProcTraj()

template<typename MODEL , typename OBS >

virtual void oops::CostTermBase< MODEL, OBS >::setPostProcTraj	(	const ControlVariable< MODEL, OBS > &	,
		const eckit::Configuration &	,
		const Geometry_ &	,
		PostProcTLAD_ &
	)

pure virtual

Set post-processors for nonlinear model integration and save linearisation trajectory.

Implemented in oops::CostJo< MODEL, OBS >, and oops::CostJcDFI< MODEL, OBS >.

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

CostTermBase.h

Public Member Functions

Private Types

Detailed Description

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

Member Typedef Documentation

◆ Geometry_

◆ PostProc_

◆ PostProcTLAD_

◆ State_

Constructor & Destructor Documentation

◆ ~CostTermBase()

Member Function Documentation

◆ computeCost()

◆ computeCostAD()

◆ computeCostTL()

◆ computeCostTraj()

◆ multiplyCoInv()

◆ multiplyCovar()

◆ newDualVector()

◆ newGradientFG()

◆ resetLinearization()

◆ setPostProc()

◆ setPostProcAD()

◆ setPostProcTL()

◆ setPostProcTraj()

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