#include <ObsSpaceParameters.h>

Collaboration diagram for ioda::ObsSpaceParameters:

Public Member Functions
	ObsSpaceParameters (const util::DateTime &winStart, const util::DateTime &winEnd, const eckit::mpi::Comm &comm, const eckit::mpi::Comm &timeComm)
	Constructor. More...

void	deserialize (const eckit::Configuration &config)
	deserialize the parameter sub groups More...

const util::DateTime &	windowStart () const
	return the start of the DA timing window More...

const util::DateTime &	windowEnd () const
	return the end of the DA timing window More...

const eckit::mpi::Comm &	comm () const
	return the associated MPI group communicator More...

int	obsPertSeed () const
	return the associated perturbations seed More...

const eckit::mpi::Comm &	timeComm () const
	return the associated MPI time communicator More...

void	setDimScale (const std::string &dimName, const Dimensions_t curSize, const Dimensions_t maxSize, const Dimensions_t chunkSize)
	set a new dimension scale More...

NewDimensionScales_t	getDimScales () const
	get a new dimension scale More...

void	setMaxVarSize (const Dimensions_t maxVarSize)
	set the maximum variable size More...

Dimensions_t	getMaxVarSize () const
	get the maximum variable size More...

std::size_t	getMpiRank () const
	get the MPI rank number More...

int	getMpiTimeRank () const
	get the MPI rank number More...

Public Attributes
ObsTopLevelParameters	top_level_
	sub groups of parameters More...

Private Attributes
const util::DateTime	win_start_
	Beginning of DA timing window. More...

const util::DateTime	win_end_
	End of DA timing window. More...

const eckit::mpi::Comm &	comm_
	MPI group communicator. More...

const eckit::mpi::Comm &	time_comm_
	MPI time communicator. More...

NewDimensionScales_t	new_dims_
	new dimension scales for output file construction More...

Dimensions_t	max_var_size_
	maximum variable size for output file contruction More...

std::size_t	mpi_rank_
	group MPI rank number for output file construction More...

int	mpi_time_rank_
	time MPI rank number of output file construction More...

Detailed Description

Definition at line 223 of file ObsSpaceParameters.h.

Constructor & Destructor Documentation

◆ ObsSpaceParameters()

ioda::ObsSpaceParameters::ObsSpaceParameters	(	const util::DateTime &	winStart,
		const util::DateTime &	winEnd,
		const eckit::mpi::Comm &	comm,
		const eckit::mpi::Comm &	timeComm
	)

inline

Constructor.

Definition at line 229 of file ObsSpaceParameters.h.

Here is the call graph for this function:

Member Function Documentation

◆ comm()

const eckit::mpi::Comm& ioda::ObsSpaceParameters::comm ( ) const

inline

return the associated MPI group communicator

Definition at line 266 of file ObsSpaceParameters.h.

Here is the caller graph for this function:

◆ deserialize()

void ioda::ObsSpaceParameters::deserialize ( const eckit::Configuration & config )

inline

deserialize the parameter sub groups

Parameters

config "obs space" level configuration

Definition at line 254 of file ObsSpaceParameters.h.

Here is the caller graph for this function:

◆ getDimScales()

NewDimensionScales_t ioda::ObsSpaceParameters::getDimScales ( ) const

inline

get a new dimension scale

Definition at line 282 of file ObsSpaceParameters.h.

Here is the caller graph for this function:

◆ getMaxVarSize()

Dimensions_t ioda::ObsSpaceParameters::getMaxVarSize ( ) const

inline

get the maximum variable size

Definition at line 288 of file ObsSpaceParameters.h.

Here is the caller graph for this function:

◆ getMpiRank()

std::size_t ioda::ObsSpaceParameters::getMpiRank ( ) const

inline

get the MPI rank number

Definition at line 291 of file ObsSpaceParameters.h.

Here is the caller graph for this function:

◆ getMpiTimeRank()

int ioda::ObsSpaceParameters::getMpiTimeRank ( ) const

inline

get the MPI rank number

