StochasticTools::VectorCalculator< InType, OutType, CalcType > Class Template Reference

#include <VectorCalculators.h>

Inheritance diagram for StochasticTools::VectorCalculator< InType, OutType, CalcType >:

Public Member Functions
std::vector< OutType >	compute (const std::vector< InType > &, bool)
	Evaluate the calculator on the full vector of data.
void	initializeCalculator ()
	Public function that must be called before updateCalculator and finalizeCalculator.
void	updateCalculator (const typename InType::value_type &)
	Public function to update calculator with a piece of data.
void	finalizeCalculator (bool)
	Public function to finalize the resulting calculator value.
std::vector< OutType >	getValue () const
	Public function to return the calculated value _state must be FINALIZED.
const std::string &	name () const
const Parallel::Communicator &	comm () const
processor_id_type	n_processors () const
processor_id_type	processor_id () const

Protected Member Functions
virtual void	initialize () override
	This function is used to reset the calculator to its initial state and prepare it for another evaluation.
virtual void	update (const InType &data) override
virtual void	finalize (bool is_distributed) override
	This is used to compute the resulting calculator value by performing necessary arithmetic and parallel communication.
virtual std::vector< OutType >	get () const override
	Returns the resulting calculator value.
virtual void	update (const typename InType::value_type &)=0
	Updating the calculator with a piece of data.

Protected Attributes
const Parallel::Communicator &	_communicator

Private Types
enum	CalculatorState

Private Attributes
std::vector< CalcType< InType, OutType > >	_calcs
std::vector< OutType >	_values
const std::string	_name
CalculatorState	_state

Detailed Description

template<typename InType, typename OutType, template< typename, typename > class CalcType>
class StochasticTools::VectorCalculator< InType, OutType, CalcType >

Definition at line 18 of file VectorCalculators.h.

Member Enumeration Documentation

CalculatorState

enum StochasticTools::Calculator::CalculatorState

privateinherited

Definition at line 125 of file Calculators.h.

  {
    NONE,
    INITIALIZED,
    FINALIZED
  };

Member Function Documentation

compute()

std::vector< OutType > StochasticTools::Calculator< std::vector< InType > , std::vector< OutType > >::compute ( const std::vector< InType > &  data, bool  is_distributed  )

inherited

Evaluate the calculator on the full vector of data.

This is basically a convenient wrapper around initializeCalculator, updateCalculator, finalizeCalculator, and getvalue.

Definition at line 75 of file Calculators.h.

{
  initializeCalculator();
  for (const auto & val : data)
    updateCalculator(val);
  finalizeCalculator(is_distributed);
  return getValue();
}

finalize()

template<typename InType , typename OutType , template< typename, typename > class CalcType>

void StochasticTools::VectorCalculator< InType, OutType, CalcType >::finalize ( bool  )

overrideprotectedvirtual

This is used to compute the resulting calculator value by performing necessary arithmetic and parallel communication.

This only called once after all the input data is entered through update.

Implements StochasticTools::Calculator< std::vector< InType >, std::vector< OutType > >.

Definition at line 59 of file VectorCalculators.h.

{
  // Need to make calculator objects if some data added
  if (is_distributed)
  {
    auto ncalc = _calcs.size();
    this->_communicator.max(ncalc);
    for (const auto & i : make_range(_calcs.size(), ncalc))
    {
      _calcs.emplace_back(*this, this->name() + "_" + std::to_string(i));
      _calcs.back().initializeCalculator();
    }
  }
 
  _values.reserve(_calcs.size());
  for (auto & cc : _calcs)
  {
    cc.finalizeCalculator(is_distributed);
    _values.push_back(cc.getValue());
  }
}

finalizeCalculator()

void StochasticTools::Calculator< std::vector< InType > , std::vector< OutType > >::finalizeCalculator ( bool  is_distributed )

inherited

Public function to finalize the resulting calculator value.

_state must be INITLIALIZED Sets _state to FINALIZED

Definition at line 92 of file Calculators.h.

{
  if (_state != CalculatorState::INITIALIZED)
    ::mooseError("Calculator is in wrong state.");
  finalize(is_distributed);
  _state = CalculatorState::FINALIZED;
}

get()

