DPF Framework 2026 R1

result:compute invariant terms motion

Last update: 31.07.2026

Version: 0.0.0

Description

Set the required data for the invariant terms computation (reduced matrices, lumped mass matrix, modes ...)

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 rom_matrices Required fields_container
1 mode_shapes Required fields_container
2 lumped_mass Required fields_container
3 model_data Required fields_container
4 field_coordinates Required field
5 nod Required vector<int32>
6 phi_ortho fields_container

rom_matrices (Pin 0)

FieldsContainers containing the reduced matrices

mode_shapes (Pin 1)

FieldsContainers containing the mode shapes, which are CST and NOR for the cms method

lumped_mass (Pin 2)

FieldsContainers containing the lumped mass

model_data (Pin 3)

data describing the finite element model

field_coordinates (Pin 4)

  • Required: Yes
  • Expected type(s): field

coordinates of all nodes

nod (Pin 5)

phi_ortho (Pin 6)

Orthonormalizated modes transformation

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 model_data property_field
1 mode_shapes fields_container
2 lumped_mass fields_container
3 field_coordinates_and_euler_angles fields_container
4 nod vector<int32>
5 used_node_index vector<int32>
6 eigenvalue vector<double>
7 translational_mode_shape vector<double>
8 rotational_mode_shape vector<double>
9 invrt_1 double
10 invrt_2 vector<double>
11 invrt_3 vector<double>
12 invrt_4 vector<double>
13 invrt_5 vector<double>
14 invrt_6 vector<double>
15 invrt_7 vector<double>
16 invrt_8 vector<double>

model_data (Pin 0)

data describing the finite element model

mode_shapes (Pin 1)

FieldsContainers containing the mode shapes, which are CST and NOR for the cms method

lumped_mass (Pin 2)

FieldsContainers containing the lumped mass

field_coordinates_and_euler_angles (Pin 3)

coordinates and euler angles of all nodes

nod (Pin 4)

used_node_index (Pin 5)

eigenvalue (Pin 6)

translational_mode_shape (Pin 7)

rotational_mode_shape (Pin 8)

invrt_1 (Pin 9)

invrt_2 (Pin 10)

invrt_3 (Pin 11)

invrt_4 (Pin 12)

invrt_5 (Pin 13)

invrt_6 (Pin 14)

invrt_7 (Pin 15)

invrt_8 (Pin 16)

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: core

Scripting name: compute_invariant_terms_motion

Full name: result.compute_invariant_terms_motion

Internal name: compute_invariant_terms_motion

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("compute_invariant_terms_motion"); // operator instantiation
op.connect(0, my_rom_matrices);
op.connect(1, my_mode_shapes);
op.connect(2, my_lumped_mass);
op.connect(3, my_model_data);
op.connect(4, my_field_coordinates);
op.connect(5, my_nod);
op.connect(6, my_phi_ortho);
ansys::dpf::PropertyField my_model_data = op.getOutput<ansys::dpf::PropertyField>(0);
ansys::dpf::FieldsContainer my_mode_shapes = op.getOutput<ansys::dpf::FieldsContainer>(1);
ansys::dpf::FieldsContainer my_lumped_mass = op.getOutput<ansys::dpf::FieldsContainer>(2);
ansys::dpf::FieldsContainer my_field_coordinates_and_euler_angles = op.getOutput<ansys::dpf::FieldsContainer>(3);
std::vector<int> my_nod = op.getOutput<std::vector<int>>(4);
std::vector<int> my_used_node_index = op.getOutput<std::vector<int>>(5);
std::vector<double> my_eigenvalue = op.getOutput<std::vector<double>>(6);
std::vector<double> my_translational_mode_shape = op.getOutput<std::vector<double>>(7);
std::vector<double> my_rotational_mode_shape = op.getOutput<std::vector<double>>(8);
double my_invrt_1 = op.getOutput<double>(9);
std::vector<double> my_invrt_2 = op.getOutput<std::vector<double>>(10);
std::vector<double> my_invrt_3 = op.getOutput<std::vector<double>>(11);
std::vector<double> my_invrt_4 = op.getOutput<std::vector<double>>(12);
std::vector<double> my_invrt_5 = op.getOutput<std::vector<double>>(13);
std::vector<double> my_invrt_6 = op.getOutput<std::vector<double>>(14);
std::vector<double> my_invrt_7 = op.getOutput<std::vector<double>>(15);
std::vector<double> my_invrt_8 = op.getOutput<std::vector<double>>(16);
CPython 
import ansys.dpf.core as dpf

op = dpf.operators.result.compute_invariant_terms_motion() # operator instantiation
op.inputs.rom_matrices.connect(my_rom_matrices)
op.inputs.mode_shapes.connect(my_mode_shapes)
op.inputs.lumped_mass.connect(my_lumped_mass)
op.inputs.model_data.connect(my_model_data)
op.inputs.field_coordinates.connect(my_field_coordinates)
op.inputs.nod.connect(my_nod)
op.inputs.phi_ortho.connect(my_phi_ortho)
my_model_data = op.outputs.model_data()
my_mode_shapes = op.outputs.mode_shapes()
my_lumped_mass = op.outputs.lumped_mass()
my_field_coordinates_and_euler_angles = op.outputs.field_coordinates_and_euler_angles()
my_nod = op.outputs.nod()
my_used_node_index = op.outputs.used_node_index()
my_eigenvalue = op.outputs.eigenvalue()
my_translational_mode_shape = op.outputs.translational_mode_shape()
my_rotational_mode_shape = op.outputs.rotational_mode_shape()
my_invrt_1 = op.outputs.invrt_1()
my_invrt_2 = op.outputs.invrt_2()
my_invrt_3 = op.outputs.invrt_3()
my_invrt_4 = op.outputs.invrt_4()
my_invrt_5 = op.outputs.invrt_5()
my_invrt_6 = op.outputs.invrt_6()
my_invrt_7 = op.outputs.invrt_7()
my_invrt_8 = op.outputs.invrt_8()
IPython 
import mech_dpf
import Ans.DataProcessing as dpf

op = dpf.operators.result.compute_invariant_terms_motion() # operator instantiation
op.inputs.rom_matrices.Connect(my_rom_matrices)
op.inputs.mode_shapes.Connect(my_mode_shapes)
op.inputs.lumped_mass.Connect(my_lumped_mass)
op.inputs.model_data.Connect(my_model_data)
op.inputs.field_coordinates.Connect(my_field_coordinates)
op.inputs.nod.Connect(my_nod)
op.inputs.phi_ortho.Connect(my_phi_ortho)
my_model_data = op.outputs.model_data.GetData()
my_mode_shapes = op.outputs.mode_shapes.GetData()
my_lumped_mass = op.outputs.lumped_mass.GetData()
my_field_coordinates_and_euler_angles = op.outputs.field_coordinates_and_euler_angles.GetData()
my_nod = op.outputs.nod.GetData()
my_used_node_index = op.outputs.used_node_index.GetData()
my_eigenvalue = op.outputs.eigenvalue.GetData()
my_translational_mode_shape = op.outputs.translational_mode_shape.GetData()
my_rotational_mode_shape = op.outputs.rotational_mode_shape.GetData()
my_invrt_1 = op.outputs.invrt_1.GetData()
my_invrt_2 = op.outputs.invrt_2.GetData()
my_invrt_3 = op.outputs.invrt_3.GetData()
my_invrt_4 = op.outputs.invrt_4.GetData()
my_invrt_5 = op.outputs.invrt_5.GetData()
my_invrt_6 = op.outputs.invrt_6.GetData()
my_invrt_7 = op.outputs.invrt_7.GetData()
my_invrt_8 = op.outputs.invrt_8.GetData()

Changelog

  • Version 0.0.0: Initial release.

Connect with Ansys