StochasticResults

This object is designed to work with the SamplerPostprocessorTransfer object for transferring data from a Postprocessor to a VectorPostprocessor on the master application.

Example Syntax

[VectorPostprocessors]
  [storage]
    type = StochasticResults
    samplers = sample
    execute_on = 'INITIAL TIMESTEP_END'
  []
[]
(modules/stochastic_tools/test/tests/transfers/sampler_postprocessor/master.i)

Input Parameters

  • contains_complete_historyFalseSet this flag to indicate that the values in all vectors declared by this VPP represent a time history (e.g. with each invocation, new values are added and old values are never removed). This changes the output so that only a single file is output and updated with each invocation

    Default:False

    C++ Type:bool

    Options:

    Description:Set this flag to indicate that the values in all vectors declared by this VPP represent a time history (e.g. with each invocation, new values are added and old values are never removed). This changes the output so that only a single file is output and updated with each invocation

  • execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM.

    Default:TIMESTEP_END

    C++ Type:ExecFlagEnum

    Options:NONE INITIAL LINEAR NONLINEAR TIMESTEP_END TIMESTEP_BEGIN FINAL CUSTOM

    Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM.

  • output_distributed_rank4294967295When 'parallel_type = DISTRIBUTED' set this to copy the data from the specified processor for output. This is mainly for testing since the data from that rank will override the data on the root process.

    Default:4294967295

    C++ Type:unsigned int

    Options:

    Description:When 'parallel_type = DISTRIBUTED' set this to copy the data from the specified processor for output. This is mainly for testing since the data from that rank will override the data on the root process.

  • parallel_typeREPLICATEDSpecify if the stored data vector is replicated or distributed across processors.

    Default:REPLICATED

    C++ Type:MooseEnum

    Options:REPLICATED DISTRIBUTED

    Description:Specify if the stored data vector is replicated or distributed across processors.

  • samplersA list of sampler names of associated data.

    C++ Type:std::vector

    Options:

    Description:A list of sampler names of associated data.

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

    Options:

    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

    Options:

    Description:Adds user-defined labels for accessing object parameters via control logic.

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Options:

    Description:Set the enabled status of the MooseObject.

  • force_preauxFalseForces the GeneralUserObject to be executed in PREAUX

    Default:False

    C++ Type:bool

    Options:

    Description:Forces the GeneralUserObject to be executed in PREAUX

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

    C++ Type:std::vector

    Options:

    Description:Vector of output names were 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

    Options:

    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

Input Files