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

SamplerPostprocessorTransfer

Transfers data from Postprocessors on the sub-application to a VectorPostprocessor on the master application.

Overview

This object is designed to transfer data from a Postprocessor to a VectorPostprocessor on the master application. This object must transfer data to a StochasticResults object.

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. If it is expected that some solves might not converge and aborting the main application is not the desired behavior, the parameter "ignore_solve_not_converge" must be set to true in the MultiApps block (see SamplerFullSolveMultiApp for more details). There are two options for how to transfer results from failed sub-applications: 1) "keep_solve_fail_value" is set to false (default) will transfer a NaN to StochasticResults and 2) "keep_solve_fail_value" is set to true will transfer whatever the last computed value of the postprocessor was before the solve failed.

Example Syntax

[Transfers]
  [runner]
    type = SamplerParameterTransfer
    multi_app = sub
    sampler = sobol
    parameters = 'BCs/left/value BCs/right/value'
    to_control = 'stochastic'
    execute_on = INITIAL
    check_multiapp_execute_on = false
  []
  [data]
    type = SamplerPostprocessorTransfer
    multi_app = sub
    sampler = sobol
    to_vector_postprocessor = storage
    from_postprocessor = avg
    execute_on = TIMESTEP_BEGIN
    check_multiapp_execute_on = false
  []
[]
(modules/stochastic_tools/test/tests/transfers/sampler_postprocessor/master.i)

Input Parameters

  • multi_appThe name of the MultiApp to use.

    C++ Type:MultiAppName

    Options:

    Description:The name of the MultiApp to use.

Required Parameters

  • check_multiapp_execute_onFalseWhen false the check between the multiapp and transfer execute on flags is not preformed.

    Default:False

    C++ Type:bool

    Options:

    Description:When false the check between the multiapp and transfer execute on flags is not preformed.

  • displaced_source_meshFalseWhether or not to use the displaced mesh for the source mesh.

    Default:False

    C++ Type:bool

    Options:

    Description:Whether or not to use the displaced mesh for the source mesh.

  • displaced_target_meshFalseWhether or not to use the displaced mesh for the target mesh.

    Default:False

    C++ Type:bool

    Options:

    Description:Whether or not to use the displaced mesh for the target mesh.

  • execute_onSAME_AS_MULTIAPPThe 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, SAME_AS_MULTIAPP.

    Default:SAME_AS_MULTIAPP

    C++ Type:ExecFlagEnum

    Options:NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, SAME_AS_MULTIAPP

    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, SAME_AS_MULTIAPP.

  • from_postprocessorThe name(s) of the Postprocessor(s) on the sub-app to transfer from.

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

    Options:

    Description:The name(s) of the Postprocessor(s) on the sub-app to transfer from.

  • keep_solve_fail_valueFalseIf true, whatever the value the sub app has upon exitting is used. If false, NaN will be transferred.

    Default:False

    C++ Type:bool

    Options:

    Description:If true, whatever the value the sub app has upon exitting is used. If false, NaN will be transferred.

  • prefixUse the supplied string as the prefix for vector postprocessor name rather than the transfer name.

    C++ Type:std::string

    Options:

    Description:Use the supplied string as the prefix for vector postprocessor name rather than the transfer name.

  • samplerA the Sampler object that Transfer is associated..

    C++ Type:SamplerName

    Options:

    Description:A the Sampler object that Transfer is associated..

  • to_vector_postprocessorThe name of the VectorPostprocessor in the MultiApp to transfer values to.

    C++ Type:VectorPostprocessorName

    Options:

    Description:The name of the VectorPostprocessor in the MultiApp to transfer values to.

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