#include <SobolReporter.h>

Inheritance diagram for SobolReporterContext< InType, OutType >:

Public Types
enum	AutoOperation

Public Member Functions
	SobolReporterContext (const libMesh::ParallelObject &other, const MooseObject &producer, ReporterState< SobolState< OutType >> &state, const InType &data, const ReporterProducerEnum &mode, const SobolSampler &sampler)

	SobolReporterContext (const libMesh::ParallelObject &other, const MooseObject &producer, ReporterState< SobolState< OutType >> &state, const InType &data, const ReporterProducerEnum &mode, const SobolSampler &sampler, const MooseEnum &ci_method, const std::vector< Real > &ci_levels, unsigned int ci_replicates, unsigned int ci_seed)

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< SobolState< 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

Static Public Member Functions
static void	storeSobol (nlohmann::json &json, const SobolState< OutType > &val, unsigned int nparam)

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

virtual bool	restoreState () override

void	requiresConsumerModes (const ReporterStateBase &state, const std::set< ReporterMode > &modes) const

Protected Attributes
ReporterState< SobolState< OutType > > &	_state

const MooseObject &	_producer

ReporterProducerEnum	_producer_enum

const Parallel::Communicator &	_communicator

Private Attributes
const InType &	_data
	Data used for the statistic calculation. More...

const ReporterProducerEnum &	_data_mode
	Mode in which the above data was produced. More...

const SobolSampler &	_sampler
	Sobol sampler to get info on number of matrices and whatnot. More...

StochasticTools::SobolCalculator< InType, OutType >	_calc
	Storage for the SobolCalculator object, this is created in constructor. More...

std::unique_ptr< StochasticTools::BootstrapCalculator< std::vector< InType >, std::vector< OutType > > >	_ci_calc_ptr = nullptr
	Storage for the BootstrapCalculator for the desired confidence interval calculations (optional) More...

Detailed Description

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

Definition at line 18 of file SobolReporter.h.

Constructor & Destructor Documentation

◆ SobolReporterContext() [1/2]

template<typename InType , typename OutType >

SobolReporterContext< InType, OutType >::SobolReporterContext	(	const libMesh::ParallelObject &	other,
		const MooseObject &	producer,
		ReporterState< SobolState< OutType >> &	state,
		const InType &	data,
		const ReporterProducerEnum &	mode,
		const SobolSampler &	sampler
	)

Definition at line 169 of file SobolReporter.C.

   : ReporterGeneralContext<SobolState<OutType>>(other, producer, state),
     _data(data),
     _data_mode(mode),
     _sampler(sampler),
     _calc(other, "SOBOL", _sampler.resample())
 {
 }

◆ SobolReporterContext() [2/2]

template<typename InType , typename OutType >

SobolReporterContext< InType, OutType >::SobolReporterContext	(	const libMesh::ParallelObject &	other,
		const MooseObject &	producer,
		ReporterState< SobolState< OutType >> &	state,
		const InType &	data,
		const ReporterProducerEnum &	mode,
		const SobolSampler &	sampler,
		const MooseEnum &	ci_method,
		const std::vector< Real > &	ci_levels,
		unsigned int	ci_replicates,
		unsigned int	ci_seed
	)

Definition at line 185 of file SobolReporter.C.

   : SobolReporterContext<InType, OutType>(other, producer, state, data, mode, sampler)
 {
   _ci_calc_ptr =
       StochasticTools::makeBootstrapCalculator<std::vector<InType>, std::vector<OutType>>(
           ci_method, other, ci_levels, ci_replicates, ci_seed, _calc);
 }

Member Function Documentation

◆ finalize()

template<typename InType , typename OutType >

void SobolReporterContext< InType, OutType >::finalize ( )

overridevirtual

Reimplemented from ReporterGeneralContext< SobolState< OutType > >.

Definition at line 205 of file SobolReporter.C.

 {
   auto & val = this->_state.value(); // Convenience
   val.first.clear();
   val.second.clear();
 
   const bool is_dist = _data_mode == REPORTER_MODE_DISTRIBUTED;
   if (is_dist || this->processor_id() == 0)
   {
     const std::size_t ncol =
         _sampler.resample() ? 2 * _sampler.getNumberOfCols() + 2 : _sampler.getNumberOfCols() + 2;
     const std::vector<InType> data_reshape =
         StochasticTools::reshapeVector(_data, ncol, /*row_major =*/true);
 
     val.first = _calc.compute(data_reshape, is_dist);
     if (_ci_calc_ptr)
       val.second = _ci_calc_ptr->compute(data_reshape, is_dist);
   }
 
   ReporterGeneralContext<SobolState<OutType>>::finalize();
 }

◆ store()

template<typename InType , typename OutType >

void SobolReporterContext< InType, OutType >::store ( nlohmann::json & json ) const

overrideprotectedvirtual

Reimplemented from ReporterGeneralContext< SobolState< OutType > >.

