#include <ObsSpaceParameters.h>

Inheritance diagram for ioda::ObsFileInParameters:

Collaboration diagram for ioda::ObsFileInParameters:

Public Attributes
oops::RequiredParameter< std::string >	fileName {"obsfile", this}
	input obs file name More...

oops::Parameter< FileFormat >	format {"format", FileFormat::AUTO, this}

oops::Parameter< bool >	readFromSeparateFiles {"read obs from separate file", false, this}

oops::Parameter< std::string >	mappingFile {"mapping file", "", this}

oops::Parameter< std::string >	queryFile {"query file", "", this}

Public Attributes inherited from ioda::ObsIoParametersBase
oops::OptionalParameter< std::string >	type {"type", this}
	Identifies the ObsIo subclass to use. More...

oops::Parameter< ObsGroupingParameters >	obsGrouping {"obsgrouping", {}, this}
	options controlling obs record grouping More...

oops::Parameter< int >	maxFrameSize {"max frame size", DEFAULT_FRAME_SIZE, this}
	maximum frame size More...

Detailed Description

Definition at line 41 of file ObsSpaceParameters.h.

Member Data Documentation

◆ fileName

oops::RequiredParameter<std::string> ioda::ObsFileInParameters::fileName {"obsfile", this}

input obs file name

Definition at line 46 of file ObsSpaceParameters.h.

◆ format

oops::Parameter<FileFormat> ioda::ObsFileInParameters::format {"format", FileFormat::AUTO, this}

input obs file format

Possible values:

hdf5: HDF5 file format
odb: ODB file format
auto (default): file format determined automatically from the file name extension (.odb – ODB, everything else – HDF5).

Definition at line 55 of file ObsSpaceParameters.h.

◆ mappingFile

oops::Parameter<std::string> ioda::ObsFileInParameters::mappingFile {"mapping file", "", this}

file with variable name mapping rules

Required for obs files in the ODB format, unused otherwise.

Definition at line 67 of file ObsSpaceParameters.h.

◆ queryFile

oops::Parameter<std::string> ioda::ObsFileInParameters::queryFile {"query file", "", this}

file with query parameters

Required for obs files in the ODB format, unused otherwise.

Definition at line 71 of file ObsSpaceParameters.h.

◆ readFromSeparateFiles

oops::Parameter<bool> ioda::ObsFileInParameters::readFromSeparateFiles {"read obs from separate file", false, this}

reading from multiple files (1 per MPI task) This option is not typically used. It is used to tell the system to read observations from the ioda output files (one per MPI task) from a prior run instead of reading and distributing from the original file. This is currently being used in LETKF applictions.

Definition at line 62 of file ObsSpaceParameters.h.

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

ObsSpaceParameters.h