- variableThe auxiliary variable to store the transferred values in.
C++ Type:AuxVariableName
Description:The auxiliary variable to store the transferred values in.
- source_variableThe variable to transfer from.
C++ Type:VariableName
Description:The variable to transfer from.
- directionWhether this Transfer will be 'to' or 'from' a MultiApp.
C++ Type:MooseEnum
Description:Whether this Transfer will be 'to' or 'from' a MultiApp.
- multi_appThe name of the MultiApp to use.
C++ Type:MultiAppName
Description:The name of the MultiApp to use.
MultiAppNearestNodeTransfer
under construction:Undocumented Class
The MultiAppNearestNodeTransfer 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/MultiAppNearestNodeTransfer
Input Parameters
- target_boundaryThe boundary we are transferring to (if not specified, whole domain is used).
C++ Type:BoundaryName
Description:The boundary we are transferring to (if not specified, whole domain is used).
- check_multiapp_execute_onTrueWhen false the check between the multiapp and transfer execute on flags is not preformed.
Default:True
C++ Type:bool
Description:When false the check between the multiapp and transfer execute on flags is not preformed.
- source_boundaryThe boundary we are transferring from (if not specified, whole domain is used).
C++ Type:BoundaryName
Description:The boundary we are transferring from (if not specified, whole domain is used).
- 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
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.
- displaced_source_meshFalseWhether or not to use the displaced mesh for the source mesh.
Default:False
C++ Type:bool
Description:Whether or not to use the displaced mesh for the source mesh.
- fixed_meshesFalseSet to true when the meshes are not changing (ie, no movement or adaptivity). This will cache nearest node neighbors to greatly speed up the transfer.
Default:False
C++ Type:bool
Description:Set to true when the meshes are not changing (ie, no movement or adaptivity). This will cache nearest node neighbors to greatly speed up the transfer.
- displaced_target_meshFalseWhether or not to use the displaced mesh for the target mesh.
Default:False
C++ Type:bool
Description:Whether or not to use the displaced mesh for the target mesh.
Optional Parameters
- control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector
Description:Adds user-defined labels for accessing object parameters via control logic.
- enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
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
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.