https://mooseframework.inl.gov
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Types | Protected Member Functions | Protected Attributes | List of all members
Cartesian1DSampler Class Reference

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 { SampleMode::GLOBAL, SampleMode::LOCAL }
 
typedef DataFileName DataFileParameterType
 

Public Member Functions

 Cartesian1DSampler (const InputParameters &parameters)
 
std::vector< RealgetNextLocalRow ()
 
dof_id_type getNumberOfRows () const
 
dof_id_type getNumberOfCols () const
 
dof_id_type getNumberOfLocalRows () const
 
const LocalRankConfiggetRankConfig (bool batch_mode) const
 
virtual bool isAdaptiveSamplingCompleted () const
 
libMesh::Parallel::CommunicatorgetLocalComm ()
 
virtual bool enabled () const
 
std::shared_ptr< MooseObjectgetSharedPtr ()
 
std::shared_ptr< const MooseObjectgetSharedPtr () const
 
MooseAppgetMooseApp () const
 
const std::string & type () const
 
virtual const std::string & name () const
 
std::string typeAndName () const
 
std::string errorPrefix (const std::string &error_type) const
 
void callMooseError (std::string msg, const bool with_prefix) const
 
MooseObjectParameterName uniqueParameterName (const std::string &parameter_name) const
 
const InputParametersparameters () const
 
MooseObjectName uniqueName () 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
 
getCheckedPointerParam (const std::string &name, const std::string &error_string="") const
 
bool isParamValid (const std::string &name) const
 
bool isParamSetByUser (const std::string &nm) const
 
