#include <MorrisReporter.h>

Inheritance diagram for MorrisReporterContext< DataType >:

Public Types
enum	AutoOperation

Public Member Functions
	MorrisReporterContext (const libMesh::ParallelObject &other, const MooseObject &producer, ReporterState< MorrisState< DataType > > &state, Sampler &sampler, const std::vector< DataType > &data)

	MorrisReporterContext (const libMesh::ParallelObject &other, const MooseObject &producer, ReporterState< MorrisState< DataType > > &state, Sampler &sampler, const std::vector< DataType > &data, 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< T > &	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
void	broadcast ()

virtual void	storeInfo (nlohmann::json &json) const override

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< T > &	_state

const MooseObject &	_producer

ReporterProducerEnum	_producer_enum

const Parallel::Communicator &	_communicator

Private Member Functions
std::vector< DataType >	computeElementaryEffects (const RealEigenMatrix &x, const std::vector< DataType > &y) const
	Function for computing elementary effects for a single set of trajectories This is meant to be specialized for different data types.

std::vector< Real >	computeElementaryEffects (const RealEigenMatrix &x, const std::vector< Real > &y) const

std::vector< std::vector< Real > >	computeElementaryEffects (const RealEigenMatrix &x, const std::vector< std::vector< Real > > &y) const

Private Attributes
Sampler &	_sampler
	Morris sampler (don't need any specific functions, but should be this type)

const std::vector< DataType > &	_data
	Data used for the statistic calculation.

std::unique_ptr< StochasticTools::Calculator< std::vector< DataType >, DataType > >	_mu_calc
	Storage for the Calculator object for the desired stat, this is created in constructor.

std::unique_ptr< StochasticTools::Calculator< std::vector< DataType >, DataType > >	_mustar_calc

std::unique_ptr< StochasticTools::Calculator< std::vector< DataType >, DataType > >	_sig_calc

std::unique_ptr< StochasticTools::BootstrapCalculator< std::vector< DataType >, DataType > >	_ci_mu_calc
	Storage for the BootstrapCalculator for the desired confidence interval calculations (optional)

std::unique_ptr< StochasticTools::BootstrapCalculator< std::vector< DataType >, DataType > >	_ci_mustar_calc

std::unique_ptr< StochasticTools::BootstrapCalculator< std::vector< DataType >, DataType > >	_ci_sig_calc

Detailed Description

template<typename DataType>
class MorrisReporterContext< DataType >

Definition at line 57 of file MorrisReporter.h.

Constructor & Destructor Documentation

◆ MorrisReporterContext() [1/2]

template<typename DataType >

MorrisReporterContext< DataType >::MorrisReporterContext	(	const libMesh::ParallelObject &	other,
		const MooseObject &	producer,
		ReporterState< MorrisState< DataType > > &	state,
		Sampler &	sampler,
		const std::vector< DataType > &	data
	)

Definition at line 147 of file MorrisReporter.C.

  : ReporterGeneralContext<MorrisState<DataType>>(other, producer, state),
    _sampler(sampler),
    _data(data)
{
  MultiMooseEnum items("mean meanabs stddev", "mean meanabs stddev", true);
  _mu_calc = StochasticTools::makeCalculator<std::vector<DataType>, DataType>(items[0], other);
  _mustar_calc = StochasticTools::makeCalculator<std::vector<DataType>, DataType>(items[1], other);
  _sig_calc = StochasticTools::makeCalculator<std::vector<DataType>, DataType>(items[2], other);
 
  // Initialize state
  auto & mu = this->_state.value()["mu"].first;
  mu.resize(_sampler.getNumberOfCols());
  auto & mu_star = this->_state.value()["mu_star"].first;
  mu_star.resize(_sampler.getNumberOfCols());
  auto & sig = this->_state.value()["sigma"].first;
  sig.resize(_sampler.getNumberOfCols());
}

◆ MorrisReporterContext() [2/2]

template<typename DataType >

MorrisReporterContext< DataType >::MorrisReporterContext	(	const libMesh::ParallelObject &	other,
		const MooseObject &	producer,
		ReporterState< MorrisState< DataType > > &	state,
		Sampler &	sampler,
		const std::vector< DataType > &	data,
		const MooseEnum &	ci_method,
		const std::vector< Real > &	ci_levels,
		unsigned int	ci_replicates,
		unsigned int	ci_seed
	)

Definition at line 171 of file MorrisReporter.C.

  : MorrisReporterContext<DataType>(other, producer, state, sampler, data)
{
  _ci_mu_calc = StochasticTools::makeBootstrapCalculator<std::vector<DataType>, DataType>(
      ci_method, other, ci_levels, ci_replicates, ci_seed, *_mu_calc);
  _ci_mustar_calc = StochasticTools::makeBootstrapCalculator<std::vector<DataType>, DataType>(
      ci_method, other, ci_levels, ci_replicates, ci_seed, *_mustar_calc);
  _ci_sig_calc = StochasticTools::makeBootstrapCalculator<std::vector<DataType>, DataType>(
      ci_method, other, ci_levels, ci_replicates, ci_seed, *_sig_calc);
 
  // Initialize state
  auto & mu = this->_state.value()["mu"].second;
  mu.resize(_sampler.getNumberOfCols());
  auto & mu_star = this->_state.value()["mu_star"].second;
  mu_star.resize(_sampler.getNumberOfCols());
  auto & sig = this->_state.value()["sigma"].second;
  sig.resize(_sampler.getNumberOfCols());
}

Member Function Documentation

◆ computeElementaryEffects() [1/3]

template<typename DataType >

std::vector< DataType > MorrisReporterContext< DataType >::computeElementaryEffects	(	const RealEigenMatrix &	x,
		const std::vector< DataType > &	y
	)		const

private

Function for computing elementary effects for a single set of trajectories This is meant to be specialized for different data types.

◆ computeElementaryEffects() [2/3]

std::vector< Real > MorrisReporterContext< Real >::computeElementaryEffects	(	const RealEigenMatrix &	x,
		const std::vector< Real > &	y
	)		const

private

Definition at line 263 of file MorrisReporter.C.

{
  const auto k = y.size() - 1;
  const RealEigenMatrix dx = x.bottomRows(k) - x.topRows(k);
  RealEigenVector dy(k);
  for (unsigned int j = 0; j < k; ++j)
    dy(j) = y[j + 1] - y[j];
 
  const RealEigenVector u = dx.fullPivLu().solve(dy);
  return std::vector<Real>(u.data(), u.data() + u.size());
}

◆ computeElementaryEffects() [3/3]

std::vector< std::vector< Real > > MorrisReporterContext< std::vector< Real > >::computeElementaryEffects	(	const RealEigenMatrix &	x,
		const std::vector< std::vector< Real > > &	y
	)		const

private

Definition at line 278 of file MorrisReporter.C.

{
  const auto k = y.size() - 1;
  const RealEigenMatrix dx = x.bottomRows(k) - x.topRows(k);
  const auto solver = dx.fullPivLu();
  RealEigenVector dy(k);
  std::vector<std::vector<Real>> ee(k, std::vector<Real>(y[0].size()));
  for (unsigned int i = 0; i < y[0].size(); ++i)
  {
    for (unsigned int j = 0; j < k; ++j)
      dy(j) = y[j + 1][i] - y[j][i];
    const RealEigenVector u = solver.solve(dy);
    for (unsigned int j = 0; j < k; ++j)
      ee[j][i] = u(j);
  }
  return ee;
}

◆ finalize()

template<typename DataType >

void MorrisReporterContext< DataType >::finalize ( )

overridevirtual

Reimplemented from ReporterGeneralContext< MorrisState< DataType > >.

Definition at line 200 of file MorrisReporter.C.

{
  dof_id_type offset;
  if (_data.size() == _sampler.getNumberOfRows())
    offset = _sampler.getLocalRowBegin();
  else if (_data.size() == _sampler.getNumberOfLocalRows())
    offset = 0;
  else
    mooseError("Data size inconsistency. Expected data vector to have ",
               _sampler.getNumberOfLocalRows(),
               " (local) or ",
               _sampler.getNumberOfRows(),
               " (global) elements, but actually has ",
               _data.size(),
               " elements. Are you using the same sampler?");
 
  const dof_id_type nc = _sampler.getNumberOfCols(); // convenience
  if (_sampler.getNumberOfLocalRows() % (nc + 1) > 0)
    mooseError(
        "Sampler does not have an appropriate number of rows. Are you using a Morris sampler?");
 
  std::vector<std::vector<DataType>> elem_effects(
      nc, std::vector<DataType>(_sampler.getNumberOfLocalRows() / (nc + 1)));
  RealEigenMatrix x(nc + 1, nc);
  std::vector<DataType> y(nc + 1);
 
  for (dof_id_type p = 0; p < _sampler.getNumberOfLocalRows(); ++p)
  {
    dof_id_type traj = p / (nc + 1);
    dof_id_type tind = p % (nc + 1);
    const std::vector<Real> row = _sampler.getNextLocalRow();
    for (unsigned int k = 0; k < nc; ++k)
      x(tind, k) = row[k];
    y[tind] = _data[p + offset];
 
    if (tind == nc)
    {
      const std::vector<DataType> ee = computeElementaryEffects(x, y);
      for (unsigned int k = 0; k < nc; ++k)
        elem_effects[k][traj] = ee[k];
    }
  }
 
  auto & mu = this->_state.value()["mu"];
  auto & mustar = this->_state.value()["mu_star"];
  auto & sig = this->_state.value()["sigma"];
  for (unsigned int k = 0; k < nc; ++k)
  {
    mu.first[k] = _mu_calc->compute(elem_effects[k], true);
    mustar.first[k] = _mustar_calc->compute(elem_effects[k], true);
    sig.first[k] = _sig_calc->compute(elem_effects[k], true);
 
    if (_ci_mu_calc)
      mu.second[k] = _ci_mu_calc->compute(elem_effects[k], true);
    if (_ci_mustar_calc)
      mustar.second[k] = _ci_mustar_calc->compute(elem_effects[k], true);
    if (_ci_sig_calc)
      sig.second[k] = _ci_sig_calc->compute(elem_effects[k], true);
  }
}

◆ type()

template<typename DataType >

virtual std::string MorrisReporterContext< DataType >::type ( ) const

inlineoverridevirtual

Reimplemented from ReporterGeneralContext< MorrisState< DataType > >.

Definition at line 77 of file MorrisReporter.h.

  {
    return "MorrisSensitivity<" + MooseUtils::prettyCppType<DataType>() + ">";
  }

Member Data Documentation

◆ _ci_mu_calc

template<typename DataType >

std::unique_ptr<StochasticTools::BootstrapCalculator<std::vector<DataType>, DataType> > MorrisReporterContext< DataType >::_ci_mu_calc

private

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

Definition at line 103 of file MorrisReporter.h.

Referenced by MorrisReporterContext< DataType >::MorrisReporterContext().

◆ _ci_mustar_calc

template<typename DataType >

std::unique_ptr<StochasticTools::BootstrapCalculator<std::vector<DataType>, DataType> > MorrisReporterContext< DataType >::_ci_mustar_calc

private

Definition at line 105 of file MorrisReporter.h.

Referenced by MorrisReporterContext< DataType >::MorrisReporterContext().

◆ _ci_sig_calc

template<typename DataType >

std::unique_ptr<StochasticTools::BootstrapCalculator<std::vector<DataType>, DataType> > MorrisReporterContext< DataType >::_ci_sig_calc

private

Definition at line 107 of file MorrisReporter.h.

Referenced by MorrisReporterContext< DataType >::MorrisReporterContext().

◆ _data

template<typename DataType >

const std::vector<DataType>& MorrisReporterContext< DataType >::_data

private

Data used for the statistic calculation.

Definition at line 94 of file MorrisReporter.h.

◆ _mu_calc

template<typename DataType >

std::unique_ptr<StochasticTools::Calculator<std::vector<DataType>, DataType> > MorrisReporterContext< DataType >::_mu_calc

private

Storage for the Calculator object for the desired stat, this is created in constructor.

Definition at line 97 of file MorrisReporter.h.

Referenced by MorrisReporterContext< DataType >::MorrisReporterContext(), and MorrisReporterContext< DataType >::MorrisReporterContext().

◆ _mustar_calc

template<typename DataType >

std::unique_ptr<StochasticTools::Calculator<std::vector<DataType>, DataType> > MorrisReporterContext< DataType >::_mustar_calc

private

Definition at line 98 of file MorrisReporter.h.

Referenced by MorrisReporterContext< DataType >::MorrisReporterContext(), and MorrisReporterContext< DataType >::MorrisReporterContext().

◆ _sampler

template<typename DataType >

Sampler& MorrisReporterContext< DataType >::_sampler

private

Morris sampler (don't need any specific functions, but should be this type)

Definition at line 91 of file MorrisReporter.h.

Referenced by MorrisReporterContext< DataType >::MorrisReporterContext(), and MorrisReporterContext< DataType >::MorrisReporterContext().

◆ _sig_calc

template<typename DataType >

std::unique_ptr<StochasticTools::Calculator<std::vector<DataType>, DataType> > MorrisReporterContext< DataType >::_sig_calc

private

Definition at line 99 of file MorrisReporter.h.

Referenced by MorrisReporterContext< DataType >::MorrisReporterContext(), and MorrisReporterContext< DataType >::MorrisReporterContext().

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

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

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MorrisReporterContext() [1/2]

◆ MorrisReporterContext() [2/2]

Member Function Documentation

◆ computeElementaryEffects() [1/3]

◆ computeElementaryEffects() [2/3]

◆ computeElementaryEffects() [3/3]

◆ finalize()

◆ type()

Member Data Documentation

◆ _ci_mu_calc

◆ _ci_mustar_calc

◆ _ci_sig_calc

◆ _data

◆ _mu_calc

◆ _mustar_calc

◆ _sampler

◆ _sig_calc