DPF Framework 2026 R1

result:write motion dfmf file

Last update: 31.07.2026

Version: 0.0.0

Description

Write the invariant terms and the model data in a motion dfmf file

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

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 (Pin 3)

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

coordinates 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)

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

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)

dfmffile_path (Pin 17)

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

path with motion dfmf extension where the export occurs

rstfile_path (Pin 18)

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

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 dfmf_data_source data_sources

dfmf_data_source (Pin 0)

Data Source containing the dfmf file generated.

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

Full name: result.write_motion_dfmf_file

Internal name: write_motion_dfmf_file

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("write_motion_dfmf_file"); // operator instantiation
op.connect(0, my_model_data);
op.connect(1, my_mode_shapes);
op.connect(2, my_lumped_mass);
op.connect(3, my_field_coordinates);
op.connect(4, my_nod);
op.connect(5, my_used_node_index);
op.connect(6, my_eigenvalue);
op.connect(7, my_translational_mode_shape);
op.connect(8, my_rotational_mode_shape);
op.connect(9, my_invrt_1);
op.connect(10, my_invrt_2);
op.connect(11, my_invrt_3);
op.connect(12, my_invrt_4);
op.connect(13, my_invrt_5);
op.connect(14, my_invrt_6);
op.connect(15, my_invrt_7);
op.connect(16, my_invrt_8);
op.connect(17, my_dfmffile_path);
op.connect(18, my_rstfile_path);
ansys::dpf::DataSources my_dfmf_data_source = op.getOutput<ansys::dpf::DataSources>(0);
CPython 
import ansys.dpf.core as dpf

op = dpf.operators.result.write_motion_dfmf_file() # operator instantiation
op.inputs.model_data.connect(my_model_data)
op.inputs.mode_shapes.connect(my_mode_shapes)
op.inputs.lumped_mass.connect(my_lumped_mass)
op.inputs.field_coordinates.connect(my_field_coordinates)
op.inputs.nod.connect(my_nod)
op.inputs.used_node_index.connect(my_used_node_index)
op.inputs.eigenvalue.connect(my_eigenvalue)
op.inputs.translational_mode_shape.connect(my_translational_mode_shape)
op.inputs.rotational_mode_shape.connect(my_rotational_mode_shape)
op.inputs.invrt_1.connect(my_invrt_1)
op.inputs.invrt_2.connect(my_invrt_2)
op.inputs.invrt_3.connect(my_invrt_3)
op.inputs.invrt_4.connect(my_invrt_4)
op.inputs.invrt_5.connect(my_invrt_5)
op.inputs.invrt_6.connect(my_invrt_6)
op.inputs.invrt_7.connect(my_invrt_7)
op.inputs.invrt_8.connect(my_invrt_8)
op.inputs.dfmffile_path.connect(my_dfmffile_path)
op.inputs.rstfile_path.connect(my_rstfile_path)
my_dfmf_data_source = op.outputs.dfmf_data_source()
IPython 
import mech_dpf
import Ans.DataProcessing as dpf

op = dpf.operators.result.write_motion_dfmf_file() # operator instantiation
op.inputs.model_data.Connect(my_model_data)
op.inputs.mode_shapes.Connect(my_mode_shapes)
op.inputs.lumped_mass.Connect(my_lumped_mass)
op.inputs.field_coordinates.Connect(my_field_coordinates)
op.inputs.nod.Connect(my_nod)
op.inputs.used_node_index.Connect(my_used_node_index)
op.inputs.eigenvalue.Connect(my_eigenvalue)
op.inputs.translational_mode_shape.Connect(my_translational_mode_shape)
op.inputs.rotational_mode_shape.Connect(my_rotational_mode_shape)
op.inputs.invrt_1.Connect(my_invrt_1)
op.inputs.invrt_2.Connect(my_invrt_2)
op.inputs.invrt_3.Connect(my_invrt_3)
op.inputs.invrt_4.Connect(my_invrt_4)
op.inputs.invrt_5.Connect(my_invrt_5)
op.inputs.invrt_6.Connect(my_invrt_6)
op.inputs.invrt_7.Connect(my_invrt_7)
op.inputs.invrt_8.Connect(my_invrt_8)
op.inputs.dfmffile_path.Connect(my_dfmffile_path)
op.inputs.rstfile_path.Connect(my_rstfile_path)
my_dfmf_data_source = op.outputs.dfmf_data_source.GetData()

Changelog

  • Version 0.0.0: Initial release.

Connect with Ansys