An implementation of the GETKF from Lei 2018 JAMES. More...

#include <GETKFSolver.h>

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

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

[legend]

Public Member Functions
	GETKFSolver (ObsSpaces_ &, const Geometry_ &, const eckit::Configuration &, size_t, const State4D_ &)

Observations_	computeHofX (const StateEnsemble4D_ &, size_t, bool) override
	computes ensemble H(`xx`), returns mean H(`xx`), saves as hofx `iteration` More...

void	measurementUpdate (const IncrementEnsemble4D_ &, const GeometryIterator_ &, IncrementEnsemble4D_ &) override
	entire KF update (computeWeights+applyWeights) for a grid point GeometryIterator_ More...

Public Member Functions inherited from oops::LocalEnsembleSolver< MODEL, OBS >
	LocalEnsembleSolver (ObsSpaces_ &obspaces, const Geometry_ &geometry, const eckit::Configuration &config, size_t nens, const State4D_ &xbmean)
	initialize solver with `obspaces`, `geometry`, full `config` and `nens` ensemble size More...

virtual	~LocalEnsembleSolver ()=default

virtual void	copyLocalIncrement (const IncrementEnsemble4D_ &bg, const GeometryIterator_ &i, IncrementEnsemble4D_ &an) const
	copy `an`[`i`] = `bg` `i` \a More...

void	computeHofX4D (const eckit::Configuration &, const State4D_ &, Observations_ &)

const ObsLocalizations_ &	obsloc () const
	accessor to obs localizations More...

Static Public Member Functions
static const std::string	classname ()

Static Public Member Functions inherited from oops::LocalEnsembleSolver< MODEL, OBS >
static const std::string	classname ()

Private Types
typedef Departures< OBS >	Departures_

typedef DeparturesEnsemble< OBS >	DeparturesEnsemble_

typedef Geometry< MODEL >	Geometry_

typedef GeometryIterator< MODEL >	GeometryIterator_

typedef IncrementEnsemble4D< MODEL >	IncrementEnsemble4D_

typedef ObsEnsemble< OBS >	ObsEnsemble_

typedef Observations< OBS >	Observations_

typedef ObsSpaces< OBS >	ObsSpaces_

typedef State4D< MODEL >	State4D_

typedef StateEnsemble4D< MODEL >	StateEnsemble4D_

typedef VerticalLocEV< MODEL >	VerticalLocEV_

Private Member Functions
void	computeWeights (const Eigen::VectorXd &omb, const Eigen::MatrixXd &Yb, const Eigen::MatrixXd &YbOrig, const Eigen::VectorXd &invvarR)

void	applyWeights (const IncrementEnsemble4D_ &, IncrementEnsemble4D_ &, const GeometryIterator_ &)
	Applies weights and adds posterior inflation. More...

Private Attributes
LETKFSolverParameters	options_

size_t	nens_

const Geometry_ &	geometry_

VerticalLocEV_	vertloc_

size_t	neig_

size_t	nanal_

DeparturesEnsemble_	HZb_

Eigen::MatrixXd	Wa_

Eigen::VectorXd	wa_

Additional Inherited Members
Protected Attributes inherited from oops::LocalEnsembleSolver< MODEL, OBS >
const Geometry_ &	geometry_
	Geometry associated with the updated states. More...

const ObsSpaces_ &	obspaces_
	ObsSpaces used in the update. More...

Departures_	omb_
	obs - mean(H(x)); set in computeHofX method More...

DeparturesEnsemble_	Yb_

std::unique_ptr< ObsErrors_ >	R_
	observation errors, set in computeHofX method More...

std::unique_ptr< Departures_ >	invVarR_

Detailed Description

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

An implementation of the GETKF from Lei 2018 JAMES.

Lei, L., Whitaker, J. S., & Bishop, C. ( 2018). Improving assimilation of radiance observations by implementing model space localization in an ensemble Kalman filter. Journal of Advances in Modeling Earth Systems, 10, 3221– 3232. https://doi.org/10.1029/2018MS001468

Definition at line 49 of file GETKFSolver.h.

Member Typedef Documentation

◆ Departures_

