Similar to CartesianProduct, this object creates a sampling scheme that produces a grid of samples, where each column has its own 1D grid. More...

#include <Cartesian1DSampler.h>

Inheritance diagram for Cartesian1DSampler:

[legend]

Public Types
enum	SampleMode

typedef DataFileName	DataFileParameterType

Public Member Functions
	Cartesian1DSampler (const InputParameters &parameters)

std::vector< Real >	getSampleRow (dof_id_type row_index) const

Real	getSample (dof_id_type row_index, dof_id_type col_index) const

dof_id_type	getNumberOfRows () const

dof_id_type	getNumberOfCols () const

dof_id_type	getNumberOfLocalRows () const

const LocalRankConfig &	getRankConfig (bool batch_mode) const

virtual bool	isAdaptiveSamplingCompleted () const

virtual bool	enabled () const

std::shared_ptr< MooseObject >	getSharedPtr ()

std::shared_ptr< const MooseObject >	getSharedPtr () const

bool	isKokkosObject () const

MooseApp &	getMooseApp () const

const std::string &	type () const

const std::string &	name () const

std::string	typeAndName () const

MooseObjectParameterName	uniqueParameterName (const std::string &parameter_name) const

MooseObjectName	uniqueName () const

const InputParameters &	parameters () const

const hit::Node *	getHitNode () const

bool	hasBase () const

const std::string &	getBase () const

const T &	getParam (const std::string &name) const

std::vector< std::pair< T1, T2 > >	getParam (const std::string &param1, const std::string &param2) const

const T *	queryParam (const std::string &name) const

const T &	getRenamedParam (const std::string &old_name, const std::string &new_name) const

T	getCheckedPointerParam (const std::string &name, const std::string &error_string="") const

bool	isParamValid (const std::string &name) const

bool	isParamSetByUser (const std::string &name) const

void	connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const

void	paramError (const std::string &param, Args... args) const

void	paramWarning (const std::string &param, Args... args) const

void	paramWarning (const std::string &param, Args... args) const

void	paramInfo (const std::string &param, Args... args) const

std::string	messagePrefix (const bool hit_prefix=true) const

std::string	errorPrefix (const std::string &) const

void	mooseError (Args &&... args) const

void	mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const

void	mooseErrorNonPrefixed (Args &&... args) const

void	mooseWarning (Args &&... args) const

void	mooseWarning (Args &&... args) const

void	mooseWarningNonPrefixed (Args &&... args) const

void	mooseWarningNonPrefixed (Args &&... args) const

void	mooseDeprecated (Args &&... args) const

void	mooseDeprecated (Args &&... args) const

void	mooseDeprecatedNoTrace (Args &&... args) const

void	mooseInfo (Args &&... args) const

void	callMooseError (std::string msg, const bool with_prefix, const hit::Node *node=nullptr, const bool show_trace=true) const

std::string	getDataFileName (const std::string &param) const

std::string	getDataFileNameByName (const std::string &relative_path) const

std::string	getDataFilePath (const std::string &relative_path) const

virtual void	initialSetup ()

virtual void	timestepSetup ()

virtual void	jacobianSetup ()

virtual void	residualSetup ()

virtual void	subdomainSetup ()

virtual void	customSetup (const ExecFlagType &)

const ExecFlagEnum &	getExecuteOnEnum () const

PerfGraph &	perfGraph ()

T &	getSampler (const std::string &name)

Sampler &	getSampler (const std::string &name)

T &	getSamplerByName (const SamplerName &name)

Sampler &	getSamplerByName (const SamplerName &name)

const VectorPostprocessorValue &	getVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const

const VectorPostprocessorValue &	getVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const

const VectorPostprocessorValue &	getVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const

const VectorPostprocessorValue &	getVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const

const VectorPostprocessorValue &	getVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const

const VectorPostprocessorValue &	getVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const

const VectorPostprocessorValue &	getVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name) const

const VectorPostprocessorValue &	getVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const

const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const

const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const

const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const

const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name) const

bool	hasVectorPostprocessor (const std::string &param_name, const std::string &vector_name) const

bool	hasVectorPostprocessor (const std::string &param_name) const

bool	hasVectorPostprocessorByName (const VectorPostprocessorName &name, const std::string &vector_name) const

bool	hasVectorPostprocessorByName (const VectorPostprocessorName &name) const

const VectorPostprocessorName &	getVectorPostprocessorName (const std::string &param_name) const

DenseMatrix< Real >	getGlobalSamples ()

DenseMatrix< Real >	getGlobalSamples ()

DenseMatrix< Real >	getLocalSamples ()

DenseMatrix< Real >	getLocalSamples ()

dof_id_type	getLocalRowBegin () const

