oops::HofX4DParameters< MODEL, OBS > Class Template Reference

Top-level options taken by the HofX4D application. More...

#include <HofX4D.h>

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

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

Public Types
typedef Geometry< MODEL >::Parameters_	GeometryParameters_
typedef ModelParametersWrapper< MODEL >	ModelParameters_

Public Attributes
oops::RequiredParameter< util::DateTime >	windowBegin {"window begin", this}
oops::RequiredParameter< util::Duration >	windowLength {"window length", this}
oops::RequiredParameter< util::Duration >	forecastLength {"forecast length", this}
	Forecast length. More...
oops::Parameter< std::vector< ObsTypeParameters< OBS > > >	observations {"observations", {}, this}
	A list whose elements determine treatment of observations from individual observation spaces. More...
oops::RequiredParameter< GeometryParameters_ >	geometry {"geometry", this}
	Geometry parameters. More...
oops::RequiredParameter< ModelParameters_ >	model {"model", this}
	Model parameters. More...
oops::RequiredParameter< eckit::LocalConfiguration >	initialCondition {"initial condition", this}
	Initial state parameters. More...
oops::Parameter< eckit::LocalConfiguration >	prints {"prints", eckit::LocalConfiguration(), this}
	Options passed to the object writing out forecast fields. More...
oops::Parameter< bool >	obsPerturbations {"obs perturbations", false, this}
	Whether to perturb the H(x) vector before saving. More...
oops::Parameter< bool >	makeObs {"make obs", false, this}
	Whether to save the H(x) vector as ObsValues. More...
oops::Parameter< eckit::LocalConfiguration >	test {"test", eckit::LocalConfiguration(), this}

Detailed Description

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

Top-level options taken by the HofX4D application.

Definition at line 76 of file HofX4D.h.

Member Typedef Documentation

GeometryParameters_

template<typename MODEL , typename OBS >

typedef Geometry<MODEL>::Parameters_ oops::HofX4DParameters< MODEL, OBS >::GeometryParameters_

Definition at line 80 of file HofX4D.h.

ModelParameters_

template<typename MODEL , typename OBS >

typedef ModelParametersWrapper<MODEL> oops::HofX4DParameters< MODEL, OBS >::ModelParameters_

Definition at line 81 of file HofX4D.h.

Member Data Documentation

forecastLength

template<typename MODEL , typename OBS >

oops::RequiredParameter<util::Duration> oops::HofX4DParameters< MODEL, OBS >::forecastLength {"forecast length", this}

Forecast length.

Definition at line 89 of file HofX4D.h.

geometry

template<typename MODEL , typename OBS >

oops::RequiredParameter<GeometryParameters_> oops::HofX4DParameters< MODEL, OBS >::geometry {"geometry", this}

Geometry parameters.

Definition at line 95 of file HofX4D.h.

initialCondition

template<typename MODEL , typename OBS >

oops::RequiredParameter<eckit::LocalConfiguration> oops::HofX4DParameters< MODEL, OBS >::initialCondition {"initial condition", this}

Initial state parameters.

Definition at line 101 of file HofX4D.h.

makeObs

template<typename MODEL , typename OBS >

oops::Parameter<bool> oops::HofX4DParameters< MODEL, OBS >::makeObs {"make obs", false, this}

Whether to save the H(x) vector as ObsValues.

Definition at line 110 of file HofX4D.h.

model

template<typename MODEL , typename OBS >

oops::RequiredParameter<ModelParameters_> oops::HofX4DParameters< MODEL, OBS >::model {"model", this}

Model parameters.

Definition at line 98 of file HofX4D.h.

observations

template<typename MODEL , typename OBS >

oops::Parameter<std::vector<ObsTypeParameters<OBS> > > oops::HofX4DParameters< MODEL, OBS >::observations {"observations", {}, this}

A list whose elements determine treatment of observations from individual observation spaces.

Definition at line 92 of file HofX4D.h.

obsPerturbations

template<typename MODEL , typename OBS >

oops::Parameter<bool> oops::HofX4DParameters< MODEL, OBS >::obsPerturbations {"obs perturbations", false, this}

Whether to perturb the H(x) vector before saving.

Definition at line 107 of file HofX4D.h.

prints

template<typename MODEL , typename OBS >

oops::Parameter<eckit::LocalConfiguration> oops::HofX4DParameters< MODEL, OBS >::prints {"prints", eckit::LocalConfiguration(), this}

Options passed to the object writing out forecast fields.

Definition at line 104 of file HofX4D.h.

test

template<typename MODEL , typename OBS >

oops::Parameter<eckit::LocalConfiguration> oops::HofX4DParameters< MODEL, OBS >::test {"test", eckit::LocalConfiguration(), this}

Parameters used by regression tests comparing results produced by the application against known good outputs.

Definition at line 114 of file HofX4D.h.

windowBegin

template<typename MODEL , typename OBS >

oops::RequiredParameter<util::DateTime> oops::HofX4DParameters< MODEL, OBS >::windowBegin {"window begin", this}

Only observations taken at times lying in the (window begin, window begin + window length] interval will be included in observation spaces.

Definition at line 85 of file HofX4D.h.

windowLength

template<typename MODEL , typename OBS >

oops::RequiredParameter<util::Duration> oops::HofX4DParameters< MODEL, OBS >::windowLength {"window length", this}

Definition at line 86 of file HofX4D.h.

---

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

• HofX4D.h