template<typename InType , typename OutType , template< typename, typename > class CalcType>

virtual std::vector< OutType > StochasticTools::VectorCalculator< InType, OutType, CalcType >::get ( ) const

inlineoverrideprotectedvirtual

Returns the resulting calculator value.

It is important to not modify member data here so the calculator can retain its state.

Implements StochasticTools::Calculator< std::vector< InType >, std::vector< OutType > >.

Definition at line 27 of file VectorCalculators.h.

{ return _values; }

getValue()

std::vector< OutType > StochasticTools::Calculator< std::vector< InType > , std::vector< OutType > >::getValue ( ) const

inherited

Public function to return the calculated value _state must be FINALIZED.

Definition at line 97 of file Calculators.h.

{
  if (_state != CalculatorState::FINALIZED)
    ::mooseError("Calculator is in wrong state.");
  return get();
}

initialize()

template<typename InType , typename OutType , template< typename, typename > class CalcType>

void StochasticTools::VectorCalculator< InType, OutType, CalcType >::initialize ( )

overrideprotectedvirtual

This function is used to reset the calculator to its initial state and prepare it for another evaluation.

This usually involves clearing class members.

Implements StochasticTools::Calculator< std::vector< InType >, std::vector< OutType > >.

Definition at line 36 of file VectorCalculators.h.

{
  _calcs.clear();
  _values.clear();
}

initializeCalculator()

void StochasticTools::Calculator< std::vector< InType > , std::vector< OutType > >::initializeCalculator ( )

inherited

Public function that must be called before updateCalculator and finalizeCalculator.

Sets _state to INITIALIZED

Definition at line 81 of file Calculators.h.

{
  initialize();
  _state = CalculatorState::INITIALIZED;
}

name()

const std::string & StochasticTools::Calculator< std::vector< InType > , std::vector< OutType > >::name ( ) const

inlineinherited

Definition at line 99 of file Calculators.h.

{ return _name; }

update() [1/2]

template<typename InType , typename OutType , template< typename, typename > class CalcType>

void StochasticTools::VectorCalculator< InType, OutType, CalcType >::update ( const InType &  data )

overrideprotectedvirtual

Definition at line 44 of file VectorCalculators.h.

{
  for (const auto & i : index_range(data))
  {
    if (i >= _calcs.size())
    {
      _calcs.emplace_back(*this, this->name() + "_" + std::to_string(i));
      _calcs.back().initializeCalculator();
    }
    _calcs[i].updateCalculator(data[i]);
  }
}

update() [2/2]

virtual void StochasticTools::Calculator< std::vector< InType > , std::vector< OutType > >::update ( const typename InType::value_type &  )

protectedpure virtualinherited

Updating the calculator with a piece of data.

Sometimes some clever arithmetic is required to avoid storing data.

updateCalculator()

void StochasticTools::Calculator< std::vector< InType > , std::vector< OutType > >::updateCalculator ( const typename InType::value_type &  val )

inherited

Public function to update calculator with a piece of data.

_state mush be INITIALIZED

Definition at line 86 of file Calculators.h.

{
  mooseAssert(_state == CalculatorState::INITIALIZED, "Calculator is in wrong state.");
  update(val);
}

Member Data Documentation

_calcs

template<typename InType , typename OutType , template< typename, typename > class CalcType>

std::vector<CalcType<InType, OutType> > StochasticTools::VectorCalculator< InType, OutType, CalcType >::_calcs

private

Definition at line 30 of file VectorCalculators.h.

_name

const std::string StochasticTools::Calculator< std::vector< InType > , std::vector< OutType > >::_name

privateinherited

Definition at line 132 of file Calculators.h.

_state

CalculatorState StochasticTools::Calculator< std::vector< InType > , std::vector< OutType > >::_state

privateinherited

Definition at line 133 of file Calculators.h.

_values

template<typename InType , typename OutType , template< typename, typename > class CalcType>

std::vector<OutType> StochasticTools::VectorCalculator< InType, OutType, CalcType >::_values

private

Definition at line 31 of file VectorCalculators.h.

Referenced by StochasticTools::VectorCalculator< InType, OutType, CalcType >::get().

---

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

• stochastic_tools/include/utils/VectorCalculators.h