- base_positionsPositions object providing the positions to transform
C++ Type:PositionsName
Controllable:No
Description:Positions object providing the positions to transform
- transformThe type of transformation to perform (TRANSLATE, ROTATE_XYZ, SCALE)
C++ Type:MooseEnum
Controllable:No
Description:The type of transformation to perform (TRANSLATE, ROTATE_XYZ, SCALE)
TransformedPositions
Transform, with a linear transformation, positions from another Positions object
commentnote
The TransformedPositions may require re-ordering the Positions objects as it must be initialized after the positions it transforms.
commentnote
Rotations along X Y and Z generally do not commute. If in doubt, using multiple TransformedPositions to get the desired rotations may make it easier.
Example File Syntax
In this example, several TransformedPositions are used to perform various transformations on Positions objects.
[Positions]
[input]
type = InputPositions
positions = '0 0 0
1 0 0
0 1 0'
outputs = none
[]
[scale]
type = TransformedPositions
base_positions = 'input'
vector_value = '1 2 3'
transform = 'SCALE'
[]
[rotate]
type = TransformedPositions
base_positions = 'input'
vector_value = '0 0 90'
transform = 'ROTATE_XYZ'
[]
[translate]
type = TransformedPositions
base_positions = 'input'
vector_value = '10 0 0'
transform = 'TRANSLATE'
[]
[]
Input Parameters
- execute_onLINEAR TIMESTEP_BEGINThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM.
Default:LINEAR TIMESTEP_BEGIN
C++ Type:ExecFlagEnum
Controllable:No
Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM.
- initial_positionsPositions at the beginning of the simulation
C++ Type:PositionsName
Controllable:No
Description:Positions at the beginning of the simulation
- prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.
C++ Type:MaterialPropertyName
Controllable:No
Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.
- use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.
Default:False
C++ Type:bool
Controllable:No
Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.
- vector_valueThe value to use for the transformation. When using TRANSLATE or SCALE, the xyz coordinates are applied in each direction respectively. When using ROTATE_XYZ, the values are interpreted as rotations in degrees around the X, Y and Z axis, in that order.
C++ Type:libMesh::VectorValue<double>
Controllable:No
Description:The value to use for the transformation. When using TRANSLATE or SCALE, the xyz coordinates are applied in each direction respectively. When using ROTATE_XYZ, the values are interpreted as rotations in degrees around the X, Y and Z axis, in that order.
Optional Parameters
- allow_duplicate_execution_on_initialFalseIn the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).
Default:False
C++ Type:bool
Controllable:No
Description:In the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).
- auto_broadcastFalseWether Positions should be broadcasted across all ranks
Default:False
C++ Type:bool
Controllable:No
Description:Wether Positions should be broadcasted across all ranks
- auto_sortFalseWhether Positions should be sorted by coordinates
Default:False
C++ Type:bool
Controllable:No
Description:Whether Positions should be sorted by coordinates
- control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
Controllable:No
Description:Adds user-defined labels for accessing object parameters via control logic.
- enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Controllable:Yes
Description:Set the enabled status of the MooseObject.
- execution_order_group0Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.
Default:0
C++ Type:int
Controllable:No
Description:Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.
- force_postauxFalseForces the UserObject to be executed in POSTAUX
Default:False
C++ Type:bool
Controllable:No
Description:Forces the UserObject to be executed in POSTAUX
- force_preauxFalseForces the UserObject to be executed in PREAUX
Default:False
C++ Type:bool
Controllable:No
Description:Forces the UserObject to be executed in PREAUX
- force_preicFalseForces the UserObject to be executed in PREIC during initial setup
Default:False
C++ Type:bool
Controllable:No
Description:Forces the UserObject to be executed in PREIC during initial setup
- outputsVector of output names where you would like to restrict the output of variables(s) associated with this object
C++ Type:std::vector<OutputName>
Controllable:No
Description:Vector of output names where you would like to restrict the output of variables(s) associated with this object
- 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
Controllable:No
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.