#include <ObsSpaceParameters.h>
Public Member Functions | |
| void | deserialize (util::CompositePath &path, const eckit::Configuration &config) override |
| const ObsIoParametersBase & | obsIoInParameters () const |
| parameters indicating where to load data from More... | |
Public Attributes | |
| oops::RequiredParameter< std::string > | obsSpaceName {"name", this} |
| name of obs space More... | |
| oops::Parameter< std::string > | distName {"distribution", "RoundRobin", this} |
| name of MPI distribution More... | |
| oops::Parameter< bool > | saveObsDistribution {"save obs distribution", false, this} |
| oops::RequiredParameter< oops::Variables > | simVars {"simulated variables", this} |
| simulated variables More... | |
| oops::Parameter< oops::Variables > | derivedSimVars {"derived simulated variables", {}, this} |
| oops::OptionalParameter< std::vector< float > > | haloCenter {"center", this} |
| Halo distribution center. More... | |
| oops::OptionalParameter< float > | haloRadius {"radius", this} |
| Halo distribution radius. More... | |
| oops::OptionalParameter< ObsFileOutParameters > | obsOutFile {"obsdataout", this} |
| output specification by writing to a file More... | |
| oops::OptionalParameter< ObsExtendParameters > | obsExtend {"extension", this} |
| extend the ObsSpace with extra fixed-size records More... | |
Private Attributes | |
| oops::OptionalParameter< ObsFileInParameters > | obsInFile {"obsdatain", this} |
| Fill this section to read observations from a file. More... | |
| oops::OptionalParameter< LegacyObsGenerateParameters > | obsGenerate {"generate", this} |
| Fill this section to generate observations on the fly. More... | |
| oops::OptionalParameter< ObsIoParametersWrapper > | source {"source", this} |
Fill this section instead of obsdatain and generate to load observations from any other source. More... | |
Detailed Description
Definition at line 191 of file ObsSpaceParameters.h.
Member Function Documentation
◆ deserialize()
|
override |
Reimplemented to store contents of the obsdatain or generate section (if present) in the source member variable. This makes it possible for the options related to the source of input data to be accessed in a uniform way (regardless of in which section they were specified) by calling obsIoInParameters().
Definition at line 12 of file ObsSpaceParameters.cc.
◆ obsIoInParameters()
|
inline |
parameters indicating where to load data from
Definition at line 240 of file ObsSpaceParameters.h.
Member Data Documentation
◆ derivedSimVars
| oops::Parameter<oops::Variables> ioda::ObsTopLevelParameters::derivedSimVars {"derived simulated variables", {}, this} |
Simulated variables whose observed values may be absent from the input file, but must be created (computed) by the start of the data assimilation stage.
Definition at line 225 of file ObsSpaceParameters.h.
◆ distName
| oops::Parameter<std::string> ioda::ObsTopLevelParameters::distName {"distribution", "RoundRobin", this} |
name of MPI distribution
Definition at line 205 of file ObsSpaceParameters.h.
◆ haloCenter
| oops::OptionalParameter<std::vector<float> > ioda::ObsTopLevelParameters::haloCenter {"center", this} |
Halo distribution center.
Definition at line 228 of file ObsSpaceParameters.h.
◆ haloRadius
| oops::OptionalParameter<float> ioda::ObsTopLevelParameters::haloRadius {"radius", this} |
Halo distribution radius.
Definition at line 231 of file ObsSpaceParameters.h.
◆ obsExtend
| oops::OptionalParameter<ObsExtendParameters> ioda::ObsTopLevelParameters::obsExtend {"extension", this} |
extend the ObsSpace with extra fixed-size records
Definition at line 237 of file ObsSpaceParameters.h.
◆ obsGenerate
|
private |
Fill this section to generate observations on the fly.
Definition at line 251 of file ObsSpaceParameters.h.
◆ obsInFile
|
private |
Fill this section to read observations from a file.
Definition at line 248 of file ObsSpaceParameters.h.
◆ obsOutFile
| oops::OptionalParameter<ObsFileOutParameters> ioda::ObsTopLevelParameters::obsOutFile {"obsdataout", this} |
output specification by writing to a file
Definition at line 234 of file ObsSpaceParameters.h.
◆ obsSpaceName
| oops::RequiredParameter<std::string> ioda::ObsTopLevelParameters::obsSpaceName {"name", this} |
name of obs space
Definition at line 202 of file ObsSpaceParameters.h.
◆ saveObsDistribution
| oops::Parameter<bool> ioda::ObsTopLevelParameters::saveObsDistribution {"save obs distribution", false, this} |
If saveObsDistribution/"save obs distribution" set to true, global location indices and record numbers will be stored in the MetaData/saved_index and MetaData/saved_record_number variables, respectively. These variables will be saved along with all other variables to the output files generated if the obsdataout.obsfile option is set.
When the "obsdatain.read obs from separate file" option is set and hence each process reads a separate input file, the presence of these variables makes it possible to identify observations stored in more than one input file.
Definition at line 218 of file ObsSpaceParameters.h.
◆ simVars
| oops::RequiredParameter<oops::Variables> ioda::ObsTopLevelParameters::simVars {"simulated variables", this} |
simulated variables
Definition at line 221 of file ObsSpaceParameters.h.
◆ source
|
private |
Fill this section instead of obsdatain and generate to load observations from any other source.
Definition at line 255 of file ObsSpaceParameters.h.
The documentation for this class was generated from the following files:
