StochasticTools::DistributedData< T > Class Template Reference

Templated class that specifies a distributed storage of a vector of given objects. More...

#include <DistributedData.h>

Inheritance diagram for StochasticTools::DistributedData< T >:

Public Member Functions
	DistributedData (const libMesh::Parallel::Communicator &comm_in)
void	initializeContainer (unsigned int num_global_entries)
	Initialize the container with a given number of samples. More...
void	changeEntry (unsigned int glob_i, const T &sample)
	Changing a sample with a global index if it is owned locally. More...
void	addNewEntry (unsigned int glob_i, const T &sample)
	Adding a new sample locally with a global index. More...
void	closeContainer ()
	Closes the container meaning that no new samples can be added or the already existing samples canot be changed. More...
bool	hasGlobalEntry (unsigned int glob_i) const
	Checking of sample with global ID is locally owned ot not. More...
std::vector< T >::iterator	localEntryBegin ()
	Getting an itertor to the beginning of the local samples. More...
std::vector< T >::iterator	localEntryEnd ()
	Getting an iterator to the end of the locally owned samples. More...
std::vector< unsigned int >::iterator	localEntryIDBegin ()
	Getting an iterator to the beginning of the locally owned sample IDs. More...
std::vector< unsigned int >::iterator	localEntryIDEnd ()
	Getting an iterator to the end of the locally owned sample IDs. More...
const T &	getGlobalEntry (unsigned int glob_i) const
	Getting a sample using its global index. More...
const T &	getLocalEntry (unsigned int loc_i) const
	Getting a sample using its local index. More...
const std::vector< T > &	getLocalEntries () const
	Getting all of the locally owned samples. More...
const std::vector< unsigned int > &	getLocalEntryIDs () const
	Getting the vector of sample IDs for locally owned samples. More...
unsigned int	getNumberOfGlobalEntries () const
	Getting the number of global samples. More...
unsigned int	getNumberOfLocalEntries () const
	Getting the number of locally owned samples. More...
unsigned int	getLocalIndex (unsigned int glob_i) const
	Getting the local index of a global sample if locally owned. More...
unsigned int	getGlobalIndex (unsigned int loc_i) const
	Getting the global index of a locally owned sample. More...
const Parallel::Communicator &	comm () const
processor_id_type	n_processors () const
processor_id_type	processor_id () const

Protected Attributes
std::vector< T >	_local_entries
	The vector where the samples are stored. More...
std::vector< unsigned int >	_local_entry_ids
	The vector where the global sample IDs are stored. More...
bool	_closed
	Flag which shows if the container is closed or not. More...
unsigned int	_n_local_entries
	Number of local samples. More...
const Parallel::Communicator &	_communicator

Detailed Description

template<typename T>
class StochasticTools::DistributedData< T >

Templated class that specifies a distributed storage of a vector of given objects.

It has a helper vector that contains global IDs for every stored item.

Definition at line 24 of file DistributedData.h.

Constructor & Destructor Documentation

DistributedData()

template<typename T >

StochasticTools::DistributedData< T >::DistributedData

(

const libMesh::Parallel::Communicator &

comm_in

)

Definition at line 19 of file DistributedData.C.

  : libMesh::ParallelObject(comm_in), _closed(false), _n_local_entries(0)
{
}

Member Function Documentation

addNewEntry()

template<typename T >

void StochasticTools::DistributedData< T >::addNewEntry	(	unsigned int	glob_i,
		const T &	sample
	)

Adding a new sample locally with a global index.

Definition at line 56 of file DistributedData.C.

{
  auto it = std::find(_local_entry_ids.begin(), _local_entry_ids.end(), glob_i);
  if (it != _local_entry_ids.end())
    ::mooseError("Local object ID (", glob_i, ") already exists!");
  if (_closed)
    ::mooseError("DistributeData has already been closed, cannot add new elements!");

  _local_entries.push_back(entry);
  _local_entry_ids.push_back(glob_i);
  _n_local_entries += 1;
}

changeEntry()

template<typename T >

void StochasticTools::DistributedData< T >::changeEntry	(	unsigned int	glob_i,
		const T &	sample
	)

