result:remove rigid body motion (field)
Last update: 31.07.2026Version: 0.0.0
Description
Removes rigid body mode from a total displacement field by minimization. Use a reference point in order to subtract its displacement to the result displacement field.
Inputs
This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. Some inputs are required, while others are optional and provide additional configuration. Each parameter is detailed in the sections that follow the table.
| Pin number | Name | Status | Expected type(s) |
|---|---|---|---|
| 0 | field | Required | field, fields_container |
| 1 | reference_node_id | int32 |
|
| 7 | mesh | abstract_meshed_region |
field (Pin 0)
- Required: Yes
- Expected type(s):
field,fields_container
field or fields container with only one field is expected
reference_node_id (Pin 1)
- Required: No
- Expected type(s):
int32
Id of the reference entity (node).
mesh (Pin 7)
- Required: No
- Expected type(s):
abstract_meshed_region
default is the mesh in the support
Outputs
This table lists the output pins for this operator. Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. Each output is detailed in the sections that follow the table.
| Pin number | Name | Expected type(s) |
|---|---|---|
| 0 | field | field |
| 1 | translation_field | field |
| 2 | rotation_field | field |
| 3 | center_field | field |
field (Pin 0)
- Expected type(s):
field
translation_field (Pin 1)
- Expected type(s):
field
Global rigid translation vector
rotation_field (Pin 2)
- Expected type(s):
field
Global rigid rotation angles
center_field (Pin 3)
- Expected type(s):
field
Center of the rigid rotation
Configurations
This operator supports configuration options that modify its behavior.
mutex
- Expected type(s):
bool - Default value: false
If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads.
Scripting
This operator can be accessed through scripting interfaces using these identifiers.
Category: result
Plugin: mapdl
Scripting name: remove_rigid_body_motion
Full name: result.remove_rigid_body_motion
Internal name: ExtractRigidBodyMotion
License: None
Examples
These examples demonstrate how to use this operator in different programming environments. Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output.
C++
#include "dpf_api.h"
ansys::dpf::Operator op("ExtractRigidBodyMotion"); // operator instantiation
op.connect(0, my_field);
op.connect(1, my_reference_node_id);
op.connect(7, my_mesh);
ansys::dpf::Field my_field = op.getOutput<ansys::dpf::Field>(0);
ansys::dpf::Field my_translation_field = op.getOutput<ansys::dpf::Field>(1);
ansys::dpf::Field my_rotation_field = op.getOutput<ansys::dpf::Field>(2);
ansys::dpf::Field my_center_field = op.getOutput<ansys::dpf::Field>(3);
CPython
import ansys.dpf.core as dpf
op = dpf.operators.result.remove_rigid_body_motion() # operator instantiation
op.inputs.field.connect(my_field)
op.inputs.reference_node_id.connect(my_reference_node_id)
op.inputs.mesh.connect(my_mesh)
my_field = op.outputs.field()
my_translation_field = op.outputs.translation_field()
my_rotation_field = op.outputs.rotation_field()
my_center_field = op.outputs.center_field()
IPython
import mech_dpf
import Ans.DataProcessing as dpf
op = dpf.operators.result.remove_rigid_body_motion() # operator instantiation
op.inputs.field.Connect(my_field)
op.inputs.reference_node_id.Connect(my_reference_node_id)
op.inputs.mesh.Connect(my_mesh)
my_field = op.outputs.field.GetData()
my_translation_field = op.outputs.translation_field.GetData()
my_rotation_field = op.outputs.rotation_field.GetData()
my_center_field = op.outputs.center_field.GetData()
Changelog
- Version 0.0.0: Initial release.