PCSobolContext< OutType > Class Template Reference

PCSobolContext is almost identical to SobolReporterContext with InType == Outype. More...

#include <PolynomialChaosReporter.h>

Inheritance diagram for PCSobolContext< OutType >:

Public Types
enum	AutoOperation

Public Member Functions
	PCSobolContext (const libMesh::ParallelObject &other, const MooseObject &producer, ReporterState< std::pair< std::vector< OutType >, std::vector< std::vector< OutType >>>> &state, const PolynomialChaos &pc)
virtual void	finalize () override
virtual std::string	type () 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< std::vector< OutType >, std::vector< std::vector< OutType > > > > &	state () const
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
virtual void	store (nlohmann::json &json) const override
void	broadcast ()
virtual void	storeInfo (nlohmann::json &json) const override
virtual void	copyValuesBack () override
void	requiresConsumerModes (const ReporterStateBase &state, const std::set< ReporterMode > &modes) const

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

Private Attributes
const PolynomialChaos &	_pc
	Polynomial chaos surrogate object. More...

Detailed Description

template<typename OutType>
class PCSobolContext< OutType >

PCSobolContext is almost identical to SobolReporterContext with InType == Outype.

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

Definition at line 82 of file PolynomialChaosReporter.h.

Constructor & Destructor Documentation

PCSobolContext()

template<typename OutType >

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

Definition at line 205 of file PolynomialChaosReporter.C.

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

Member Function Documentation

finalize()

template<typename OutType >

void PCSobolContext< OutType >::finalize ( )

overridevirtual

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

Definition at line 218 of file PolynomialChaosReporter.C.

{
  const unsigned int nparam = _pc.getNumberOfParameters();
  std::vector<OutType> & val = this->_state.value().first;
  val.clear();

  // Compute variance
  auto var = _pc.computeStandardDeviation();
  var *= var;

  // First order
  for (const auto & i : make_range(nparam))
    val.push_back(_pc.computeSobolIndex({i}) / var);
  // Total
  for (const auto & i : make_range(nparam))
    val.push_back(_pc.computeSobolTotal(i) / var);
  // Second order
  for (const auto & i : make_range(nparam))
    for (const auto & j : make_range(i + 1, nparam))
      val.push_back(_pc.computeSobolIndex({i, j}) / var);
}

store()

template<typename OutType >

void PCSobolContext< OutType >::store ( nlohmann::json &  json ) const

overrideprotectedvirtual

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

Definition at line 242 of file PolynomialChaosReporter.C.

{
  SobolReporterContext<std::vector<OutType>, OutType>::storeSobol(
      json, this->_state.value(), _pc.getNumberOfParameters());
}

type()

template<typename OutType >

virtual std::string PCSobolContext< OutType >::type ( ) const

inlineoverridevirtual

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

Definition at line 93 of file PolynomialChaosReporter.h.

  {
    return "SobolIndices<" + MooseUtils::prettyCppType<OutType>() + ">";
  }

Member Data Documentation

_pc

template<typename OutType >

const PolynomialChaos& PCSobolContext< OutType >::_pc

private

Polynomial chaos surrogate object.

Definition at line 103 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