Definition at line 229 of file SobolReporter.C.

 {
   storeSobol(json, this->_state.value(), _sampler.getNumberOfCols());
 }

◆ storeSobol()

template<typename InType , typename OutType >

void SobolReporterContext< InType, OutType >::storeSobol	(	nlohmann::json &	json,
		const SobolState< OutType > &	val,
		unsigned int	nparam
	)

static

Definition at line 236 of file SobolReporter.C.

 {
   if (val.first.empty())
     return;
 
   // Convenience
   const unsigned int nlevels = val.second.size();
 
   std::pair<std::vector<OutType>, std::vector<std::vector<OutType>>> first_order;
   std::pair<std::vector<OutType>, std::vector<std::vector<OutType>>> total;
 
   first_order.first.assign(val.first.begin(), val.first.begin() + nparam);
   total.first.assign(val.first.begin() + nparam, val.first.begin() + nparam + nparam);
   if (nlevels > 0)
   {
     first_order.second.resize(nlevels);
     total.second.resize(nlevels);
     for (const auto & l : make_range(nlevels))
     {
       first_order.second[l].assign(val.second[l].begin(), val.second[l].begin() + nparam);
       total.second[l].assign(val.second[l].begin() + nparam,
                              val.second[l].begin() + nparam + nparam);
     }
   }
   json["FIRST_ORDER"] = first_order;
   json["TOTAL"] = total;
 
   if (val.first.size() > 2 * nparam)
   {
     std::pair<std::vector<std::vector<OutType>>, std::vector<std::vector<std::vector<OutType>>>>
         second_order;
 
     second_order.first.resize(nparam, std::vector<OutType>(nparam));
     for (const auto & i : make_range(nparam))
       second_order.first[i][i] = val.first[i];
     unsigned int ind = 2 * nparam;
     for (const auto & i : make_range(nparam))
       for (const auto & j : make_range(i + 1, nparam))
       {
         second_order.first[i][j] = val.first[ind++];
         second_order.first[j][i] = second_order.first[i][j];
       }
 
     if (nlevels > 0)
     {
       second_order.second.resize(nlevels, second_order.first);
 
       for (const auto & l : make_range(nlevels))
       {
         for (const auto & i : make_range(nparam))
           second_order.second[l][i][i] = val.second[l][i];
         ind = 2 * nparam;
         for (const auto & i : make_range(nparam))
           for (const auto & j : make_range(i + 1, nparam))
           {
             second_order.second[l][i][j] = val.second[l][ind++];
             second_order.second[l][j][i] = second_order.second[l][i][j];
           }
       }
     }
     json["SECOND_ORDER"] = second_order;
   }
 }

◆ type()

template<typename InType, typename OutType>

virtual std::string SobolReporterContext< InType, OutType >::type ( ) const

inlineoverridevirtual

Reimplemented from ReporterGeneralContext< SobolState< OutType > >.

Definition at line 87 of file SobolReporter.h.

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

Member Data Documentation

◆ _calc

template<typename InType, typename OutType>

StochasticTools::SobolCalculator<InType, OutType> SobolReporterContext< InType, OutType >::_calc

private

Storage for the SobolCalculator object, this is created in constructor.

Definition at line 108 of file SobolReporter.h.

Referenced by SobolReporterContext< InType, OutType >::SobolReporterContext().

◆ _ci_calc_ptr

template<typename InType, typename OutType>

std::unique_ptr<StochasticTools::BootstrapCalculator<std::vector<InType>, std::vector<OutType> > > SobolReporterContext< InType, OutType >::_ci_calc_ptr = nullptr

private

Storage for the BootstrapCalculator for the desired confidence interval calculations (optional)

Definition at line 112 of file SobolReporter.h.

Referenced by SobolReporterContext< InType, OutType >::SobolReporterContext().

◆ _data

template<typename InType, typename OutType>

const InType& SobolReporterContext< InType, OutType >::_data

private

Data used for the statistic calculation.

Definition at line 99 of file SobolReporter.h.

◆ _data_mode

template<typename InType, typename OutType>

const ReporterProducerEnum& SobolReporterContext< InType, OutType >::_data_mode

private

Mode in which the above data was produced.

Definition at line 102 of file SobolReporter.h.

◆ _sampler

template<typename InType, typename OutType>

const SobolSampler& SobolReporterContext< InType, OutType >::_sampler

private

Sobol sampler to get info on number of matrices and whatnot.

Definition at line 105 of file SobolReporter.h.

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

stochastic_tools/include/reporters/SobolReporter.h
stochastic_tools/src/reporters/SobolReporter.C

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

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

Constructor & Destructor Documentation

◆ SobolReporterContext() [1/2]

◆ SobolReporterContext() [2/2]

Member Function Documentation

◆ finalize()

◆ store()

◆ storeSobol()

◆ type()

Member Data Documentation

◆ _calc

◆ _ci_calc_ptr

◆ _data

◆ _data_mode

◆ _sampler

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