DistributedData.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html

#pragma once

#include "libmesh/parallel_object.h"
#include "libmesh/parallel.h"
#include "MooseTypes.h"

namespace StochasticTools
{

template <typename T>
class DistributedData : public libMesh::ParallelObject
{
public:
  DistributedData(const libMesh::Parallel::Communicator & comm_in);

  void initializeContainer(unsigned int num_global_entries);

  void changeEntry(unsigned int glob_i, const T & sample);

  void addNewEntry(unsigned int glob_i, const T & sample);

  void closeContainer() { _closed = true; };

  bool hasGlobalEntry(unsigned int glob_i) const;

  typename std::vector<T>::iterator localEntryBegin() { return _local_entries.begin(); };

  typename std::vector<T>::iterator localEntryEnd() { return _local_entries.end(); };

  typename std::vector<unsigned int>::iterator localEntryIDBegin()
  {
    return _local_entry_ids.begin();
  };

  typename std::vector<unsigned int>::iterator localEntryIDEnd() { return _local_entry_ids.end(); };

  const T & getGlobalEntry(unsigned int glob_i) const;

  const T & getLocalEntry(unsigned int loc_i) const;

  const std::vector<T> & getLocalEntries() const { return _local_entries; };

  const std::vector<unsigned int> & getLocalEntryIDs() const { return _local_entry_ids; };

  unsigned int getNumberOfGlobalEntries() const;

  unsigned int getNumberOfLocalEntries() const { return _n_local_entries; };

  unsigned int getLocalIndex(unsigned int glob_i) const;

  unsigned int getGlobalIndex(unsigned int loc_i) const;

protected:
  std::vector<T> _local_entries;

  std::vector<unsigned int> _local_entry_ids;

  bool _closed;

  unsigned int _n_local_entries;
};

} // StochasticTools namespace