template<typename MODEL , typename OBS >

typedef Departures<OBS> oops::GETKFSolver< MODEL, OBS >::Departures_

private

Definition at line 50 of file GETKFSolver.h.

◆ DeparturesEnsemble_

template<typename MODEL , typename OBS >

typedef DeparturesEnsemble<OBS> oops::GETKFSolver< MODEL, OBS >::DeparturesEnsemble_

private

Definition at line 51 of file GETKFSolver.h.

◆ Geometry_

template<typename MODEL , typename OBS >

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

private

Definition at line 52 of file GETKFSolver.h.

◆ GeometryIterator_

template<typename MODEL , typename OBS >

typedef GeometryIterator<MODEL> oops::GETKFSolver< MODEL, OBS >::GeometryIterator_

private

Definition at line 53 of file GETKFSolver.h.

◆ IncrementEnsemble4D_

template<typename MODEL , typename OBS >

typedef IncrementEnsemble4D<MODEL> oops::GETKFSolver< MODEL, OBS >::IncrementEnsemble4D_

private

Definition at line 54 of file GETKFSolver.h.

◆ ObsEnsemble_

template<typename MODEL , typename OBS >

typedef ObsEnsemble<OBS> oops::GETKFSolver< MODEL, OBS >::ObsEnsemble_

private

Definition at line 55 of file GETKFSolver.h.

◆ Observations_

template<typename MODEL , typename OBS >

typedef Observations<OBS> oops::GETKFSolver< MODEL, OBS >::Observations_

private

Definition at line 56 of file GETKFSolver.h.

◆ ObsSpaces_

template<typename MODEL , typename OBS >

typedef ObsSpaces<OBS> oops::GETKFSolver< MODEL, OBS >::ObsSpaces_

private

Definition at line 57 of file GETKFSolver.h.

◆ State4D_

template<typename MODEL , typename OBS >

typedef State4D<MODEL> oops::GETKFSolver< MODEL, OBS >::State4D_

private

Definition at line 58 of file GETKFSolver.h.

◆ StateEnsemble4D_

template<typename MODEL , typename OBS >

typedef StateEnsemble4D<MODEL> oops::GETKFSolver< MODEL, OBS >::StateEnsemble4D_

private

Definition at line 59 of file GETKFSolver.h.

◆ VerticalLocEV_

template<typename MODEL , typename OBS >

typedef VerticalLocEV<MODEL> oops::GETKFSolver< MODEL, OBS >::VerticalLocEV_

private

Definition at line 60 of file GETKFSolver.h.

Constructor & Destructor Documentation

◆ GETKFSolver()

template<typename MODEL , typename OBS >

oops::GETKFSolver< MODEL, OBS >::GETKFSolver	(	ObsSpaces_ &	obspaces,
		const Geometry_ &	geometry,
		const eckit::Configuration &	config,
		size_t	nens,
		const State4D_ &	xbmean
	)

Constructor (allocates Wa, wa, HZb_, saves options from the config, computes VerticalLocEV_)

Definition at line 108 of file GETKFSolver.h.

Here is the call graph for this function:

Member Function Documentation

◆ applyWeights()

template<typename MODEL , typename OBS >

void oops::GETKFSolver< MODEL, OBS >::applyWeights	(	const IncrementEnsemble4D_ &	bkg_pert,
		IncrementEnsemble4D_ &	ana_pert,
		const GeometryIterator_ &	i
	)

private

Applies weights and adds posterior inflation.

Definition at line 237 of file GETKFSolver.h.

Here is the call graph for this function:

◆ classname()

template<typename MODEL , typename OBS >

static const std::string oops::GETKFSolver< MODEL, OBS >::classname ( )

inlinestatic

Definition at line 63 of file GETKFSolver.h.

◆ computeHofX()

template<typename MODEL , typename OBS >

Observations< OBS > oops::GETKFSolver< MODEL, OBS >::computeHofX	(	const StateEnsemble4D_ &	xx,
		size_t	iteration,
		bool	readFromDisk
	)

overridevirtual

computes ensemble H(xx), returns mean H(xx), saves as hofx iteration

