- vectors_namesThe names of the vector-postprocessors and/or vector reporter values containing the column data.
C++ Type:std::vector<ReporterName>
Controllable:No
Description:The names of the vector-postprocessors and/or vector reporter values containing the column data.
VectorPostprocessorSampler
The sampler uses vector postprocessors as inputs.
The sampler generates samples from vector-postprocessor and/or vector reporters. The user is required to provide the names of these vectors in "vectors_names", which is in the format <vpp_name>/<vector_name> for vector-postprocessors and <reporter_name>/<value_name> for reporter values.
Example Input Syntax
In the example below, a vectorpostprocessor ([csv]) are formed using CSVReaderVectorPostprocessor:
[VectorPostprocessors<<<{"href": "../../syntax/VectorPostprocessors/index.html"}>>>]
[csv]
type = CSVReader<<<{"description": "Converts columns of a CSV file into vectors of a VectorPostprocessor.", "href": "../vectorpostprocessors/CSVReaderVectorPostprocessor.html"}>>>
csv_file<<<{"description": "The name of the CSV file to read. Currently, with the exception of the header row, only numeric values are supported."}>>> = 'example.csv'
[]
[data]
type = SamplerData<<<{"description": "Tool for extracting Sampler object data and storing in VectorPostprocessor vectors.", "href": "../vectorpostprocessors/SamplerData.html"}>>>
sampler<<<{"description": "The sample from which to extract distribution data."}>>> = vpp
sampler_method<<<{"description": "Control the method of data retrieval from the Sampler object; this is mainly for testing."}>>> = get_global_samples
execute_on<<<{"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."}>>> = 'FINAL'
[]
[]The VectorPostprocessor Sampler takes vectors csv/year and csv/month as input to generate samples:
[Samplers<<<{"href": "../../syntax/Samplers/index.html"}>>>]
[vpp]
type = VectorPostprocessorSampler<<<{"description": "The sampler uses vector postprocessors as inputs.", "href": "VectorPostprocessorSampler.html"}>>>
vectors_names<<<{"description": "The names of the vector-postprocessors and/or vector reporter values containing the column data."}>>> = 'csv/year csv/month'
execute_on<<<{"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."}>>> = 'initial timestep_end'
[]
[]The samples file used in the above examples, samples.csv, is listed below.
a,b,c,d,e,f
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
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
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
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
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
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
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
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
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>
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
Controllable:No
Description:Set the enabled status of the MooseObject.