ioda::Distribution Class Reference

class for distributing obs across multiple process elements More...

#include <Distribution.h>

Inheritance diagram for ioda::Distribution:

Public Member Functions
	Distribution (const eckit::mpi::Comm &Comm)
virtual	~Distribution ()=0
virtual bool	isMyRecord (std::size_t RecNum) const =0
virtual bool	isDistributed () const =0

Protected Attributes
const eckit::mpi::Comm &	comm_
	Local MPI communicator. More...

Detailed Description

class for distributing obs across multiple process elements

This Distribution class is a base class where various subclasses of this class define different methods for distributing obs.

The subclasses of this base class need to fill in the isMyRecord method with the appropriate function. The client will use the isMyRecord method to determine what records to keep when reading in observations.

Author

Xin Zhang (JCSDA)

Definition at line 30 of file src/distribution/Distribution.h.

Constructor & Destructor Documentation

Distribution()

ioda::Distribution::Distribution ( const eckit::mpi::Comm &  Comm )

explicit

Definition at line 17 of file Distribution.cc.

~Distribution()

ioda::Distribution::~Distribution ( )

pure virtual

Definition at line 23 of file Distribution.cc.

Member Function Documentation

isDistributed()

virtual bool ioda::Distribution::isDistributed ( ) const

pure virtual

Implemented in ioda::InefficientDistribution, and ioda::RoundRobin.

isMyRecord()

virtual bool ioda::Distribution::isMyRecord ( std::size_t  RecNum ) const

pure virtual

Implemented in ioda::InefficientDistribution, and ioda::RoundRobin.

Member Data Documentation

comm_

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

protected

Local MPI communicator.

Definition at line 40 of file src/distribution/Distribution.h.

---

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

• src/distribution/Distribution.h
• Distribution.cc