PCStatisticsContext< OutType > Class Template Reference

PCStatisticsContext is almost identical to ReporterStatisticsContext with InType == Outype. More...

#include <PolynomialChaosReporter.h>

Inheritance diagram for PCStatisticsContext< OutType >:

Public Types
enum	AutoOperation

Public Member Functions
	PCStatisticsContext (const libMesh::ParallelObject &other, const MooseObject &producer, ReporterState< std::pair< OutType, std::vector< OutType >>> &state, const PolynomialChaos &pc, const MooseEnumItem &stat)
virtual void	finalize () 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
virtual std::string	contextType () const override
const ReporterName &	name () const override final
const ReporterState< std::pair< OutType, std::vector< OutType > > > &	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 void	copyValuesBack () override
virtual bool	restoreState () override
void	requiresConsumerModes (const ReporterStateBase &state, const std::set< ReporterMode > &modes) const

Protected Attributes
ReporterState< std::pair< OutType, std::vector< OutType > > > &	_state
const MooseObject &	_producer
ReporterProducerEnum	_producer_enum
const Parallel::Communicator &	_communicator

Private Attributes
const PolynomialChaos &	_pc
	Polynomial chaos surrogate object. More...
const MooseEnumItem	_stat
	The stat to compute. More...

Detailed Description

template<typename OutType>
class PCStatisticsContext< OutType >

PCStatisticsContext is almost identical to ReporterStatisticsContext with InType == Outype.

Unfortunately, we cannot derive from ReporterStatisticsContext since that class relies on the construction of a Calculator object, something that is unnecessary for calculating statistics with polynomial chaos.

Definition at line 56 of file PolynomialChaosReporter.h.

Constructor & Destructor Documentation

PCStatisticsContext()

template<typename OutType >

PCStatisticsContext< OutType >::PCStatisticsContext	(	const libMesh::ParallelObject &	other,
		const MooseObject &	producer,
		ReporterState< std::pair< OutType, std::vector< OutType >>> &	state,
		const PolynomialChaos &	pc,
		const MooseEnumItem &	stat
	)

Definition at line 156 of file PolynomialChaosReporter.C.

  : ReporterGeneralContext<std::pair<OutType, std::vector<OutType>>>(other, producer, state),
    _pc(pc),
    _stat(stat)
{
}

Member Function Documentation

finalize()

template<typename OutType >

void PCStatisticsContext< OutType >::finalize ( )

overridevirtual

Reimplemented from ReporterGeneralContext< std::pair< OutType, std::vector< OutType > > >.

Definition at line 170 of file PolynomialChaosReporter.C.

{
  // Compute standard deviation
  OutType sig = OutType();
  if (_stat == "stddev" || _stat == "skewness" || _stat == "kurtosis")
    sig = _pc.computeStandardDeviation();

  OutType & val = this->_state.value().first;
  val = OutType();
  // Mean
  if (_stat == "mean" && this->processor_id() == 0)
    val = _pc.computeMean();
  // Standard Deviation
  else if (_stat == "stddev" && this->processor_id() == 0)
    val = sig;
  // Skewness
  else if (_stat == "skewness")
    val = _pc.powerExpectation(3) / (sig * sig * sig);
  // Kurtosis
  else if (_stat == "kurtosis")
    val = _pc.powerExpectation(4) / (sig * sig * sig * sig);
  this->_communicator.sum(val);

  ReporterGeneralContext<std::pair<OutType, std::vector<OutType>>>::finalize();
}

storeInfo()

template<typename OutType >

void PCStatisticsContext< OutType >::storeInfo ( nlohmann::json &  json ) const

overridevirtual

Reimplemented from ReporterGeneralContext< std::pair< OutType, std::vector< OutType > > >.

Definition at line 198 of file PolynomialChaosReporter.C.

{
  ReporterGeneralContext<std::pair<OutType, std::vector<OutType>>>::storeInfo(json);
  json["stat"] = _stat.name();
}

Member Data Documentation

_pc

template<typename OutType >

const PolynomialChaos& PCStatisticsContext< OutType >::_pc

private

Polynomial chaos surrogate object.

Definition at line 70 of file PolynomialChaosReporter.h.

_stat

template<typename OutType >

const MooseEnumItem PCStatisticsContext< OutType >::_stat

private

The stat to compute.

Definition at line 72 of file PolynomialChaosReporter.h.

---

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

• stochastic_tools/include/reporters/PolynomialChaosReporter.h
• stochastic_tools/src/reporters/PolynomialChaosReporter.C