Install MOOSE link

New Users link

Examples and Tutorials link

Application Usage link

Physics and Syntax

Application Development link

Framework Development link

MOOSEDocs link

Infrastructure

Questions

Information and Tools

INL Applications and Remote Access link

SamplerFullSolveMultiApp

Creates a full-solve type sub-application for each row of each Sampler matrix.

Overview

The SamplerFullSolveMultiApp simply creates a full-solve 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.

Dealing with Failed Solves

When performing stochastic analysis with many perturbations of a sub-application, it is sometimes the case where the app receives a set of parameters that makes the solve difficult to converge. With the default configuration of this object, if one of sub-applications' solve fails, the main application will abort. This will cause the main application to stop sampling the sub-application and all the transfers and processing will fail as well. To prevent this, setting the parameter "ignore_solve_not_converge" to true will allow the main application to continue, despite there being a failed solve. For options on how failed solve results get transferred to the main application, see SamplerPostprocessorTransfer. If the sub-application is a transient simulation, the parameter "error_on_dtmin" must be set to false in the Executioner block.

Defining Minimum Processors Per App

It is often useful to define the minimum processors to use when running sub-applications. Typically this is done for large models in batch mode to avoid excessive memory usage. The "min_procs_per_app" will utilize this capability, however it is required that the "min_procs_per_row" parameter in the Samplers block be set to the same value. This is to enusre that the sampler partitioning is equivalent to the multiapp partitioning.

Example Syntax

[MultiApps]
  [runner]
    type = SamplerFullSolveMultiApp
    sampler = mc
    input_files = 'sub.i'
  []
[]
(modules/stochastic_tools/test/tests/multiapps/sampler_full_solve_multiapp/master_full_solve.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<FileName>

    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.

  • samplerThe Sampler object to utilize for creating MultiApps.

    C++ Type:SamplerName

    Options:

    Description:The Sampler object to utilize for creating MultiApps.

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.

  • bounding_box_padding0 0 0Additional padding added to the dimensions of the bounding box. The values are added to the x, y and z dimension respectively.

    Default:0 0 0

    C++ Type:libMesh::Point

    Options:

    Description:Additional padding added to the dimensions of the bounding box. The values are added to the x, y and z dimension respectively.

  • 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<std::string>

    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.

  • cli_args_filesFile names that should be looked in for additional command line arguments to pass to the sub apps. Each line of a file is set to each sub app. If only one line is provided, it will be applied to all sub apps.

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

    Options:

    Description:File names that should be looked in for additional command line arguments to pass to the sub apps. Each line of a file is set to each sub app. If only one line is provided, it will be applied to all sub apps.

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

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

  • ignore_solve_not_convergeFalseTrue to continue main app even if a sub app's solve does not converge.

    Default:False

    C++ Type:bool

    Options:

    Description:True to continue main app even if a sub app's solve does not converge.

  • keep_full_output_historyFalseWhether or not to keep the full output history when this multiapp has multiple entries

    Default:False

    C++ Type:bool

    Options:

    Description:Whether or not to keep the full output history when this multiapp has multiple entries

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

    Default:False

    C++ Type:bool

    Options:

    Description:This is useful when doing MultiApp coupling iterations. It takes the final solution from the previous coupling iterationand re-uses it as the initial guess for the next coupling 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_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

  • min_procs_per_app1Minimum number of processors to give to each App in this MultiApp. Useful for larger, distributed mesh solves.

    Default:1

    C++ Type:unsigned int

    Options:

    Description:Minimum number of processors to give to each App in this MultiApp. Useful for larger, distributed mesh solves.

  • modenormalThe operation mode, 'normal' creates one sub-application for each row in the Sampler and 'batch' creates one 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 one sub-application for each processor and re-executes for each row.

  • no_backup_and_restoreFalseTrue to turn off backup/restore for this multiapp. This is useful when doing steady-state Picard iterations where we want to use the solution of previous Picard iteration as the initial guess of the current Picard iteration

    Default:False

    C++ Type:bool

    Options:

    Description:True to turn off backup/restore for this multiapp. This is useful when doing steady-state Picard iterations where we want to use the solution of previous Picard iteration as the initial guess of the current Picard iteration

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

  • 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<unsigned int>

    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.

  • transformed_postprocessorsList of subapp postprocessors to use coupling algorithm on during Multiapp coupling iterations

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

    Options:

    Description:List of subapp postprocessors to use coupling algorithm on during Multiapp coupling iterations

  • transformed_variablesList of subapp variables to use coupling algorithm on during Multiapp coupling iterations

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

    Options:

    Description:List of subapp variables to use coupling algorithm on during Multiapp coupling iterations

Optional Parameters

  • control_tagsAdds user-defined labels for accessing object parameters via control logic.

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

    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.

  • 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

Child Objects