Distribution assigning each record to the process owning the Atlas mesh partition containing the location of the first observation in that record. More...

#include <AtlasDistribution.h>

Inheritance diagram for ioda::AtlasDistribution:

[legend]

Collaboration diagram for ioda::AtlasDistribution:

[legend]

Classes
class	RecordAssigner
	Assigns records to MPI ranks for the AtlasDistribution. More...

Public Member Functions
	AtlasDistribution (const eckit::mpi::Comm &comm, const eckit::Configuration &config)

	~AtlasDistribution () override

void	assignRecord (const std::size_t recNum, const std::size_t locNum, const eckit::geometry::Point2 &point) override
	If the record `RecNum` has not yet been assigned to a PE, assigns it to the appropriate PE. More...

bool	isMyRecord (std::size_t recNum) const override
	Returns true if record `RecNum` has been assigned to the calling PE during a previous call to assignRecord(). More...

std::string	name () const override

Public Member Functions inherited from ioda::NonoverlappingDistribution
	NonoverlappingDistribution (const eckit::mpi::Comm &Comm)

	~NonoverlappingDistribution () override

bool	isNonoverlapping () const override
	Returns true if the distribution does not assign any record to more than one PE, false otherwise. More...

void	assignRecord (const std::size_t RecNum, const std::size_t LocNum, const eckit::geometry::Point2 &point) override
	If the record `RecNum` has not yet been assigned to a PE, assigns it to the appropriate PE. More...

void	patchObs (std::vector< bool > &patchObsVec) const override
	Sets each element of the provided vector to true if the corresponding location is a "patch obs", i.e. More...

void	computePatchLocs () override
	If necessary, identifies locations of "patch obs", i.e. More...

void	min (int &x) const override
	Calculates the global minimum (over all locations on all PEs) of a location-dependent quantity. More...

void	min (std::size_t &x) const override

void	min (float &x) const override

void	min (double &x) const override

void	min (std::vector< int > &x) const override
	Calculates the global minima (over all locations on all PEs) of multiple location-dependent quantities. More...

void	min (std::vector< std::size_t > &x) const override

void	min (std::vector< float > &x) const override

void	min (std::vector< double > &x) const override

void	max (int &x) const override
	Calculates the global maximum (over all locations on all PEs) of a location-dependent quantity. More...

void	max (std::size_t &x) const override

void	max (float &x) const override

void	max (double &x) const override

void	max (std::vector< int > &x) const override
	Calculates the global maxima (over all locations on all PEs) of multiple location-dependent quantities. More...

void	max (std::vector< std::size_t > &x) const override

void	max (std::vector< float > &x) const override

void	max (std::vector< double > &x) const override

void	allGatherv (std::vector< size_t > &x) const override
	Gather observation data from all processes and deliver the combined data to all processes. More...

void	allGatherv (std::vector< int > &x) const override

void	allGatherv (std::vector< float > &x) const override

void	allGatherv (std::vector< double > &x) const override

void	allGatherv (std::vector< util::DateTime > &x) const override

void	allGatherv (std::vector< std::string > &x) const override

size_t	globalUniqueConsecutiveLocationIndex (size_t loc) const override
	Map the index of a location held on the calling process to the index of the corresponding element of any vector produced by allGatherv(). More...

Public Member Functions inherited from ioda::Distribution
	Distribution (const eckit::mpi::Comm &Comm)

virtual	~Distribution ()

virtual bool	isIdentity () const
	Returns true if the distribution assigns all records to all PEs, false otherwise. More...

template<typename T >
std::unique_ptr< Accumulator< T > >	createAccumulator () const
	Create an object that can be used to calculate the sum of a location-dependent quantity over locations held on all PEs, each taken into account only once even if it's held on multiple PEs. More...

template<typename T >
std::unique_ptr< Accumulator< std::vector< T > > >	createAccumulator (std::size_t n) const
	Create an object that can be used to calculate the sums of `n` location-dependent quantities over locations held on all PEs, each taken into account only once even if it's held on multiple PEs. More...

size_t	rank () const
	Accessor to MPI rank. More...

Private Attributes
std::unique_ptr< RecordAssigner >	recordAssigner_

Additional Inherited Members
Protected Attributes inherited from ioda::Distribution
const eckit::mpi::Comm &	comm_
	Local MPI communicator. More...

Related Functions inherited from ioda::Distribution
double	dotProduct (const Distribution &dist, std::size_t numVariables, const std::vector< double > &v1, const std::vector< double > &v2)
	Computes the dot product between two vectors of obs distributed across MPI ranks. More...

std::size_t	globalNumNonMissingObs (const Distribution &dist, size_t numVariables, const std::vector< double > &v)
	Counts unique non-missing observations in a vector. More...

Detailed Description

Distribution assigning each record to the process owning the Atlas mesh partition containing the location of the first observation in that record.

The Atlas grid and mesh is created and partitioned using settings taken from the grid section of the Configuration passed to the constructor.

Definition at line 22 of file AtlasDistribution.h.

Constructor & Destructor Documentation

◆ AtlasDistribution()

ioda::AtlasDistribution::AtlasDistribution	(	const eckit::mpi::Comm &	comm,
		const eckit::Configuration &	config
	)

explicit

Definition at line 111 of file AtlasDistribution.cc.

◆ ~AtlasDistribution()

ioda::AtlasDistribution::~AtlasDistribution ( )

override

Definition at line 119 of file AtlasDistribution.cc.

Member Function Documentation

◆ assignRecord()

void ioda::AtlasDistribution::assignRecord	(	const std::size_t	RecNum,
		const std::size_t	LocNum,
		const eckit::geometry::Point2 &	point
	)

overridevirtual

If the record RecNum has not yet been assigned to a PE, assigns it to the appropriate PE.

Informs the distribution that location LocNum belongs to this record.

Parameters

RecNum	Record containing the location `LocNum`.
LocNum	(Global) location index.
point	Latitude and longitude of this location.

Reimplemented from ioda::Distribution.

Definition at line 123 of file AtlasDistribution.cc.

Here is the call graph for this function:

◆ isMyRecord()

bool ioda::AtlasDistribution::isMyRecord ( std::size_t RecNum ) const

overridevirtual

Returns true if record RecNum has been assigned to the calling PE during a previous call to assignRecord().

Clients can use this function to determine which records to keep when reading in observations.

Implements ioda::Distribution.

Definition at line 130 of file AtlasDistribution.cc.

◆ name()

std::string ioda::AtlasDistribution::name ( ) const

overridevirtual

Implements ioda::Distribution.

Definition at line 134 of file AtlasDistribution.cc.

Here is the caller graph for this function:

Member Data Documentation

◆ recordAssigner_

std::unique_ptr<RecordAssigner> ioda::AtlasDistribution::recordAssigner_

private

Definition at line 39 of file AtlasDistribution.h.

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

Classes

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AtlasDistribution()

◆ ~AtlasDistribution()

Member Function Documentation

◆ assignRecord()

◆ isMyRecord()

◆ name()

Member Data Documentation

◆ recordAssigner_