ioda::Halo Class Reference

Halo distribution. More...

#include <Halo.h>

Inheritance diagram for ioda::Halo:

Collaboration diagram for ioda::Halo:

Public Member Functions
	Halo (const eckit::mpi::Comm &Comm, const eckit::Configuration &config)
	Halo selector. More...
	~Halo ()
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...
void	computePatchLocs () override
	If necessary, identifies locations of "patch obs", i.e. More...
void	patchObs (std::vector< bool > &) const override
	Sets each element of the provided vector to true if the corresponding location is a "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
	overloading for util::DateTime More...
void	allGatherv (std::vector< std::string > &x) const override
	overloading for std::string More...
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...
std::string	name () const override
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...
virtual bool	isNonoverlapping () const
	Returns true if the distribution does not assign any record to more than one PE, 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 Member Functions
template<typename T >
void	minImpl (T &x) const
template<typename T >
void	maxImpl (T &x) const
template<typename T >
void	reductionImpl (T &x, eckit::mpi::Operation::Code op) const
template<typename T >
void	reductionImpl (std::vector< T > &x, eckit::mpi::Operation::Code op) const
std::unique_ptr< Accumulator< int > >	createAccumulatorImpl (int init) const override
	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...
std::unique_ptr< Accumulator< std::size_t > >	createAccumulatorImpl (std::size_t init) const override
std::unique_ptr< Accumulator< float > >	createAccumulatorImpl (float init) const override
std::unique_ptr< Accumulator< double > >	createAccumulatorImpl (double init) const override
std::unique_ptr< Accumulator< std::vector< int > > >	createAccumulatorImpl (const std::vector< int > &init) const override
	Create an object that can be used to calculate the sums of multiple location-dependent quantities over locations held on all PEs, each taken into account only once even if it's held on multiple PEs. More...
std::unique_ptr< Accumulator< std::vector< std::size_t > > >	createAccumulatorImpl (const std::vector< std::size_t > &init) const override
std::unique_ptr< Accumulator< std::vector< float > > >	createAccumulatorImpl (const std::vector< float > &init) const override
std::unique_ptr< Accumulator< std::vector< double > > >	createAccumulatorImpl (const std::vector< double > &init) const override
template<typename T >
std::unique_ptr< Accumulator< T > >	createAccumulatorImplT (const T &init) const
template<typename T >
void	allGathervImpl (std::vector< T > &x) const
void	computeGlobalUniqueConsecutiveLocIndices (const std::vector< std::pair< double, int >> &dist_and_lidx_glb)

Private Attributes
double	radius_
eckit::geometry::Point2	center_
std::unordered_set< std::size_t >	recordsInHalo_
std::vector< bool >	patchObsBool_
std::vector< size_t >	globalUniqueConsecutiveLocIndices_
std::unordered_set< std::size_t >	recordsOutsideHalo_
std::unordered_map< std::size_t, double >	recordDistancesFromCenter_
std::vector< size_t >	haloLocRecords_
std::vector< size_t >	haloLocVector_
const double	radius_earth_ = 6.371e6
const std::string	distName_ = "Halo"

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

Halo distribution.

All obs. are divided into compact overlapping sets assigned to each PE. Specifically, a record is assigned to a PE if the first location belonging to that record lies at most a certain distance (controlled by the option radius) from the center of the halo associated with that PE (controlled by the option center).

Author

Sergey Frolov (CIRES)

Definition at line 34 of file Halo.h.

Constructor & Destructor Documentation

Halo()

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

explicit

Halo selector.

This distribution puts observations within a halo on the same processor

Definition at line 42 of file Halo.cc.

~Halo()

ioda::Halo::~Halo

(

)

Definition at line 74 of file Halo.cc.

Member Function Documentation

allGatherv() [1/6]

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

overridevirtual

Implements ioda::Distribution.

Definition at line 382 of file Halo.cc.

Here is the call graph for this function:

allGatherv() [2/6]

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

overridevirtual

Implements ioda::Distribution.

Definition at line 378 of file Halo.cc.

Here is the call graph for this function:

allGatherv() [3/6]

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

overridevirtual

