StochasticReporterContext< T > Class Template Reference

#include <StochasticReporter.h>

Inheritance diagram for StochasticReporterContext< T >:

Public Types
enum	AutoOperation

Public Member Functions
	StochasticReporterContext (const libMesh::ParallelObject &other, const MooseObject &producer, ReporterState< std::vector< T >> &state, const Sampler &sampler)
virtual void	copyValuesBack () override
virtual void	finalize () override
virtual std::string	contextType () const override
virtual void	storeInfo (nlohmann::json &json) const override
virtual void	declareClone (ReporterData &r_data, const ReporterName &r_name, const ReporterMode &mode, const MooseObject &producer) const override
virtual void	declareVectorClone (ReporterData &r_data, const ReporterName &r_name, const ReporterMode &mode, const MooseObject &producer) const override
virtual void	resize (dof_id_type local_size) final
virtual void	clear () final
virtual void	vectorSum () final
const ReporterName &	name () const override final
const ReporterState< std::vector< T > > &	state () const
virtual std::string	type () const override
virtual void	transfer (ReporterData &r_data, const ReporterName &r_name, unsigned int time_index=0) const override
virtual void	transferToVector (ReporterData &r_data, const ReporterName &r_name, dof_id_type index, unsigned int time_index=0) const override
virtual void	transferFromVector (ReporterData &r_data, const ReporterName &r_name, dof_id_type index, unsigned int time_index=0) const override
void	init (const ReporterMode &mode)
const MooseObject &	getProducer () const
const ReporterProducerEnum &	getProducerModeEnum () const
const Parallel::Communicator &	comm () const
processor_id_type	n_processors () const
processor_id_type	processor_id () const

Protected Member Functions
void	broadcast ()
virtual void	store (nlohmann::json &json) const override
virtual bool	restoreState () override
void	requiresConsumerModes (const ReporterStateBase &state, const std::set< ReporterMode > &modes) const

Protected Attributes
const Sampler &	_sampler
bool	_has_gathered
bool	_has_allgathered
ReporterState< std::vector< T > > &	_state
const MooseObject &	_producer
ReporterProducerEnum	_producer_enum
const Parallel::Communicator &	_communicator

Detailed Description

template<typename T>
class StochasticReporterContext< T >

Definition at line 18 of file StochasticReporter.h.

Constructor & Destructor Documentation

StochasticReporterContext()

template<typename T >

StochasticReporterContext< T >::StochasticReporterContext	(	const libMesh::ParallelObject &	other,
		const MooseObject &	producer,
		ReporterState< std::vector< T >> &	state,
		const Sampler &	sampler
	)

Definition at line 38 of file StochasticReporter.h.

  : ReporterGeneralContext<std::vector<T>>(other, producer, state),
    _sampler(sampler),
    _has_gathered(false),
    _has_allgathered(false)
{
  this->_state.value().resize(_sampler.getNumberOfLocalRows());
}

Member Function Documentation

contextType()

template<typename T >

virtual std::string StochasticReporterContext< T >::contextType ( ) const

inlineoverridevirtual

Reimplemented from ReporterGeneralContext< std::vector< T > >.

Definition at line 28 of file StochasticReporter.h.

{ return MooseUtils::prettyCppType(this); }

copyValuesBack()

template<typename T >

void StochasticReporterContext< T >::copyValuesBack ( )

overridevirtual

Reimplemented from ReporterGeneralContext< std::vector< T > >.

Definition at line 52 of file StochasticReporter.h.

{
  this->_state.copyValuesBack();
  if (_has_allgathered || (_has_gathered && this->processor_id() == 0))
  {
    auto & val = this->_state.value();
    val.erase(val.begin(), val.begin() + _sampler.getLocalRowBegin());
    val.erase(val.begin() + _sampler.getLocalRowEnd(), val.end());
  }
  _has_gathered = false;
  _has_allgathered = false;
}

finalize()

template<typename T >

void StochasticReporterContext< T >::finalize ( )

overridevirtual

Reimplemented from ReporterGeneralContext< std::vector< T > >.

Definition at line 67 of file StochasticReporter.h.

{
  bool gather_required = this->_producer_enum == REPORTER_MODE_ROOT;
  bool allgather_required = this->_producer_enum == REPORTER_MODE_REPLICATED;
  for (const auto & pair : this->_state.getConsumers())
  {
    const ReporterMode consumer = pair.first;
    if (consumer == REPORTER_MODE_ROOT)
      gather_required = true;
    else if (consumer == REPORTER_MODE_REPLICATED)
      allgather_required = true;
  }

  if (allgather_required && !_has_allgathered)
    StochasticTools::stochasticAllGather(this->comm(), this->_state.value());
  else if (gather_required && !_has_gathered)
    StochasticTools::stochasticGather(this->comm(), 0, this->_state.value());

  _has_gathered = gather_required || _has_gathered;
  _has_allgathered = allgather_required || _has_allgathered;
}

storeInfo()

template<typename T >

void StochasticReporterContext< T >::storeInfo ( nlohmann::json &  json ) const

overridevirtual

Reimplemented from ReporterGeneralContext< std::vector< T > >.

Definition at line 91 of file StochasticReporter.h.

{
  ReporterGeneralContext<std::vector<T>>::storeInfo(json);
  if (_has_allgathered || (_has_gathered && this->processor_id() == 0))
  {
    json["row_begin"] = 0;
    json["row_end"] = this->_sampler.getNumberOfRows();
  }
  else
  {
    json["row_begin"] = this->_sampler.getLocalRowBegin();
    json["row_end"] = this->_sampler.getLocalRowEnd();
  }
}

Member Data Documentation

_has_allgathered

template<typename T >

bool StochasticReporterContext< T >::_has_allgathered

protected

Definition at line 34 of file StochasticReporter.h.

_has_gathered

template<typename T >

bool StochasticReporterContext< T >::_has_gathered

protected

Definition at line 33 of file StochasticReporter.h.

_sampler

template<typename T >

const Sampler& StochasticReporterContext< T >::_sampler

protected

Definition at line 32 of file StochasticReporter.h.

Referenced by StochasticReporterContext< T >::StochasticReporterContext().

---

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

• stochastic_tools/include/reporters/StochasticReporter.h