SamplerTransientMultiApp

The SamplerTransientMultiApp simply creates a transient-type sub application (see MultiApps) for each row of each matrix returned from the Sampler object.

This object is capable of running in batch mode by setting the 'mode' parameter. For more information refer to Stochastic Tools Batch Mode.

Example Syntax

[MultiApps]
[runner]
type = SamplerTransientMultiApp
sampler = mc
input_files = 'sub.i'
[]
[]

(modules/stochastic_tools/test/tests/multiapps/sampler_transient_multiapp/master_transient.i)

Input Parameters

• input_filesThe input file for each App. If this parameter only contains one input file it will be used for all of the Apps. When using 'positions_from_file' it is also admissable to provide one input_file per file.

C++ Type:std::vector

Options:

Description:The input file for each App. If this parameter only contains one input file it will be used for all of the Apps. When using 'positions_from_file' it is also admissable to provide one input_file per file.

Required Parameters

• app_typeThe type of application to build (applications not registered can be loaded with dynamic libraries. Master application type will be used if not provided.

C++ Type:MooseEnum

Options:CombinedApp CombinedTestApp

Description:The type of application to build (applications not registered can be loaded with dynamic libraries. Master application type will be used if not provided.

• bounding_box_inflation0.01Relative amount to 'inflate' the bounding box of this MultiApp.

Default:0.01

C++ Type:double

Options:

Description:Relative amount to 'inflate' the bounding box of this MultiApp.

Default:0 0 0

C++ Type:libMesh::Point

Options:

• catch_upFalseIf true this will allow failed solves to attempt to 'catch up' using smaller timesteps.

Default:False

C++ Type:bool

Options:

Description:If true this will allow failed solves to attempt to 'catch up' using smaller timesteps.

• cli_argsAdditional command line arguments to pass to the sub apps. If one set is provided the arguments are applied to all, otherwise there must be a set for each sub app.

C++ Type:std::vector

Options:

Description:Additional command line arguments to pass to the sub apps. If one set is provided the arguments are applied to all, otherwise there must be a set for each sub app.

• clone_master_meshFalseTrue to clone master mesh and use it for this MultiApp.

Default:False

C++ Type:bool

Options:

Description:True to clone master mesh and use it for this MultiApp.

• detect_steady_stateFalseIf true then while sub_cycling a steady state check will be done. In this mode output will only be done once the MultiApp reaches the target time or steady state is reached

Default:False

C++ Type:bool

Options:

Description:If true then while sub_cycling a steady state check will be done. In this mode output will only be done once the MultiApp reaches the target time or steady state is reached

• execute_onTIMESTEP_BEGINThe 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_BEGIN

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.

• global_time_offset0The time offset relative to the master application for the purpose of starting a subapp at different time from the master application. The global time will be ahead by the offset specified here.

Default:0

C++ Type:double

Options:

Description:The time offset relative to the master application for the purpose of starting a subapp at different time from the master application. The global time will be ahead by the offset specified here.

• interpolate_transfersFalseOnly valid when sub_cycling. This allows transferred values to be interpolated over the time frame the MultiApp is executing over when sub_cycling

Default:False

C++ Type:bool

Options:

Description:Only valid when sub_cycling. This allows transferred values to be interpolated over the time frame the MultiApp is executing over when sub_cycling

• keep_solution_during_restoreFalseThis is useful when doing Picard. It takes the final solution from the previous Picard iterationand re-uses it as the initial guess for the next picard iteration

Default:False

C++ Type:bool

Options:

Description:This is useful when doing Picard. It takes the final solution from the previous Picard iterationand re-uses it as the initial guess for the next picard iteration

• library_nameThe file name of the library (*.la file) that will be dynamically loaded.

C++ Type:std::string

Options:

Description:The file name of the library (*.la file) that will be dynamically loaded.

• library_pathPath to search for dynamic libraries (please avoid committing absolute paths in addition to MOOSE_LIBRARY_PATH)

C++ Type:std::string

Options:

Description:Path to search for dynamic libraries (please avoid committing absolute paths in addition to MOOSE_LIBRARY_PATH)

• max_catch_up_steps2Maximum number of steps to allow an app to take when trying to catch back up after a failed solve.

Default:2

C++ Type:double

Options:

Description:Maximum number of steps to allow an app to take when trying to catch back up after a failed solve.

• max_failures0Maximum number of solve failures tolerated while sub_cycling.

Default:0

C++ Type:unsigned int

Options:

Description:Maximum number of solve failures tolerated while sub_cycling.

• max_procs_per_app4294967295Maximum number of processors to give to each App in this MultiApp. Useful for restricting small solves to just a few procs so they don't get spread out

Default:4294967295

C++ Type:unsigned int

Options:

Description:Maximum number of processors to give to each App in this MultiApp. Useful for restricting small solves to just a few procs so they don't get spread out

• modenormalThe operation mode, 'normal' creates one sub-application for each row in the Sampler and 'batch' creates on sub-application for each processor and re-executes for each row.

Default:normal

C++ Type:MooseEnum

Options:normal batch-reset batch-restore

Description:The operation mode, 'normal' creates one sub-application for each row in the Sampler and 'batch' creates on sub-application for each processor and re-executes for each row.

• output_sub_cyclesFalseIf true then every sub-cycle will be output.

Default:False

C++ Type:bool

Options:

Description:If true then every sub-cycle will be output.

• print_sub_cyclesTrueToggle the display of sub-cycles on the screen.

Default:True

C++ Type:bool

Options:

Description:Toggle the display of sub-cycles on the screen.

• relaxation_factor1Fraction of newly computed value to keep.Set between 0 and 2.

Default:1

C++ Type:double

Options:

Description:Fraction of newly computed value to keep.Set between 0 and 2.

• relaxed_variablesList of variables to relax during Picard Iteration

C++ Type:std::vector

Options:

Description:List of variables to relax during Picard Iteration

• reset_appsThe Apps that will be reset when 'reset_time' is hit. These are the App 'numbers' starting with 0 corresponding to the order of the App positions. Resetting an App means that it is destroyed and recreated, possibly modeling the insertion of 'new' material for that app.

C++ Type:std::vector

Options:

Description:The Apps that will be reset when 'reset_time' is hit. These are the App 'numbers' starting with 0 corresponding to the order of the App positions. Resetting an App means that it is destroyed and recreated, possibly modeling the insertion of 'new' material for that app.

• reset_time1.79769e+308The time at which to reset Apps given by the 'reset_apps' parameter. Resetting an App means that it is destroyed and recreated, possibly modeling the insertion of 'new' material for that app.

Default:1.79769e+308

C++ Type:double

Options:

Description:The time at which to reset Apps given by the 'reset_apps' parameter. Resetting an App means that it is destroyed and recreated, possibly modeling the insertion of 'new' material for that app.

• samplerThe Sampler object to utilize for creating MultiApps.

C++ Type:SamplerName

Options:

Description:The Sampler object to utilize for creating MultiApps.

• steady_state_tol1e-08The relative difference between the new solution and the old solution that will be considered to be at steady state

Default:1e-08

C++ Type:double

Options:

Description:The relative difference between the new solution and the old solution that will be considered to be at steady state

• sub_cyclingFalseSet to true to allow this MultiApp to take smaller timesteps than the rest of the simulation. More than one timestep will be performed for each 'master' timestep

Default:False

C++ Type:bool

Options:

Description:Set to true to allow this MultiApp to take smaller timesteps than the rest of the simulation. More than one timestep will be performed for each 'master' timestep

• tolerate_failureFalseIf true this MultiApp won't participate in dt decisions and will always be fast-forwarded to the current time.

Default:False

C++ Type:bool

Options:

Description:If true this MultiApp won't participate in dt decisions and will always be fast-forwarded to the current time.

Optional Parameters

• 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.

• implicitTrueDetermines whether this object is calculated using an implicit or explicit form

Default:True

C++ Type:bool

Options:

Description:Determines whether this object is calculated using an implicit or explicit form

• 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.