- matrixSampling matrix.
C++ Type:Eigen::Matrix<double, -1, -1, 0, -1, -1>
Unit:(no unit assumed)
Controllable:No
Description:Sampling matrix.
InputMatrix
Sampler that utilizes a sampling matrix defined at input.
Overview
This sampler simply takes a sampling matrix from input using the "matrix" parameter.
Example Input Syntax
See the following as an example input that creates a matrix with five rows and six columns:
[Samplers]
[sample]
type = InputMatrix
matrix = '1 2 3 4 5 6;
10 20 30 40 50 60;
0.1 0.2 0.3 0.4 0.5 0.6;
2 4 6 8 10 12;
1 4 9 16 25 36'
[]
[]
(contrib/moose/modules/stochastic_tools/test/tests/samplers/input_matrix/input_matrix.i)The resulting matrix looks like the following in CSV format:
sample_0,sample_1,sample_2,sample_3,sample_4,sample_5
1,2,3,4,5,6
10,20,30,40,50,60
0.1,0.2,0.3,0.4,0.5,0.6
2,4,6,8,10,12
1,4,9,16,25,36
(contrib/moose/modules/stochastic_tools/test/tests/samplers/input_matrix/gold/input_matrix_out_data_0001.csv)Input Parameters
- execute_onLINEARThe list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.
Default:LINEAR
C++ Type:ExecFlagEnum
Unit:(no unit assumed)
Controllable:No
Description:The list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.
- limit_get_global_samples429496729The maximum allowed number of items in the DenseMatrix returned by getGlobalSamples method.
Default:429496729
C++ Type:unsigned long
Unit:(no unit assumed)
Controllable:No
Description:The maximum allowed number of items in the DenseMatrix returned by getGlobalSamples method.
- limit_get_local_samples429496729The maximum allowed number of items in the DenseMatrix returned by getLocalSamples method.
Default:429496729
C++ Type:unsigned long
Unit:(no unit assumed)
Controllable:No
Description:The maximum allowed number of items in the DenseMatrix returned by getLocalSamples method.
- limit_get_next_local_row429496729The maximum allowed number of items in the std::vector returned by getNextLocalRow method.
Default:429496729
C++ Type:unsigned long
Unit:(no unit assumed)
Controllable:No
Description:The maximum allowed number of items in the std::vector returned by getNextLocalRow method.
- max_procs_per_row4294967295This will ensure that the sampler is partitioned properly when 'MultiApp/*/max_procs_per_app' is specified. It is not recommended to use otherwise.
Default:4294967295
C++ Type:unsigned int
Unit:(no unit assumed)
Controllable:No
Description:This will ensure that the sampler is partitioned properly when 'MultiApp/*/max_procs_per_app' is specified. It is not recommended to use otherwise.
- min_procs_per_row1This will ensure that the sampler is partitioned properly when 'MultiApp/*/min_procs_per_app' is specified. It is not recommended to use otherwise.
Default:1
C++ Type:unsigned int
Unit:(no unit assumed)
Controllable:No
Description:This will ensure that the sampler is partitioned properly when 'MultiApp/*/min_procs_per_app' is specified. It is not recommended to use otherwise.
- seed0Random number generator initial seed
Default:0
C++ Type:unsigned int
Unit:(no unit assumed)
Controllable:No
Description:Random number generator initial seed
Optional Parameters
- control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
Unit:(no unit assumed)
Controllable:No
Description:Adds user-defined labels for accessing object parameters via control logic.
- enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Set the enabled status of the MooseObject.