StochasticMatrix

Tool for extracting Sampler object data and storing data from stochastic simulations.

Overview

The primary purpose of the StochasticMatrix object is to output sampler data alongside stochastic simulation results. The object retrieves the sampler specified with "sampler" and outputs a vector for each column of the sampler matrix. The names of these vectors can be specified using "sampler_column_names". Similarly to StochasticReporter, this object can receive stochastic data from objects like SamplerReporterTransfer. However, the sampler used in these other objects, like the transfer, must utilize the same sampler as the one specified in "sampler".

Example Syntax

The following is an example of using StochasticMatrix to output sampler data and results from stochastic simulations. Here we create an arbitrary matrix using InputMatrix which used to run stochastic simulations using SamplerFullSolveMultiApp.

[Samplers]
  [sample]
    type = InputMatrix
    matrix = '11 12 13 14;
              21 22 23 24;
              31 32 33 34;
              41 42 43 44;
              51 52 53 54'
  []
[]

[MultiApps]
  [sub]
    type = SamplerFullSolveMultiApp
    input_files = sub.i
    sampler = sample
  []
[]
(contrib/moose/modules/stochastic_tools/test/tests/reporters/stochastic_matrix/stochastic_matrix.i)

The parameters are transferred via a SamplerParameterTransfer and the results are transferred back with a SamplerReporterTransfer. This transfers the results in to the StochasticMatrix object named matrix.

[Transfers]
  [param]
    type = SamplerParameterTransfer
    to_multi_app = sub
    sampler = sample
    parameters = 'Functions/afun/value Functions/bfun/value Functions/cfun/value Functions/dfun/value'
  []
  [data]
    type = SamplerReporterTransfer
    from_multi_app = sub
    sampler = sample
    from_reporter = val/value
    stochastic_reporter = matrix
  []
[]

[Reporters]
  [matrix]
    type = StochasticMatrix
    sampler = sample
    sampler_column_names = 'a b c d'
    parallel_type = ROOT
  []
[]
(contrib/moose/modules/stochastic_tools/test/tests/reporters/stochastic_matrix/stochastic_matrix.i)

The input parameters in the StochasticMatrix block specify the column names, and the resulting CSV file looks like:

a,b,c,d,data:converged,data:val:value
11,12,13,14,True,11121314
21,22,23,24,True,21222324
31,32,33,34,True,31323334
41,42,43,44,True,41424344
51,52,53,54,True,51525354
(contrib/moose/modules/stochastic_tools/test/tests/reporters/stochastic_matrix/gold/stochastic_matrix_out_matrix_0001.csv)

Input Parameters

  • samplerThe sample from which to extract distribution data.

    C++ Type:SamplerName

    Unit:(no unit assumed)

    Controllable:No

    Description:The sample from which to extract distribution data.

Required Parameters

  • execute_onTIMESTEP_ENDThe 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:TIMESTEP_END

    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

    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.

  • parallel_typeDISTRIBUTEDThis parameter will determine how the stochastic data is gathered. It is common for outputting purposes that this parameter be set to ROOT, otherwise, many files will be produced showing the values on each processor. However, if there are lot of samples, gathering on root may be memory restrictive.

    Default:DISTRIBUTED

    C++ Type:MooseEnum

    Unit:(no unit assumed)

    Options:DISTRIBUTED, ROOT

    Controllable:No

    Description:This parameter will determine how the stochastic data is gathered. It is common for outputting purposes that this parameter be set to ROOT, otherwise, many files will be produced showing the values on each processor. However, if there are lot of samples, gathering on root may be memory restrictive.

  • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

    C++ Type:MaterialPropertyName

    Unit:(no unit assumed)

    Controllable:No

    Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

  • sampler_column_namesPrescribed names of sampler columns, used to assign names of outputted vectors.

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

    Unit:(no unit assumed)

    Controllable:No

    Description:Prescribed names of sampler columns, used to assign names of outputted vectors.

  • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

Optional Parameters

  • allow_duplicate_execution_on_initialFalseIn the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:In the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

  • 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:Yes

    Description:Set the enabled status of the MooseObject.

  • execution_order_group0Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.

    Default:0

    C++ Type:int

    Unit:(no unit assumed)

    Controllable:No

    Description:Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.

  • force_postauxFalseForces the UserObject to be executed in POSTAUX

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Forces the UserObject to be executed in POSTAUX

  • force_preauxFalseForces the UserObject to be executed in PREAUX

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Forces the UserObject to be executed in PREAUX

  • force_preicFalseForces the UserObject to be executed in PREIC during initial setup

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Forces the UserObject to be executed in PREIC during initial setup

  • outputsVector of output names where you would like to restrict the output of variables(s) associated with this object

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

    Unit:(no unit assumed)

    Controllable:No

    Description:Vector of output names where you would like to restrict the output of variables(s) associated with this object

  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

Advanced Parameters