MultiAppMeshFunctionTransfer

under construction:Undocumented Class

The MultiAppMeshFunctionTransfer has not been documented, if you would like to contribute to MOOSE by writing documentation, please see Documenting MOOSE. The content contained on this page explains the typical documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

!syntax description /Transfers/MultiAppMeshFunctionTransfer

Input Parameters

  • variableThe auxiliary variable to store the transferred values in.

    C++ Type:std::vector

    Options:

    Description:The auxiliary variable to store the transferred values in.

  • source_variableThe variable to transfer from.

    C++ Type:std::vector

    Options:

    Description:The variable to transfer from.

  • directionWhether this Transfer will be 'to' or 'from' a MultiApp.

    C++ Type:MooseEnum

    Options:to_multiapp from_multiapp

    Description:Whether this Transfer will be 'to' or 'from' a MultiApp.

  • 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_onTrueWhen false the check between the multiapp and transfer execute on flags is not preformed.

    Default:True

    C++ Type:bool

    Options:

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

  • error_on_missFalseWhether or not to error in the case that a target point is not found in the source domain.

    Default:False

    C++ Type:bool

    Options:

    Description:Whether or not to error in the case that a target point is not found in the source domain.

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

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.

  • 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

References