void paramError (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
 
void connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const
 
void mooseError (Args &&... args) const
 
void mooseErrorNonPrefixed (Args &&... args) const
 
void mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const
 
void mooseWarning (Args &&... args) const
 
void mooseWarningNonPrefixed (Args &&... args) const
 
void mooseDeprecated (Args &&... args) const
 
void mooseInfo (Args &&... args) 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 ExecFlagEnumgetExecuteOnEnum () const
 
PerfGraphperfGraph ()
 
T & getSampler (const std::string &name)
 
SamplergetSampler (const std::string &name)
 
T & getSamplerByName (const SamplerName &name)
 
SamplergetSamplerByName (const SamplerName &name)
 
const VectorPostprocessorValuegetVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const
 
const VectorPostprocessorValuegetVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const
 
const VectorPostprocessorValuegetVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
const VectorPostprocessorValuegetVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const
 
const VectorPostprocessorValuegetVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const
 
const VectorPostprocessorValuegetVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const
 
const VectorPostprocessorValuegetVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
const VectorPostprocessorValuegetVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const
 
const ScatterVectorPostprocessorValuegetScatterVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const
 
const ScatterVectorPostprocessorValuegetScatterVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
const ScatterVectorPostprocessorValuegetScatterVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const
 
const ScatterVectorPostprocessorValuegetScatterVectorPostprocessorValueOldByName (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< RealgetGlobalSamples ()
 
DenseMatrix< RealgetGlobalSamples ()
 
DenseMatrix< RealgetLocalSamples ()
 
DenseMatrix< RealgetLocalSamples ()
 
dof_id_type getLocalRowBegin () const
 
dof_id_type getLocalRowBegin () const
 
dof_id_type getLocalRowEnd () const
 
dof_id_type getLocalRowEnd () const
 
const DistributiongetDistribution (const std::string &name) const
 
const T & getDistribution (const std::string &name) const
 
const DistributiongetDistribution (const std::string &name) const
 
const T & getDistribution (const std::string &name) const
 
const DistributiongetDistributionByName (const DistributionName &name) const
 
const T & getDistributionByName (const std::string &name) const
 
const DistributiongetDistributionByName (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 ()
 

Public Attributes

const ConsoleStream _console
 

Protected Types

enum  CommMethod
 

Protected Member Functions

virtual Real computeSample (dof_id_type row_index, dof_id_type col_index) override
 Return the sample for the given row and column. More...
 
void setNumberOfRandomSeeds (std::size_t number)
 
Real getRand (unsigned int index=0)
 
uint32_t getRandl (unsigned int index, uint32_t lower, uint32_t upper)
 
virtual LocalRankConfig constructRankConfig (bool batch_mode) 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 ReporterNamegetReporterName (const std::string &param_name) const
 
virtual void addReporterDependencyHelper (const ReporterName &)
 
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 sampleSetUp (const SampleMode)
 
virtual void sampleSetUp (const SampleMode)
 
virtual void sampleTearDown (const SampleMode)
 
virtual void sampleTearDown (const SampleMode)
 
virtual void computeSampleMatrix (DenseMatrix< Real > &matrix)
 
virtual void computeSampleMatrix (DenseMatrix< Real > &matrix)
 
virtual void computeLocalSampleMatrix (DenseMatrix< Real > &matrix)
 
virtual void computeLocalSampleMatrix (DenseMatrix< Real > &matrix)
 
virtual void computeSampleRow (dof_id_type i, std::vector< Real > &data)
 
virtual void computeSampleRow (dof_id_type i, std::vector< Real > &data)
 
virtual void advanceGenerators (const dof_id_type count)
 
virtual void advanceGenerators (const dof_id_type count)
 
virtual void advanceGenerator (const unsigned int seed_index, const dof_id_type count)
 
virtual void advanceGenerator (const unsigned int seed_index, const dof_id_type count)
 
void setAutoAdvanceGenerators (const bool state)
 
void setAutoAdvanceGenerators (const bool state)
 
void shuffle (std::vector< T > &data, const std::size_t seed_index=0, const CommMethod method=CommMethod::LOCAL)
 
void shuffle (std::vector< T > &data, const std::size_t seed_index=0, const CommMethod method=CommMethod::LOCAL)
 
virtual void executeSetUp ()
 
virtual void executeSetUp ()
 
virtual void executeTearDown ()
 
virtual void executeTearDown ()
 
void saveGeneratorState ()
 
void saveGeneratorState ()
 
void restoreGeneratorState ()
 
void restoreGeneratorState ()
 
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. More...
 
std::vector< dof_id_type_grid_range
 The range of rows in which to apply the grid for each column. More...
 
std::vector< std::vector< Real > > _grid_items
 The values to use when sampling from a column's grid. More...
 
 NONE
 
 LOCAL
 
 SEMI_LOCAL
 
const dof_id_type _min_procs_per_row
 
const dof_id_type _max_procs_per_row
 
libMesh::Parallel::Communicator _local_comm
 
const bool & _enabled
 
MooseApp_app
 
const std::string _type
 
const std::string _name
 
const InputParameters_pars
 
Factory_factory
 
ActionFactory_action_factory
 
const ExecFlagEnum_execute_enum
 
const ExecFlagType_current_execute_flag
 
MooseApp_pg_moose_app
 
const std::string _prefix
 
const Parallel::Communicator & _communicator
 

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.

28  : Sampler(parameters), _nominal_values(getParam<std::vector<Real>>("nominal_values"))
29 {
30  const std::vector<Real> & items = getParam<std::vector<Real>>("linear_space_items");
31  if (items.size() % 3 != 0)
32  paramError("linear_space_items",
33  "The number of numeric items must be divisible by 3; min, max, divisions for each "
34  "item are required.");
35  const dof_id_type num_cols = items.size() / 3;
36  if (_nominal_values.size() != num_cols)
37  paramError("nominal_values",
38  "The number of values specified must match the number of triplets in "
39  "'linear_space_items'.");
40 
41  _grid_range.resize(num_cols + 1, 0);
42  _grid_items.resize(num_cols);
43  dof_id_type num_rows = 0;
44  for (std::size_t i = 0; i < items.size(); i += 3)
45  {
46  if (items[i + 2] != std::floor(items[i + 2]))
47  paramError("linear_space_items",
48  "The third entry for each item must be an integer; it provides the number of "
49  "entries in the resulting item vector.");
50 
51  if (items[i + 2] < 0)
52  paramError("linear_space_items",
53  "The third entry for each item must be positive; it provides the number of "
54  "entries in the resulting item vector.");
55 
56  const dof_id_type col = i / 3;
57  const dof_id_type ng = static_cast<dof_id_type>(items[i + 2]);
58 
59  num_rows += ng;
60  _grid_range[col + 1] = num_rows;
61  _grid_items[col].resize(ng);
62  for (const auto & j : make_range(ng))
63  _grid_items[col][j] = items[i] + j * items[i + 1];
64  }
65 
66  setNumberOfRows(num_rows);
67  setNumberOfCols(num_cols);
68 }
void setNumberOfRows(dof_id_type n_rows)
std::vector< dof_id_type > _grid_range
The range of rows in which to apply the grid for each column.
Sampler(const InputParameters &parameters)
const T & getParam(const std::string &name) const
void paramError(const std::string &param, Args... args) const
std::vector< std::vector< Real > > _grid_items
The values to use when sampling from a column&#39;s grid.
void setNumberOfCols(dof_id_type n_cols)
IntRange< T > make_range(T beg, T end)
const InputParameters & parameters() const
static const std::complex< double > j(0, 1)
Complex number "j" (also known as "i")
uint8_t dof_id_type
const std::vector< Real > & _nominal_values
The values to use when not sampling from a column&#39;s grid.

Member Function Documentation

◆ computeSample()

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

Return the sample for the given row and column.

Implements Sampler.

Definition at line 71 of file Cartesian1DSampler.C.

72 {
73  if (row_index >= _grid_range[col_index] && row_index < _grid_range[col_index + 1])
74  return _grid_items[col_index][row_index - _grid_range[col_index]];
75  else
76  return _nominal_values[col_index];
77 }
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&#39;s grid.
const std::vector< Real > & _nominal_values
The values to use when not sampling from a column&#39;s grid.

◆ validParams()

InputParameters Cartesian1DSampler::validParams ( )
static

Definition at line 15 of file Cartesian1DSampler.C.

16 {
18  params.addClassDescription("Provides complete Cartesian product for the supplied variables.");
19  params.addRequiredParam<std::vector<Real>>(
20  "linear_space_items",
21  "A list of triplets, each item should include the min, step size, and number of steps.");
22  params.addRequiredParam<std::vector<Real>>("nominal_values", "Nominal values for each column.");
23  params.set<ExecFlagEnum>("execute_on") = EXEC_INITIAL;
24  return params;
25 }
static InputParameters validParams()
T & set(const std::string &name, bool quiet_mode=false)
void addRequiredParam(const std::string &name, const std::string &doc_string)
void addClassDescription(const std::string &doc_string)

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: