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]
  [csv]
    type = CSVReader
    csv_file = 'example.csv'
  []

  [data]
    type = SamplerData
    sampler = vpp
    sampler_method = get_global_samples
    execute_on = 'FINAL'
  []
[]
(contrib/moose/modules/stochastic_tools/test/tests/samplers/vectorpostprocessor/vectorpostprocessor.i)

The VectorPostprocessor Sampler takes vectors csv/year and csv/month as input to generate samples:

[Samplers]
  [vpp]
    type = VectorPostprocessorSampler
    vectors_names = 'csv/year csv/month'
    execute_on = 'initial timestep_end'
  []
[]
(contrib/moose/modules/stochastic_tools/test/tests/samplers/vectorpostprocessor/vectorpostprocessor.i)

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
(contrib/moose/modules/stochastic_tools/test/tests/samplers/csv/samples.csv)

Input Parameters

  • vectors_namesThe names of the vector-postprocessors and/or vector reporter values containing the column data.

    C++ Type:std::vector<ReporterName>

    Unit:(no unit assumed)

    Controllable:No

    Description:The names of the vector-postprocessors and/or vector reporter values containing the column data.

Required 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)

    Options:NONE, INITIAL, LINEAR, NONLINEAR_CONVERGENCE, NONLINEAR, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, PRE_MULTIAPP_SETUP

    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.

Advanced Parameters