SamplerData Class Reference

A tool for output Sampler data. More...

#include <SamplerData.h>

Inheritance diagram for SamplerData:

Public Member Functions
	SamplerData (const InputParameters &parameters)
virtual void	initialize () override
virtual void	finalize () override
virtual void	execute () override
virtual void	threadJoin (const UserObject &uo) override

Static Public Member Functions
static InputParameters	validParams ()

Protected Attributes
std::vector< VectorPostprocessorValue * >	_sample_vectors
	Storage for declared vectors, one for each column. More...
Sampler &	_sampler
	The sampler to extract data. More...
const MooseEnum &	_sampler_method
	The method of data retrival from the Sample. More...

Detailed Description

A tool for output Sampler data.

Definition at line 24 of file SamplerData.h.

Constructor & Destructor Documentation

SamplerData()

SamplerData::SamplerData

(

const InputParameters &

parameters

)

Definition at line 44 of file SamplerData.C.

  : GeneralVectorPostprocessor(parameters),
    SamplerInterface(this),
    _sampler(getSampler("sampler")),
    _sampler_method(getParam<MooseEnum>("sampler_method"))
{
  for (dof_id_type j = 0; j < _sampler.getNumberOfCols(); ++j)
    _sample_vectors.push_back(
        &declareVector(getParam<SamplerName>("sampler") + "_" + std::to_string(j)));
}

Member Function Documentation

execute()

void SamplerData::execute ( )

overridevirtual

Definition at line 65 of file SamplerData.C.

{
  if (_sampler_method == "get_global_samples")
  {
    DenseMatrix<Real> data = _sampler.getGlobalSamples();
    for (unsigned int j = 0; j < data.n(); ++j)
      for (unsigned int i = 0; i < data.m(); ++i)
        (*_sample_vectors[j])[i] = data(i, j);
  }
 
  else if (_sampler_method == "get_local_samples")
  {
    DenseMatrix<Real> data = _sampler.getLocalSamples();
    for (unsigned int j = 0; j < data.n(); ++j)
      for (unsigned int i = 0; i < data.m(); ++i)
        (*_sample_vectors[j])[i] = data(i, j);
  }
 
  else if (_sampler_method == "get_next_local_row")
  {
    for (dof_id_type i = _sampler.getLocalRowBegin(); i < _sampler.getLocalRowEnd(); ++i)
    {
      std::vector<Real> data = _sampler.getNextLocalRow();
      for (std::size_t j = 0; j < data.size(); ++j)
        (*_sample_vectors[j])[i - _sampler.getLocalRowBegin()] = data[j];
    }
  }
}

finalize()

void SamplerData::finalize ( )

overridevirtual

Definition at line 95 of file SamplerData.C.

{
  if (_sampler_method != "get_global_samples")
    for (auto & ppv_ptr : _sample_vectors)
      _communicator.gather(0, *ppv_ptr);
}

initialize()

void SamplerData::initialize ( )

overridevirtual

Definition at line 56 of file SamplerData.C.

{
  dof_id_type n = (_sampler_method == "get_global_samples") ? _sampler.getNumberOfRows()
                                                            : _sampler.getNumberOfLocalRows();
  for (auto & ppv_ptr : _sample_vectors)
    ppv_ptr->resize(n, 0);
}

threadJoin()

void SamplerData::threadJoin ( const UserObject &  uo )

overridevirtual

TODO: Use this when the Sampler objects become threaded

Definition at line 103 of file SamplerData.C.

{
  /*
  if (_use_local_samples)
  {
    const SamplerData & obj = static_cast<const SamplerData &>(uo);
    for (std::size_t i = 0; i < _sample_vectors.size(); ++i)
      (*_sample_vectors[i]).insert(_sample_vectors[i]->end(), obj._sample_vectors[i]->begin(),
                                   obj._sample_vectors[i]->end());
  }
  */
}

validParams()

InputParameters SamplerData::validParams ( )

static

Definition at line 21 of file SamplerData.C.

{
  InputParameters params = GeneralVectorPostprocessor::validParams();
  params.addClassDescription(
      "Tool for extracting Sampler object data and storing in VectorPostprocessor vectors.");
  params += SamplerInterface::validParams();
  params.addRequiredParam<SamplerName>("sampler",
                                       "The sample from which to extract distribution data.");
 
  // The execute method computes the complete vectors on all processes, so broadcasting the data
  // is not required.
  // params.set<bool>("_is_broadcast") = false;
 
  // Control for
  MooseEnum method("get_global_samples get_local_samples get_next_local_row", "get_next_local_row");
  params.addParam<MooseEnum>(
      "sampler_method",
      method,
      "Control the method of data retrival from the Sampler object; this is mainly for testing.");
 
  return params;
}

Member Data Documentation

_sample_vectors

std::vector<VectorPostprocessorValue *> SamplerData::_sample_vectors

protected

Storage for declared vectors, one for each column.

Definition at line 37 of file SamplerData.h.

Referenced by execute(), finalize(), initialize(), and SamplerData().

_sampler

Sampler& SamplerData::_sampler

protected

The sampler to extract data.

Definition at line 40 of file SamplerData.h.

Referenced by execute(), initialize(), and SamplerData().

_sampler_method

const MooseEnum& SamplerData::_sampler_method

protected

The method of data retrival from the Sample.

Definition at line 43 of file SamplerData.h.

Referenced by execute(), finalize(), and initialize().

---

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

• stochastic_tools/include/vectorpostprocessors/SamplerData.h
• stochastic_tools/src/vectorpostprocessors/SamplerData.C