Implements ioda::Distribution.

Definition at line 374 of file Halo.cc.

Here is the call graph for this function:

allGatherv() [4/6]

void ioda::Halo::allGatherv ( std::vector< size_t > &  x ) const

overridevirtual

Gather observation data from all processes and deliver the combined data to all processes.

Parameters

[in,out]

x

On input: a vector whose ith element is associated with the ith observation held by the calling process. On output: a concatenation of the vectors x passed by all calling processes, with duplicates removed (i.e. if any observations are duplicated across multiple processes, the elements of x corresponding to these data are included only once).

Implements ioda::Distribution.

Definition at line 370 of file Halo.cc.

Here is the call graph for this function:

allGatherv() [5/6]

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

overridevirtual

overloading for std::string

Implements ioda::Distribution.

Definition at line 392 of file Halo.cc.

Here is the call graph for this function:

allGatherv() [6/6]

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

overridevirtual

overloading for util::DateTime

Implements ioda::Distribution.

Definition at line 387 of file Halo.cc.

Here is the call graph for this function:

allGathervImpl()

template<typename T >

void ioda::Halo::allGathervImpl ( std::vector< T > &  x ) const

private

Definition at line 397 of file Halo.cc.

Here is the caller graph for this function:

assignRecord()

void ioda::Halo::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 79 of file Halo.cc.

computeGlobalUniqueConsecutiveLocIndices()

void ioda::Halo::computeGlobalUniqueConsecutiveLocIndices ( const std::vector< std::pair< double, int >> &  dist_and_lidx_glb )

private

Definition at line 185 of file Halo.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

computePatchLocs()

void ioda::Halo::computePatchLocs ( )

overridevirtual

If necessary, identifies locations of "patch obs", i.e.

locations belonging to records owned by this PE.

This function must be called when all records have been assigned, and in particular before any calls to the createAccumulator() and globalUniqueConsecutiveLocationIndex() member functions or the global functions and dotProduct(), globalNumNonMissingObs().

Reimplemented from ioda::Distribution.

Definition at line 114 of file Halo.cc.

Here is the call graph for this function:

createAccumulatorImpl() [1/8]

std::unique_ptr< Accumulator< std::vector< double > > > ioda::Halo::createAccumulatorImpl ( const std::vector< double > &  init ) const

overrideprivatevirtual

Implements ioda::Distribution.

Definition at line 359 of file Halo.cc.

Here is the call graph for this function:

createAccumulatorImpl() [2/8]

std::unique_ptr< Accumulator< std::vector< float > > > ioda::Halo::createAccumulatorImpl ( const std::vector< float > &  init ) const

overrideprivatevirtual

Implements ioda::Distribution.

Definition at line 354 of file Halo.cc.

Here is the call graph for this function:

createAccumulatorImpl() [3/8]

std::unique_ptr< Accumulator< std::vector< int > > > ioda::Halo::createAccumulatorImpl ( const std::vector< int > &  init ) const

overrideprivatevirtual

Create an object that can be used to calculate the sums of multiple location-dependent quantities over locations held on all PEs, each taken into account only once even if it's held on multiple PEs.

Parameters

init	A vector of as many elements as there are sums to calculate. The values of these elements are ignored.

Implements ioda::Distribution.

Definition at line 344 of file Halo.cc.

Here is the call graph for this function:

createAccumulatorImpl() [4/8]

std::unique_ptr< Accumulator< std::vector< std::size_t > > > ioda::Halo::createAccumulatorImpl ( const std::vector< std::size_t > &  init ) const

overrideprivatevirtual

Implements ioda::Distribution.

Definition at line 349 of file Halo.cc.

Here is the call graph for this function:

createAccumulatorImpl() [5/8]

std::unique_ptr< Accumulator< double > > ioda::Halo::createAccumulatorImpl ( double  init ) const

overrideprivatevirtual

Implements ioda::Distribution.

Definition at line 339 of file Halo.cc.

Here is the call graph for this function:

createAccumulatorImpl() [6/8]

std::unique_ptr< Accumulator< float > > ioda::Halo::createAccumulatorImpl ( float  init ) const

overrideprivatevirtual