Changing a sample with a global index if it is owned locally.

Definition at line 71 of file DistributedData.C.

{
  auto it = std::find(_local_entry_ids.begin(), _local_entry_ids.end(), glob_i);
  if (it == _local_entry_ids.end())
    ::mooseError("Local object ID (", glob_i, ") does not exists!");
  if (_closed)
    ::mooseError("DistributeData has already been closed, cannot change elements!");

  _local_entries[std::distance(_local_entry_ids.begin(), it)] = entry;
}

closeContainer()

template<typename T >

void StochasticTools::DistributedData< T >::closeContainer ( )

inline

Closes the container meaning that no new samples can be added or the already existing samples canot be changed.

Definition at line 41 of file DistributedData.h.

{ _closed = true; };

getGlobalEntry()

template<typename T >

const T & StochasticTools::DistributedData< T >::getGlobalEntry

(

unsigned int

glob_i

)

const

Getting a sample using its global index.

Definition at line 84 of file DistributedData.C.

{
  auto it = std::find(_local_entry_ids.begin(), _local_entry_ids.end(), glob_i);
  if (it == _local_entry_ids.end())
    ::mooseError("Local object ID (", glob_i, ") does not exists!");

  return _local_entries[std::distance(_local_entry_ids.begin(), it)];
}

getGlobalIndex()

template<typename T >

unsigned int StochasticTools::DistributedData< T >::getGlobalIndex

(

unsigned int

loc_i

)

const

Getting the global index of a locally owned sample.

Definition at line 140 of file DistributedData.C.

{
  if (loc_i > _n_local_entries - 1)
    ::mooseError("The requested local index (",
                 loc_i,
                 ") is greater than the size (",
                 _n_local_entries,
                 ") of the locally stored vector!");

  return _local_entry_ids[loc_i];
}

getLocalEntries()

template<typename T >

const std::vector<T>& StochasticTools::DistributedData< T >::getLocalEntries ( ) const

inline

Getting all of the locally owned samples.

Definition at line 68 of file DistributedData.h.

{ return _local_entries; };

getLocalEntry()

template<typename T >

const T & StochasticTools::DistributedData< T >::getLocalEntry

(

unsigned int

loc_i

)

const

Getting a sample using its local index.

Definition at line 95 of file DistributedData.C.

{
  if (loc_i > _n_local_entries - 1)
    ::mooseError("The requested local index (",
                 loc_i,
                 ") is greater than the size (",
                 _n_local_entries,
                 ") of the locally stored vector!");

  return _local_entries[loc_i];
}

getLocalEntryIDs()

template<typename T >

const std::vector<unsigned int>& StochasticTools::DistributedData< T >::getLocalEntryIDs ( ) const

inline

Getting the vector of sample IDs for locally owned samples.

Definition at line 71 of file DistributedData.h.

{ return _local_entry_ids; };

getLocalIndex()

template<typename T >

unsigned int StochasticTools::DistributedData< T >::getLocalIndex

(

unsigned int

glob_i

)

const

Getting the local index of a global sample if locally owned.

Definition at line 129 of file DistributedData.C.

{
  const auto it = std::find(_local_entry_ids.begin(), _local_entry_ids.end(), glob_i);
  if (it == _local_entry_ids.end())
    ::mooseError("Local object ID (", glob_i, ") does not exists!");

  return std::distance(_local_entry_ids.begin(), it);
}

getNumberOfGlobalEntries()

template<typename T >

unsigned int StochasticTools::DistributedData< T >::getNumberOfGlobalEntries

(

)

const

Getting the number of global samples.

Definition at line 109 of file DistributedData.C.

{
  unsigned int val = _n_local_entries;
  _communicator.sum(val);
  return val;
}

getNumberOfLocalEntries()

template<typename T >

unsigned int StochasticTools::DistributedData< T >::getNumberOfLocalEntries ( ) const

inline

Getting the number of locally owned samples.

Definition at line 77 of file DistributedData.h.

{ return _n_local_entries; };

hasGlobalEntry()

template<typename T >

bool StochasticTools::DistributedData< T >::hasGlobalEntry

(

unsigned int

glob_i

)

const

Checking of sample with global ID is locally owned ot not.