Definition at line 294 of file ObsSpaceParameters.h.

Here is the caller graph for this function:

◆ obsPertSeed()

int ioda::ObsSpaceParameters::obsPertSeed ( ) const

inline

return the associated perturbations seed

Definition at line 269 of file ObsSpaceParameters.h.

◆ setDimScale()

void ioda::ObsSpaceParameters::setDimScale	(	const std::string &	dimName,
		const Dimensions_t	curSize,
		const Dimensions_t	maxSize,
		const Dimensions_t	chunkSize
	)

inline

set a new dimension scale

Definition at line 275 of file ObsSpaceParameters.h.

Here is the caller graph for this function:

◆ setMaxVarSize()

void ioda::ObsSpaceParameters::setMaxVarSize ( const Dimensions_t maxVarSize )

inline

set the maximum variable size

Definition at line 285 of file ObsSpaceParameters.h.

Here is the caller graph for this function:

◆ timeComm()

const eckit::mpi::Comm& ioda::ObsSpaceParameters::timeComm ( ) const

inline

return the associated MPI time communicator

Definition at line 272 of file ObsSpaceParameters.h.

Here is the caller graph for this function:

◆ windowEnd()

const util::DateTime& ioda::ObsSpaceParameters::windowEnd ( ) const

inline

return the end of the DA timing window

Definition at line 263 of file ObsSpaceParameters.h.

Here is the caller graph for this function:

◆ windowStart()

const util::DateTime& ioda::ObsSpaceParameters::windowStart ( ) const

inline

return the start of the DA timing window

Definition at line 260 of file ObsSpaceParameters.h.

Here is the caller graph for this function:

Member Data Documentation

◆ comm_

const eckit::mpi::Comm& ioda::ObsSpaceParameters::comm_

private

MPI group communicator.

Definition at line 304 of file ObsSpaceParameters.h.

◆ max_var_size_

Dimensions_t ioda::ObsSpaceParameters::max_var_size_

private

maximum variable size for output file contruction

Definition at line 313 of file ObsSpaceParameters.h.

◆ mpi_rank_

std::size_t ioda::ObsSpaceParameters::mpi_rank_

private

group MPI rank number for output file construction

Definition at line 316 of file ObsSpaceParameters.h.

◆ mpi_time_rank_

int ioda::ObsSpaceParameters::mpi_time_rank_

private

time MPI rank number of output file construction

Definition at line 319 of file ObsSpaceParameters.h.

◆ new_dims_

NewDimensionScales_t ioda::ObsSpaceParameters::new_dims_

private

new dimension scales for output file construction

Definition at line 310 of file ObsSpaceParameters.h.

◆ time_comm_

const eckit::mpi::Comm& ioda::ObsSpaceParameters::time_comm_

private

MPI time communicator.

Definition at line 307 of file ObsSpaceParameters.h.

◆ top_level_

ObsTopLevelParameters ioda::ObsSpaceParameters::top_level_

sub groups of parameters

Definition at line 226 of file ObsSpaceParameters.h.

◆ win_end_

const util::DateTime ioda::ObsSpaceParameters::win_end_

private

End of DA timing window.

Definition at line 301 of file ObsSpaceParameters.h.

◆ win_start_

const util::DateTime ioda::ObsSpaceParameters::win_start_

private

Beginning of DA timing window.

Definition at line 298 of file ObsSpaceParameters.h.

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

ObsSpaceParameters.h

Public Member Functions

Public Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ObsSpaceParameters()

Member Function Documentation

◆ comm()

◆ deserialize()

◆ getDimScales()

◆ getMaxVarSize()

◆ getMpiRank()

◆ getMpiTimeRank()

◆ obsPertSeed()

◆ setDimScale()

◆ setMaxVarSize()

◆ timeComm()

◆ windowEnd()

◆ windowStart()

Member Data Documentation

◆ comm_

◆ max_var_size_

◆ mpi_rank_

◆ mpi_time_rank_

◆ new_dims_

◆ time_comm_

◆ top_level_

◆ win_end_

◆ win_start_