dof_id_type	getLocalRowBegin () const

dof_id_type	getLocalRowEnd () const

dof_id_type	getLocalRowEnd () const

const Distribution &	getDistribution (const std::string &name) const

const T &	getDistribution (const std::string &name) const

const Distribution &	getDistribution (const std::string &name) const

const T &	getDistribution (const std::string &name) const

const Distribution &	getDistributionByName (const DistributionName &name) const

const T &	getDistributionByName (const std::string &name) const

const Distribution &	getDistributionByName (const DistributionName &name) const

const T &	getDistributionByName (const std::string &name) const

bool	isVectorPostprocessorDistributed (const std::string &param_name) const

bool	isVectorPostprocessorDistributed (const std::string &param_name) const

bool	isVectorPostprocessorDistributedByName (const VectorPostprocessorName &name) const

bool	isVectorPostprocessorDistributedByName (const VectorPostprocessorName &name) const

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

Static Public Member Functions
static InputParameters	validParams ()

static void	callMooseError (MooseApp const app, const InputParameters &params, std::string msg, const bool with_prefix, const hit::Node node, const bool show_trace=true)

Public Attributes
	usingCombinedWarningSolutionWarnings

const ConsoleStream	_console

Static Public Attributes
static const std::string	type_param

static const std::string	name_param

static const std::string	unique_name_param

static const std::string	app_param

static const std::string	moose_base_param

static const std::string	kokkos_object_param

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

void	setNumberOfRandomSeeds (std::size_t number)

Real	getRand (std::size_t n, unsigned int index=0) const

unsigned int	getRandl (std::size_t n, unsigned int lower, unsigned int upper, unsigned int index=0) const

virtual void	computeSampleRow (dof_id_type i, std::vector< Real > &data) const

virtual void	advanceGenerators (const dof_id_type count)

virtual void	advanceGenerator (const unsigned int seed_index, const dof_id_type count)

void	setAutoAdvanceGenerators (const bool state)

virtual void	executeSetUp ()

virtual void	executeTearDown ()

virtual LocalRankConfig	constructRankConfig (bool batch_mode) const

void	flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const

InvalidSolutionID	registerInvalidSolutionInternal (const std::string &message, const bool warning) const

PerfID	registerTimedSection (const std::string &section_name, const unsigned int level) const

PerfID	registerTimedSection (const std::string &section_name, const unsigned int level, const std::string &live_message, const bool print_dots=true) const

std::string	timedSectionName (const std::string &section_name) const

virtual void	addVectorPostprocessorDependencyHelper (const VectorPostprocessorName &) const

const ReporterContextBase &	getReporterContextBaseByName (const ReporterName &reporter_name) const

const ReporterName &	getReporterName (const std::string &param_name) const

virtual void	addReporterDependencyHelper (const ReporterName &)

T &	declareRestartableData (const std::string &data_name, Args &&... args)

ManagedValue< T >	declareManagedRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)

const T &	getRestartableData (const std::string &data_name) const

T &	declareRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)

T &	declareRecoverableData (const std::string &data_name, Args &&... args)

T &	declareRestartableDataWithObjectName (const std::string &data_name, const std::string &object_name, Args &&... args)

T &	declareRestartableDataWithObjectNameWithContext (const std::string &data_name, const std::string &object_name, void *context, Args &&... args)

std::string	restartableName (const std::string &data_name) const

void	setNumberOfRows (dof_id_type n_rows)

void	setNumberOfRows (dof_id_type n_rows)

void	setNumberOfCols (dof_id_type n_cols)

void	setNumberOfCols (dof_id_type n_cols)

virtual void	computeSampleMatrix (DenseMatrix< Real > &matrix)

virtual void	computeSampleMatrix (DenseMatrix< Real > &matrix)

virtual void	computeLocalSampleMatrix (DenseMatrix< Real > &matrix)

virtual void	computeLocalSampleMatrix (DenseMatrix< Real > &matrix)

const T &	getReporterValue (const std::string &param_name, const std::size_t time_index=0)

const T &	getReporterValue (const std::string &param_name, ReporterMode mode, const std::size_t time_index=0)

const T &	getReporterValue (const std::string &param_name, const std::size_t time_index=0)

const T &	getReporterValue (const std::string &param_name, ReporterMode mode, const std::size_t time_index=0)

const T &	getReporterValueByName (const ReporterName &reporter_name, const std::size_t time_index=0)

const T &	getReporterValueByName (const ReporterName &reporter_name, ReporterMode mode, const std::size_t time_index=0)

const T &	getReporterValueByName (const ReporterName &reporter_name, const std::size_t time_index=0)