Reimplemented from oops::LocalEnsembleSolver< MODEL, OBS >.

Definition at line 146 of file GETKFSolver.h.

Here is the call graph for this function:

◆ computeWeights()

template<typename MODEL , typename OBS >

void oops::GETKFSolver< MODEL, OBS >::computeWeights	(	const Eigen::VectorXd &	omb,
		const Eigen::MatrixXd &	Yb,
		const Eigen::MatrixXd &	YbOrig,
		const Eigen::VectorXd &	invvarR
	)

private

Computes weights for ensemble update with local observations

Parameters

[in]	omb	Observation departures (nlocalobs)
[in]	Yb	Ensemble perturbations for all the background memebers (nens*neig, nlocalobs)
[in]	YbOrig	Ensemble perturbations for the members to be updated (nens, nlocalobs)
[in]	invvarR	Inverse of observation error variances (nlocalobs)

Definition at line 202 of file GETKFSolver.h.

Here is the call graph for this function:

◆ measurementUpdate()

template<typename MODEL , typename OBS >

void oops::GETKFSolver< MODEL, OBS >::measurementUpdate	(	const IncrementEnsemble4D_ &	bkg_pert,
		const GeometryIterator_ &	i,
		IncrementEnsemble4D_ &	ana_pert
	)

overridevirtual

entire KF update (computeWeights+applyWeights) for a grid point GeometryIterator_

Implements oops::LocalEnsembleSolver< MODEL, OBS >.

Definition at line 314 of file GETKFSolver.h.

Here is the call graph for this function:

Member Data Documentation

◆ geometry_

template<typename MODEL , typename OBS >

const Geometry_& oops::GETKFSolver< MODEL, OBS >::geometry_

private

Definition at line 94 of file GETKFSolver.h.

◆ HZb_

template<typename MODEL , typename OBS >

DeparturesEnsemble_ oops::GETKFSolver< MODEL, OBS >::HZb_

private

Definition at line 99 of file GETKFSolver.h.

◆ nanal_

template<typename MODEL , typename OBS >

size_t oops::GETKFSolver< MODEL, OBS >::nanal_

private

Definition at line 97 of file GETKFSolver.h.

◆ neig_

template<typename MODEL , typename OBS >

size_t oops::GETKFSolver< MODEL, OBS >::neig_

private

Definition at line 96 of file GETKFSolver.h.

◆ nens_

template<typename MODEL , typename OBS >

size_t oops::GETKFSolver< MODEL, OBS >::nens_

private

Definition at line 93 of file GETKFSolver.h.

◆ options_

template<typename MODEL , typename OBS >

LETKFSolverParameters oops::GETKFSolver< MODEL, OBS >::options_

private

Definition at line 91 of file GETKFSolver.h.

◆ vertloc_

template<typename MODEL , typename OBS >

VerticalLocEV_ oops::GETKFSolver< MODEL, OBS >::vertloc_

private

Definition at line 95 of file GETKFSolver.h.

◆ Wa_

template<typename MODEL , typename OBS >

Eigen::MatrixXd oops::GETKFSolver< MODEL, OBS >::Wa_

private

Definition at line 101 of file GETKFSolver.h.

◆ wa_

template<typename MODEL , typename OBS >

Eigen::VectorXd oops::GETKFSolver< MODEL, OBS >::wa_

private

Definition at line 102 of file GETKFSolver.h.

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

GETKFSolver.h

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

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

Member Typedef Documentation

◆ Departures_

◆ DeparturesEnsemble_

◆ Geometry_

◆ GeometryIterator_

◆ IncrementEnsemble4D_

◆ ObsEnsemble_

◆ Observations_

◆ ObsSpaces_

◆ State4D_

◆ StateEnsemble4D_

◆ VerticalLocEV_

Constructor & Destructor Documentation

◆ GETKFSolver()

Member Function Documentation

◆ applyWeights()

◆ classname()

◆ computeHofX()

◆ computeWeights()

◆ measurementUpdate()

Member Data Documentation

◆ geometry_

◆ HZb_

◆ nanal_

◆ neig_

◆ nens_

◆ options_

◆ vertloc_

◆ Wa_

◆ wa_

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