Implements ioda::Distribution.

Definition at line 334 of file Halo.cc.

Here is the call graph for this function:

createAccumulatorImpl() [7/8]

std::unique_ptr< Accumulator< int > > ioda::Halo::createAccumulatorImpl ( int  init ) const

overrideprivatevirtual

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.

Parameters

init	Used only to select the right overload – the value is ignored.

Implements ioda::Distribution.

Definition at line 324 of file Halo.cc.

Here is the call graph for this function:

createAccumulatorImpl() [8/8]

std::unique_ptr< Accumulator< std::size_t > > ioda::Halo::createAccumulatorImpl ( std::size_t  init ) const

overrideprivatevirtual

Implements ioda::Distribution.

Definition at line 329 of file Halo.cc.

Here is the call graph for this function:

createAccumulatorImplT()

template<typename T >

std::unique_ptr< Accumulator< T > > ioda::Halo::createAccumulatorImplT ( const T &  init ) const

private

Definition at line 365 of file Halo.cc.

Here is the caller graph for this function:

globalUniqueConsecutiveLocationIndex()

size_t ioda::Halo::globalUniqueConsecutiveLocationIndex ( size_t  loc ) const

overridevirtual

Map the index of a location held on the calling process to the index of the corresponding element of any vector produced by allGatherv().

Implements ioda::Distribution.

Definition at line 419 of file Halo.cc.

isMyRecord()

bool ioda::Halo::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 109 of file Halo.cc.

max() [1/8]

void ioda::Halo::max ( double &  x ) const

overridevirtual

Implements ioda::Distribution.

Definition at line 286 of file Halo.cc.

Here is the call graph for this function:

max() [2/8]

void ioda::Halo::max ( float &  x ) const

overridevirtual

Implements ioda::Distribution.

Definition at line 282 of file Halo.cc.

Here is the call graph for this function:

max() [3/8]

void ioda::Halo::max ( int &  x ) const

overridevirtual

Calculates the global maximum (over all locations on all PEs) of a location-dependent quantity.

Parameters

[in,out]

x

On input, the local maximum (over all locations on the current PE) of a location-dependent quantity. On output, its global maximum.

Implements ioda::Distribution.

Definition at line 274 of file Halo.cc.

Here is the call graph for this function:

max() [4/8]

void ioda::Halo::max ( std::size_t &  x ) const

overridevirtual

Implements ioda::Distribution.

Definition at line 278 of file Halo.cc.

Here is the call graph for this function:

max() [5/8]

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

overridevirtual

Implements ioda::Distribution.

Definition at line 302 of file Halo.cc.

Here is the call graph for this function:

max() [6/8]

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

overridevirtual

Implements ioda::Distribution.

Definition at line 298 of file Halo.cc.

Here is the call graph for this function:

max() [7/8]

void ioda::Halo::max ( std::vector< int > &  x ) const

overridevirtual

Calculates the global maxima (over all locations on all PEs) of multiple location-dependent quantities.

Parameters

[in,out]

x

On input, each element of x should be the local maximum (over all locations on the current PE) of a location-dependent quantity. On output, that element will be set to the global maximum of that quantity.

Implements ioda::Distribution.

Definition at line 290 of file Halo.cc.

Here is the call graph for this function:

max() [8/8]

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

overridevirtual

Implements ioda::Distribution.

Definition at line 294 of file Halo.cc.

Here is the call graph for this function:

maxImpl()

template<typename T >

void ioda::Halo::maxImpl ( T &  x ) const

private

Definition at line 307 of file Halo.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

min() [1/8]

void ioda::Halo::min ( double &  x ) const

overridevirtual

Implements ioda::Distribution.

Definition at line 248 of file Halo.cc.

Here is the call graph for this function:

min() [2/8]

void ioda::Halo::min ( float &  x ) const

overridevirtual

Implements ioda::Distribution.

Definition at line 244 of file Halo.cc.

Here is the call graph for this function:

min() [3/8]

void ioda::Halo::min ( int &  x ) const

overridevirtual

Calculates the global minimum (over all locations on all PEs) of a location-dependent quantity.

Parameters