const T &	getReporterValueByName (const ReporterName &reporter_name, ReporterMode mode, const std::size_t time_index=0)

bool	hasReporterValue (const std::string &param_name) const

bool	hasReporterValue (const std::string &param_name) const

bool	hasReporterValue (const std::string &param_name) const

bool	hasReporterValue (const std::string &param_name) const

bool	hasReporterValueByName (const ReporterName &reporter_name) const

bool	hasReporterValueByName (const ReporterName &reporter_name) const

bool	hasReporterValueByName (const ReporterName &reporter_name) const

bool	hasReporterValueByName (const ReporterName &reporter_name) const

Protected Attributes
const std::vector< Real > &	_nominal_values
	The values to use when not sampling from a column's grid.

std::vector< dof_id_type >	_grid_range
	The range of rows in which to apply the grid for each column.

std::vector< std::vector< Real > >	_grid_items
	The values to use when sampling from a column's grid.

const dof_id_type	_min_procs_per_row

const dof_id_type	_max_procs_per_row

const bool &	_enabled

MooseApp &	_app

Factory &	_factory

ActionFactory &	_action_factory

const std::string &	_type

const std::string &	_name

const InputParameters &	_pars

const ExecFlagEnum &	_execute_enum

const ExecFlagType &	_current_execute_flag

MooseApp &	_pg_moose_app

const std::string	_prefix

MooseApp &	_restartable_app

const std::string	_restartable_system_name

const THREAD_ID	_restartable_tid

const bool	_restartable_read_only

const Parallel::Communicator &	_communicator

Private Member Functions
void	execute ()

void	checkReinitStatus () const

void	advanceGeneratorsInternal (const dof_id_type count)

const VectorPostprocessorValue &	getVectorPostprocessorByNameHelper (const VectorPostprocessorName &name, const std::string &vector_name, bool broadcast, std::size_t t_index) const

const VectorPostprocessorContext< VectorPostprocessorValue > &	getVectorPostprocessorContextByNameHelper (const VectorPostprocessorName &name, const std::string &vector_name) const

bool	vectorPostprocessorsAdded () const

bool	reportersAdded () const

void	possiblyCheckHasReporter (const ReporterName &reporter_name, const std::string &param_name="") const

RestartableDataValue &	registerRestartableDataOnApp (std::unique_ptr< RestartableDataValue > data, THREAD_ID tid) const

void	registerRestartableNameWithFilterOnApp (const std::string &name, Moose::RESTARTABLE_FILTER filter)

RestartableData< T > &	declareRestartableDataHelper (const std::string &data_name, void *context, Args &&... args) const

void	init ()

void	init ()

void	reinit ()

void	reinit ()

void	possiblyCheckHasVectorPostprocessor (const std::string &param_name, const std::string &vector_name) const

void	possiblyCheckHasVectorPostprocessor (const std::string &param_name, const std::string &vector_name) const

void	possiblyCheckHasVectorPostprocessorByName (const VectorPostprocessorName &name, const std::string &vector_name) const

void	possiblyCheckHasVectorPostprocessorByName (const VectorPostprocessorName &name, const std::string &vector_name) const

Static Private Member Functions
static const hit::Node *	getHitNode (const InputParameters &params)

static std::string	messagePrefix (const InputParameters &params, const bool hit_prefix)

Private Attributes
std::vector< std::unique_ptr< MooseRandomStateless > > &	_generators

dof_id_type &	_n_local_rows

dof_id_type &	_local_row_begin

dof_id_type &	_local_row_end

dof_id_type &	_n_rows

dof_id_type &	_n_cols

std::size_t	_n_seeds

bool	_initialized

bool	_needs_reinit

bool &	_has_executed

const dof_id_type	_limit_get_global_samples

const dof_id_type	_limit_get_local_samples

const dof_id_type	_limit_get_row

std::pair< LocalRankConfig, LocalRankConfig > &	_rank_config

bool	_auto_advance_generators

const ParallelParamObject &	_parent

const MooseBase &	_si_moose_base

const FEProblemBase *	_si_problem

ExecFlagEnum	_empty_execute_enum

const InputParameters &	_dni_params

FEProblemBase &	_dni_feproblem

const MooseObject *const	_dni_moose_object_ptr

const InputParameters &	_si_params

FEProblemBase &	_si_feproblem

THREAD_ID	_si_tid

const bool	_broadcast_by_default

const MooseObject &	_vpi_moose_object

const FEProblemBase &	_vpi_feproblem

const THREAD_ID	_vpi_tid

const InputParameters &	_ri_params

FEProblemBase &	_ri_fe_problem_base

const ReporterData &	_ri_reporter_data

const MooseObject &	_ri_moose_object