Definition at line 118 of file DistributedData.C.

{
  const auto it = std::find(_local_entry_ids.begin(), _local_entry_ids.end(), glob_i);
  if (it != _local_entry_ids.end())
    return true;

  return false;
}

initializeContainer()

template<typename T >

void StochasticTools::DistributedData< T >::initializeContainer

(

unsigned int

num_global_entries

)

Initialize the container with a given number of samples.

this partitions the samples using linearPartitioning.

Definition at line 26 of file DistributedData.C.

{
  // This function can be used when a linear partitioning is required and the
  // number of global samples is known in advance. We must temporarily
  // use dof_id_type for the last three args (pass by reference),
  // but will cast back to unsigned int later
  dof_id_type local_entry_begin;
  dof_id_type local_entry_end;
  dof_id_type n_local_entries;

  MooseUtils::linearPartitionItems(n_global_entries,
                                   n_processors(),
                                   processor_id(),
                                   n_local_entries,
                                   local_entry_begin,
                                   local_entry_end);
  _n_local_entries = n_local_entries;
  _local_entries.resize(_n_local_entries);
  _local_entry_ids.resize(_n_local_entries);

  // Filling the sample ID vector, leaving the elements of the sample vector
  // with the default constructor.
  for (unsigned int entry_i = local_entry_begin; entry_i < (unsigned int)local_entry_end; ++entry_i)
  {
    _local_entry_ids[entry_i] = entry_i;
  }
}

localEntryBegin()

template<typename T >

std::vector<T>::iterator StochasticTools::DistributedData< T >::localEntryBegin ( )

inline

Getting an itertor to the beginning of the local samples.

Definition at line 47 of file DistributedData.h.

{ return _local_entries.begin(); };

localEntryEnd()

template<typename T >

std::vector<T>::iterator StochasticTools::DistributedData< T >::localEntryEnd ( )

inline

Getting an iterator to the end of the locally owned samples.

Definition at line 50 of file DistributedData.h.

{ return _local_entries.end(); };

localEntryIDBegin()

template<typename T >

std::vector<unsigned int>::iterator StochasticTools::DistributedData< T >::localEntryIDBegin ( )

inline

Getting an iterator to the beginning of the locally owned sample IDs.

Definition at line 53 of file DistributedData.h.

  {
    return _local_entry_ids.begin();
  };

localEntryIDEnd()

template<typename T >

std::vector<unsigned int>::iterator StochasticTools::DistributedData< T >::localEntryIDEnd ( )

inline

Getting an iterator to the end of the locally owned sample IDs.

Definition at line 59 of file DistributedData.h.

{ return _local_entry_ids.end(); };

Member Data Documentation

_closed

template<typename T >

bool StochasticTools::DistributedData< T >::_closed

protected

Flag which shows if the container is closed or not.

Definition at line 93 of file DistributedData.h.

Referenced by StochasticTools::DistributedData< T >::closeContainer().

_local_entries

template<typename T >

std::vector<T> StochasticTools::DistributedData< T >::_local_entries

protected

The vector where the samples are stored.

Definition at line 87 of file DistributedData.h.

Referenced by StochasticTools::DistributedData< T >::getLocalEntries(), StochasticTools::DistributedData< T >::localEntryBegin(), and StochasticTools::DistributedData< T >::localEntryEnd().

_local_entry_ids

template<typename T >

std::vector<unsigned int> StochasticTools::DistributedData< T >::_local_entry_ids

protected

The vector where the global sample IDs are stored.

Definition at line 90 of file DistributedData.h.

Referenced by StochasticTools::DistributedData< T >::getLocalEntryIDs(), StochasticTools::DistributedData< T >::localEntryIDBegin(), and StochasticTools::DistributedData< T >::localEntryIDEnd().

_n_local_entries

template<typename T >

unsigned int StochasticTools::DistributedData< T >::_n_local_entries

protected

Number of local samples.

Definition at line 96 of file DistributedData.h.

Referenced by StochasticTools::DistributedData< T >::getNumberOfLocalEntries().

---

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

• stochastic_tools/include/utils/DistributedData.h
• stochastic_tools/src/utils/DistributedData.C