[in,out]

x

On input, the local minimum (over all locations on the current PE) of a location-dependent quantity. On output, its global minimum.

Implements ioda::Distribution.

Definition at line 236 of file Halo.cc.

Here is the call graph for this function:

min() [4/8]

void ioda::Halo::min ( std::size_t &  x ) const

overridevirtual

Implements ioda::Distribution.

Definition at line 240 of file Halo.cc.

Here is the call graph for this function:

min() [5/8]

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

overridevirtual

Implements ioda::Distribution.

Definition at line 264 of file Halo.cc.

Here is the call graph for this function:

min() [6/8]

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

overridevirtual

Implements ioda::Distribution.

Definition at line 260 of file Halo.cc.

Here is the call graph for this function:

min() [7/8]

void ioda::Halo::min ( std::vector< int > &  x ) const

overridevirtual

Calculates the global minima (over all locations on all PEs) of multiple location-dependent quantities.

Parameters

[in,out]

x

On input, each element of x should be the local minimum (over all locations on the current PE) of a location-dependent quantity. On output, that element will be set to the global minimum of that quantity.

Implements ioda::Distribution.

Definition at line 252 of file Halo.cc.

Here is the call graph for this function:

min() [8/8]

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

overridevirtual

Implements ioda::Distribution.

Definition at line 256 of file Halo.cc.

Here is the call graph for this function:

minImpl()

template<typename T >

void ioda::Halo::minImpl ( T &  x ) const

private

Definition at line 269 of file Halo.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

name()

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

inlineoverridevirtual

Implements ioda::Distribution.

Definition at line 73 of file Halo.h.

Here is the caller graph for this function:

patchObs()

void ioda::Halo::patchObs ( std::vector< bool > &  isPatchObs ) const

overridevirtual

Sets each element of the provided vector to true if the corresponding location is a "patch obs", i.e.

it belongs to a record owned by this PE, and to false otherwise.

Parameters

isPatchObs

Preallocated vector of as many elements as there are locations on this PE.

Implements ioda::Distribution.

Definition at line 231 of file Halo.cc.

reductionImpl() [1/2]

template<typename T >

void ioda::Halo::reductionImpl ( std::vector< T > &  x, eckit::mpi::Operation::Code  op  ) const

private

Definition at line 318 of file Halo.cc.

reductionImpl() [2/2]

template<typename T >

void ioda::Halo::reductionImpl ( T &  x, eckit::mpi::Operation::Code  op  ) const

private

Definition at line 313 of file Halo.cc.

Here is the caller graph for this function:

Member Data Documentation

center_

eckit::geometry::Point2 ioda::Halo::center_

private

Definition at line 115 of file Halo.h.

distName_

const std::string ioda::Halo::distName_ = "Halo"

private

Definition at line 140 of file Halo.h.

globalUniqueConsecutiveLocIndices_

std::vector<size_t> ioda::Halo::globalUniqueConsecutiveLocIndices_

private

Definition at line 122 of file Halo.h.

haloLocRecords_

std::vector<size_t> ioda::Halo::haloLocRecords_

private

Definition at line 133 of file Halo.h.

haloLocVector_

std::vector<size_t> ioda::Halo::haloLocVector_

private

Definition at line 135 of file Halo.h.

patchObsBool_

std::vector<bool> ioda::Halo::patchObsBool_

private

Definition at line 119 of file Halo.h.

radius_

double ioda::Halo::radius_

private

Definition at line 114 of file Halo.h.

radius_earth_

const double ioda::Halo::radius_earth_ = 6.371e6

private

Definition at line 138 of file Halo.h.

recordDistancesFromCenter_

std::unordered_map<std::size_t, double> ioda::Halo::recordDistancesFromCenter_

private

Definition at line 131 of file Halo.h.

recordsInHalo_

std::unordered_set<std::size_t> ioda::Halo::recordsInHalo_

private

Definition at line 117 of file Halo.h.

recordsOutsideHalo_

std::unordered_set<std::size_t> ioda::Halo::recordsOutsideHalo_

private

Definition at line 128 of file Halo.h.

---

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

• Halo.h
• Halo.cc