## On this page

  

 

 # result:rom data provider

 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 numberNameStatusExpected type(s)0[rom\_type](#input_0)Required[`bool`](../../core-concepts/dpf-types.md#standard-types)**1**[reduced\_stiff\_matrix](#input_1)Required[`fields_container`](../../core-concepts/dpf-types.md#fields-container)**2**[reduced\_damping\_matrix](#input_2)Required[`fields_container`](../../core-concepts/dpf-types.md#fields-container)**3**[reduced\_mass\_matrix](#input_3)Required[`fields_container`](../../core-concepts/dpf-types.md#fields-container)**4**[data\_sources](#input_4)Required[`data_sources`](../../core-concepts/dpf-types.md#data-sources)**5**[reduced\_rhs\_vector](#input_5)Required[`fields_container`](../../core-concepts/dpf-types.md#fields-container)**6**[lumped\_mass\_matrix](#input_6)Required[`fields_container`](../../core-concepts/dpf-types.md#fields-container)**7**[mode\_shapes](#input_7)Required[`fields_container`](../../core-concepts/dpf-types.md#fields-container)<a id="input_0"></a>

### rom\_type (Pin 0)

- **Required:** Yes
- **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types)

If this pin is set to true, customized rom data must be given

<a id="input_1"></a>

### reduced\_stiff\_matrix (Pin 1)

- **Required:** Yes
- **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container)

FieldsContainers containing the reduced Stiffness matrix

<a id="input_2"></a>

### reduced\_damping\_matrix (Pin 2)

- **Required:** Yes
- **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container)

FieldsContainers containing the reduced Mass matrix

<a id="input_3"></a>

### reduced\_mass\_matrix (Pin 3)

- **Required:** Yes
- **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container)

FieldsContainers containing the reduced Damp matrix

<a id="input_4"></a>

### data\_sources (Pin 4)

- **Required:** Yes
- **Expected type(s):** [`data_sources`](../../core-concepts/dpf-types.md#data-sources)

<a id="input_5"></a>

### reduced\_rhs\_vector (Pin 5)

- **Required:** Yes
- **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container)

FieldsContainers containing the reduced RHS vector

<a id="input_6"></a>

### lumped\_mass\_matrix (Pin 6)

- **Required:** Yes
- **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container)

FieldsContainers containing the lumped Mass matrix

<a id="input_7"></a>

### mode\_shapes (Pin 7)

- **Required:** Yes
- **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container)

FieldsContainers containing the customized mode shapes

## 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 numberNameExpected type(s)0[rom\_matrices](#output_0)[`fields_container`](../../core-concepts/dpf-types.md#fields-container)**1**[mode\_shapes](#output_1)[`fields_container`](../../core-concepts/dpf-types.md#fields-container)**2**[lumped\_mass](#output_2)[`fields_container`](../../core-concepts/dpf-types.md#fields-container)**3**[model\_data](#output_3)[`property_field`](../../core-concepts/dpf-types.md#property-field)**4**[center\_of\_mass](#output_4)[`property_field`](../../core-concepts/dpf-types.md#property-field)**5**[inertia\_relief](#output_5)[`field`](../../core-concepts/dpf-types.md#field)**6**[model\_size](#output_6)[`double`](../../core-concepts/dpf-types.md#standard-types)**7**[field\_coordinates\_and\_euler\_angles](#output_7)[`double`](../../core-concepts/dpf-types.md#standard-types)**8**[nod](#output_8)[`vector<int32>`](../../core-concepts/dpf-types.md#standard-types)**9**[meshed\_region](#output_9)[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region)**10**[phi\_ortho](#output_10)[`fields_container`](../../core-concepts/dpf-types.md#fields-container)<a id="output_0"></a>

### rom\_matrices (Pin 0)

- **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container)

FieldsContainers containing the reduced matrices

<a id="output_1"></a>

### mode\_shapes (Pin 1)

- **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container)

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

<a id="output_2"></a>

### lumped\_mass (Pin 2)

- **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container)

FieldsContainers containing the lumped mass

<a id="output_3"></a>

### model\_data (Pin 3)