const RestartableDataMapName	_metaname

std::string	_restartable_name

Detailed Description

Similar to CartesianProduct, this object creates a sampling scheme that produces a grid of samples, where each column has its own 1D grid.

Example: linear_space_items = '0 1 3 0 2 4' nominal_values = '1.5 2.5'

result = [0.0, 2.5] [1.0, 2.5] [2.0, 2.5] [1.5, 0.0] [1.5, 2.0] [1.5, 4.0] [1.5, 6.0]

Definition at line 30 of file Cartesian1DSampler.h.

Constructor & Destructor Documentation

◆ Cartesian1DSampler()

Cartesian1DSampler::Cartesian1DSampler ( const InputParameters & parameters )

Definition at line 27 of file Cartesian1DSampler.C.

  : Sampler(parameters), _nominal_values(getParam<std::vector<Real>>("nominal_values"))
{
  const std::vector<Real> & items = getParam<std::vector<Real>>("linear_space_items");
  if (items.size() % 3 != 0)
    paramError("linear_space_items",
               "The number of numeric items must be divisible by 3; min, max, divisions for each "
               "item are required.");
  const dof_id_type num_cols = items.size() / 3;
  if (_nominal_values.size() != num_cols)
    paramError("nominal_values",
               "The number of values specified must match the number of triplets in "
               "'linear_space_items'.");
 
  _grid_range.resize(num_cols + 1, 0);
  _grid_items.resize(num_cols);
  dof_id_type num_rows = 0;
  for (std::size_t i = 0; i < items.size(); i += 3)
  {
    if (items[i + 2] != std::floor(items[i + 2]))
      paramError("linear_space_items",
                 "The third entry for each item must be an integer; it provides the number of "
                 "entries in the resulting item vector.");
 
    if (items[i + 2] < 0)
      paramError("linear_space_items",
                 "The third entry for each item must be positive; it provides the number of "
                 "entries in the resulting item vector.");
 
    const dof_id_type col = i / 3;
    const dof_id_type ng = static_cast<dof_id_type>(items[i + 2]);
 
    num_rows += ng;
    _grid_range[col + 1] = num_rows;
    _grid_items[col].resize(ng);
    for (const auto & j : make_range(ng))
      _grid_items[col][j] = items[i] + j * items[i + 1];
  }
 
  setNumberOfRows(num_rows);
  setNumberOfCols(num_cols);
}

Member Function Documentation

◆ computeSample()

Real Cartesian1DSampler::computeSample	(	dof_id_type	row_index,
		dof_id_type	col_index
	)		const

overrideprotectedvirtual

Return the sample for the given row and column.

Implements Sampler.

Definition at line 71 of file Cartesian1DSampler.C.

{
  if (row_index >= _grid_range[col_index] && row_index < _grid_range[col_index + 1])
    return _grid_items[col_index][row_index - _grid_range[col_index]];
  else
    return _nominal_values[col_index];
}

◆ validParams()

InputParameters Cartesian1DSampler::validParams ( )

static

Definition at line 15 of file Cartesian1DSampler.C.

{
  InputParameters params = Sampler::validParams();
  params.addClassDescription("Provides complete Cartesian product for the supplied variables.");
  params.addRequiredParam<std::vector<Real>>(
      "linear_space_items",
      "A list of triplets, each item should include the min, step size, and number of steps.");
  params.addRequiredParam<std::vector<Real>>("nominal_values", "Nominal values for each column.");
  params.set<ExecFlagEnum>("execute_on") = EXEC_INITIAL;
  return params;
}

Member Data Documentation

◆ _grid_items

std::vector<std::vector<Real> > Cartesian1DSampler::_grid_items

protected

The values to use when sampling from a column's grid.

Definition at line 46 of file Cartesian1DSampler.h.

Referenced by Cartesian1DSampler(), and computeSample().

◆ _grid_range

std::vector<dof_id_type> Cartesian1DSampler::_grid_range

protected

The range of rows in which to apply the grid for each column.

Definition at line 44 of file Cartesian1DSampler.h.

Referenced by Cartesian1DSampler(), and computeSample().

◆ _nominal_values

const std::vector<Real>& Cartesian1DSampler::_nominal_values

protected

The values to use when not sampling from a column's grid.

Definition at line 42 of file Cartesian1DSampler.h.

Referenced by Cartesian1DSampler(), and computeSample().

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

stochastic_tools/include/samplers/Cartesian1DSampler.h
stochastic_tools/src/samplers/Cartesian1DSampler.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Cartesian1DSampler()

Member Function Documentation

◆ computeSample()

◆ validParams()

Member Data Documentation

◆ _grid_items

◆ _grid_range

◆ _nominal_values