MonteCarloSampler Class Reference

A class used to perform Monte Carlo Sampling. More...

#include <MonteCarloSampler.h>

Inheritance diagram for MonteCarloSampler:

Public Member Functions
	MonteCarloSampler (const InputParameters &parameters)

Static Public Member Functions
static InputParameters	validParams ()

Protected Member Functions
virtual Real	computeSample (dof_id_type row_index, dof_id_type col_index)
	Return the sample for the given row and column. More...

Protected Attributes
std::vector< Distribution const * >	_distributions
	Storage for distribution objects to be utilized. More...
const std::vector< DistributionName > &	_distribution_names
	Distribution names. More...

Detailed Description

A class used to perform Monte Carlo Sampling.

Definition at line 21 of file MonteCarloSampler.h.

Constructor & Destructor Documentation

MonteCarloSampler()

MonteCarloSampler::MonteCarloSampler

(

const InputParameters &

parameters

)

Definition at line 30 of file MonteCarloSampler.C.

  : Sampler(parameters),
    _distribution_names(getParam<std::vector<DistributionName>>("distributions"))
{
  for (const DistributionName & name : _distribution_names)
    _distributions.push_back(&getDistributionByName(name));
 
  setNumberOfRows(getParam<dof_id_type>("num_rows"));
  setNumberOfCols(_distributions.size());
}

Member Function Documentation

computeSample()

Real MonteCarloSampler::computeSample ( dof_id_type  row_index, dof_id_type  col_index  )

protectedvirtual

Return the sample for the given row and column.

Definition at line 42 of file MonteCarloSampler.C.

{
  return _distributions[col_index]->quantile(getRand());
}

validParams()

InputParameters MonteCarloSampler::validParams ( )

static

Definition at line 18 of file MonteCarloSampler.C.

{
  InputParameters params = Sampler::validParams();
  params.addClassDescription("Monte Carlo Sampler.");
  params.addRequiredParam<dof_id_type>("num_rows", "The number of rows per matrix to generate.");
  params.addRequiredParam<std::vector<DistributionName>>(
      "distributions",
      "The distribution names to be sampled, the number of distributions provided defines the "
      "number of columns per matrix.");
  return params;
}

Member Data Documentation

_distribution_names

const std::vector<DistributionName>& MonteCarloSampler::_distribution_names

protected

Distribution names.

Definition at line 36 of file MonteCarloSampler.h.

Referenced by MonteCarloSampler().

_distributions

std::vector<Distribution const *> MonteCarloSampler::_distributions

protected

Storage for distribution objects to be utilized.

Definition at line 33 of file MonteCarloSampler.h.

Referenced by computeSample(), and MonteCarloSampler().

---

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

• stochastic_tools/include/samplers/MonteCarloSampler.h
• stochastic_tools/src/samplers/MonteCarloSampler.C