- **Expected type(s):** [`property_field`](../../core-concepts/dpf-types.md#property-field)

data describing the finite element model

<a id="output_4"></a>

### center\_of\_mass (Pin 4)

- **Expected type(s):** [`property_field`](../../core-concepts/dpf-types.md#property-field)

<a id="output_5"></a>

### inertia\_relief (Pin 5)

- **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field)

inertia matrix

<a id="output_6"></a>

### model\_size (Pin 6)

- **Expected type(s):** [`double`](../../core-concepts/dpf-types.md#standard-types)

size of the model

<a id="output_7"></a>

### field\_coordinates\_and\_euler\_angles (Pin 7)

- **Expected type(s):** [`double`](../../core-concepts/dpf-types.md#standard-types)

coordinates and euler angles of all nodes

<a id="output_8"></a>

### nod (Pin 8)

- **Expected type(s):** [`vector<int32>`](../../core-concepts/dpf-types.md#standard-types)

ids of master nodes

<a id="output_9"></a>

### meshed\_region (Pin 9)

- **Expected type(s):** [`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region)

expanded meshed region.

<a id="output_10"></a>

### phi\_ortho (Pin 10)

- **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container)

Orthonormalized mode shape transformation

## Configurations

This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior.

### [mutex](../../core-concepts/operator-configurations.md#mutex)

- **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types)
- **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**: rom\_data\_provider

**Full name**: result.rom\_data\_provider

**Internal name**: rom\_data\_provider

**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++```cpp
#include "dpf_api.h"

ansys::dpf::Operator op("rom_data_provider"); // operator instantiation
op.connect(0, my_rom_type);
op.connect(1, my_reduced_stiff_matrix);
op.connect(2, my_reduced_damping_matrix);
op.connect(3, my_reduced_mass_matrix);
op.connect(4, my_data_sources);
op.connect(5, my_reduced_rhs_vector);
op.connect(6, my_lumped_mass_matrix);
op.connect(7, my_mode_shapes);
ansys::dpf::FieldsContainer my_rom_matrices = op.getOutput<ansys::dpf::FieldsContainer>(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::PropertyField my_model_data = op.getOutput<ansys::dpf::PropertyField>(3);
ansys::dpf::PropertyField my_center_of_mass = op.getOutput<ansys::dpf::PropertyField>(4);
ansys::dpf::Field my_inertia_relief = op.getOutput<ansys::dpf::Field>(5);
double my_model_size = op.getOutput<double>(6);
double my_field_coordinates_and_euler_angles = op.getOutput<double>(7);
std::vector<int> my_nod = op.getOutput<std::vector<int>>(8);
ansys::dpf::MeshedRegion my_meshed_region = op.getOutput<ansys::dpf::MeshedRegion>(9);
ansys::dpf::FieldsContainer my_phi_ortho = op.getOutput<ansys::dpf::FieldsContainer>(10);

```

CPython```python
import ansys.dpf.core as dpf

op = dpf.operators.result.rom_data_provider() # operator instantiation
op.inputs.rom_type.connect(my_rom_type)
op.inputs.reduced_stiff_matrix.connect(my_reduced_stiff_matrix)
op.inputs.reduced_damping_matrix.connect(my_reduced_damping_matrix)
op.inputs.reduced_mass_matrix.connect(my_reduced_mass_matrix)
op.inputs.data_sources.connect(my_data_sources)
op.inputs.reduced_rhs_vector.connect(my_reduced_rhs_vector)
op.inputs.lumped_mass_matrix.connect(my_lumped_mass_matrix)
op.inputs.mode_shapes.connect(my_mode_shapes)
my_rom_matrices = op.outputs.rom_matrices()
my_mode_shapes = op.outputs.mode_shapes()
my_lumped_mass = op.outputs.lumped_mass()
my_model_data = op.outputs.model_data()
my_center_of_mass = op.outputs.center_of_mass()
my_inertia_relief = op.outputs.inertia_relief()
my_model_size = op.outputs.model_size()
my_field_coordinates_and_euler_angles = op.outputs.field_coordinates_and_euler_angles()
my_nod = op.outputs.nod()
my_meshed_region = op.outputs.meshed_region()
my_phi_ortho = op.outputs.phi_ortho()

```

IPython```python
import mech_dpf
import Ans.DataProcessing as dpf

op = dpf.operators.result.rom_data_provider() # operator instantiation
op.inputs.rom_type.Connect(my_rom_type)
op.inputs.reduced_stiff_matrix.Connect(my_reduced_stiff_matrix)
op.inputs.reduced_damping_matrix.Connect(my_reduced_damping_matrix)
op.inputs.reduced_mass_matrix.Connect(my_reduced_mass_matrix)
op.inputs.data_sources.Connect(my_data_sources)
op.inputs.reduced_rhs_vector.Connect(my_reduced_rhs_vector)
op.inputs.lumped_mass_matrix.Connect(my_lumped_mass_matrix)
op.inputs.mode_shapes.Connect(my_mode_shapes)
my_rom_matrices = op.outputs.rom_matrices.GetData()
my_mode_shapes = op.outputs.mode_shapes.GetData()
my_lumped_mass = op.outputs.lumped_mass.GetData()
my_model_data = op.outputs.model_data.GetData()
my_center_of_mass = op.outputs.center_of_mass.GetData()
my_inertia_relief = op.outputs.inertia_relief.GetData()
my_model_size = op.outputs.model_size.GetData()
my_field_coordinates_and_euler_angles = op.outputs.field_coordinates_and_euler_angles.GetData()
my_nod = op.outputs.nod.GetData()
my_meshed_region = op.outputs.meshed_region.GetData()
my_phi_ortho = op.outputs.phi_ortho.GetData()

```

  
## Changelog

- Version 0.0.0: Initial release.