CSVSampler

The CSV Sampler object generates samples from a user provided CSV file. The following assumptions are made about the CSV file:

  • All samples are numeric and do not contain strings.

  • Each column corresponds to a parameter that is to be sampled. Therefore, multiple parameters can be sampled with the same CSV file.

  • All columns have the same number of rows.

  • The number of rows in the file is the number of samples for each parameter.

The sampler can either read the entire file or can be used to read specific columns using the column_indices or the column_names input parameters (see the example syntax below). column_indices refer to the indices of the columns and column_names refer to the header names of the columns in the CSV file.

Example Input Syntax

In the example below, the sampler reads a file, samples.csv, which contains samples for various parameters. The input below reads columns 0, 1, and 3 from the samples file.

[Samplers]
  [sample]
    type = CSVSampler
    samples_file = 'samples.csv'
    column_indices = '0 1 3'
    execute_on = 'initial timestep_end'
  []
[]
(modules/stochastic_tools/test/tests/samplers/csv/csv_sampler_indices.i)

In another example below, the sampler reads the columns with the column names, a, b, and d.

[Samplers]
  [sample]
    type = CSVSampler
    samples_file = 'samples.csv'
    column_names = 'a b d'
    execute_on = 'initial timestep_end'
  []
[]
(modules/stochastic_tools/test/tests/samplers/csv/csv_sampler_names.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
(modules/stochastic_tools/test/tests/samplers/csv/samples.csv)

Input Parameters

  • samples_fileName of the CSV file that contains the samples matrix.

    C++ Type:FileName

    Controllable:No

    Description:Name of the CSV file that contains the samples matrix.

Required Parameters

  • column_indicesColumn indices in the CSV file to be sampled from. Number of indices here will be the same as the number of columns per matrix.

    C++ Type:std::vector<unsigned long>

    Controllable:No

    Description:Column indices in the CSV file to be sampled from. Number of indices here will be the same as the number of columns per matrix.

  • column_namesColumn names in the CSV file to be sampled from. Number of columns names here will be the same as the number of columns per matrix.

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

    Controllable:No

    Description:Column names in the CSV file to be sampled from. Number of columns names here will be the same as the number of columns per matrix.

  • 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

    Options:XFEM_MARK, FORWARD, ADJOINT, HOMOGENEOUS_FORWARD, ADJOINT_TIMESTEP_BEGIN, ADJOINT_TIMESTEP_END, 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

    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.

Advanced Parameters

Input Files