StochasticTools::MeanAbsoluteValue< InType, OutType > Class Template Reference

#include <Calculators.h>

Inheritance diagram for StochasticTools::MeanAbsoluteValue< InType, OutType >:

Public Member Functions
OutType	compute (const InType &, bool)
	Evaluate the calculator on the full vector of data. More...
void	initializeCalculator ()
	Public function that must be called before updateCalculator and finalizeCalculator. More...
void	updateCalculator (const typename InType::value_type &)
	Public function to update calculator with a piece of data. More...
void	finalizeCalculator (bool)
	Public function to finalize the resulting calculator value. More...
OutType	getValue () const
	Public function to return the calculated value _state must be FINALIZED. More...
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	update (const typename InType::value_type &val) override
	Updating the calculator with a piece of data. More...
virtual void	initialize () override
	This function is used to reset the calculator to its initial state and prepare it for another evaluation. More...
virtual void	finalize (bool is_distributed) override
	This is used to compute the resulting calculator value by performing necessary arithmetic and parallel communication. More...
virtual OutType	get () const override
	Returns the resulting calculator value. More...

Protected Attributes
dof_id_type	_count
OutType	_sum
const Parallel::Communicator &	_communicator

Detailed Description

template<typename InType, typename OutType>
class StochasticTools::MeanAbsoluteValue< InType, OutType >

Definition at line 153 of file Calculators.h.

Member Function Documentation

compute()

template<typename InType, typename OutType >

OutType StochasticTools::Calculator< InType, OutType >::compute ( const 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 288 of file Calculators.h.

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

finalize()

template<typename InType , typename OutType >

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

overrideprotectedvirtualinherited

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< InType, OutType >.

Reimplemented in StochasticTools::Sum< InType, OutType >.

Definition at line 41 of file Calculators.C.

{
  if (is_distributed)
  {
    this->_communicator.sum(_count);
    this->_communicator.sum(_sum);
  }
  if (_count > 0)
    _sum /= static_cast<OutType>(_count);
}

finalizeCalculator()

template<typename InType , typename OutType >

void StochasticTools::Calculator< InType, 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 315 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 >

virtual OutType StochasticTools::Mean< InType, OutType >::get ( ) const

inlineoverrideprotectedvirtualinherited

Returns the resulting calculator value.

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

Implements StochasticTools::Calculator< InType, OutType >.

Definition at line 146 of file Calculators.h.

{ return _sum; }

getValue()

template<typename InType , typename OutType >

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

inherited

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

Definition at line 325 of file Calculators.h.

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

initialize()

template<typename InType , typename OutType >

void StochasticTools::Mean< InType, OutType >::initialize ( )

overrideprotectedvirtualinherited

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< InType, OutType >.

Definition at line 25 of file Calculators.C.

{
  _count = 0;
  _sum = OutType();
}

initializeCalculator()

template<typename InType , typename OutType >

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

inherited

Public function that must be called before updateCalculator and finalizeCalculator.

Sets _state to INITIALIZED

Definition at line 299 of file Calculators.h.

Referenced by StochasticTools::SobolCalculator< std::vector< InType >, std::vector< OutType > >::finalize(), and StochasticTools::SobolCalculator< std::vector< InType >, std::vector< OutType > >::update().

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

name()

template<typename InType, typename OutType>

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

inlineinherited

Definition at line 99 of file Calculators.h.

{ return _name; }

update()

template<typename InType , typename OutType >

void StochasticTools::MeanAbsoluteValue< InType, OutType >::update ( const typename InType::value_type &  )

overrideprotectedvirtual

Updating the calculator with a piece of data.

Sometimes some clever arithmetic is required to avoid storing data.

Reimplemented from StochasticTools::Mean< InType, OutType >.

Definition at line 55 of file Calculators.C.

{
  Mean<InType, OutType>::update(std::abs(val));
}

updateCalculator()

template<typename InType, typename OutType >

void StochasticTools::Calculator< InType, 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 307 of file Calculators.h.

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

Member Data Documentation

_count

template<typename InType , typename OutType >

dof_id_type StochasticTools::Mean< InType, OutType >::_count

protectedinherited

Definition at line 148 of file Calculators.h.

_sum

template<typename InType , typename OutType >

OutType StochasticTools::Mean< InType, OutType >::_sum

protectedinherited

Definition at line 149 of file Calculators.h.

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

---

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

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