result:rom data provider
Last update: 31.07.2026Version: 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_type | Required | bool |
| 1 | reduced_stiff_matrix | Required | fields_container |
| 2 | reduced_damping_matrix | Required | fields_container |
| 3 | reduced_mass_matrix | Required | fields_container |
| 4 | data_sources | Required | data_sources |
| 5 | reduced_rhs_vector | Required | fields_container |
| 6 | lumped_mass_matrix | Required | fields_container |
| 7 | mode_shapes | Required | fields_container |
rom_type (Pin 0)
- Required: Yes
- Expected type(s):
bool
If this pin is set to true, customized rom data must be given
reduced_stiff_matrix (Pin 1)
- Required: Yes
- Expected type(s):
fields_container
FieldsContainers containing the reduced Stiffness matrix
reduced_damping_matrix (Pin 2)
- Required: Yes
- Expected type(s):
fields_container
FieldsContainers containing the reduced Mass matrix
reduced_mass_matrix (Pin 3)
- Required: Yes
- Expected type(s):
fields_container
FieldsContainers containing the reduced Damp matrix
data_sources (Pin 4)
- Required: Yes
- Expected type(s):
data_sources
reduced_rhs_vector (Pin 5)
- Required: Yes
- Expected type(s):
fields_container
FieldsContainers containing the reduced RHS vector
lumped_mass_matrix (Pin 6)
- Required: Yes
- Expected type(s):
fields_container
FieldsContainers containing the lumped Mass matrix
mode_shapes (Pin 7)
- Required: Yes
- Expected type(s):
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 number | Name | Expected type(s) |
|---|---|---|
| 0 | rom_matrices | fields_container |
| 1 | mode_shapes | fields_container |
| 2 | lumped_mass | fields_container |
| 3 | model_data | property_field |
| 4 | center_of_mass | property_field |
| 5 | inertia_relief | field |
| 6 | model_size | double |
| 7 | field_coordinates_and_euler_angles | double |
| 8 | nod | vector<int32> |
| 9 | meshed_region | abstract_meshed_region |
| 10 | phi_ortho | fields_container |
rom_matrices (Pin 0)
- Expected type(s):
fields_container
FieldsContainers containing the reduced matrices
mode_shapes (Pin 1)
- Expected type(s):
fields_container
FieldsContainers containing the mode shapes, which are CST and NOR for the cms method
lumped_mass (Pin 2)
- Expected type(s):
fields_container
FieldsContainers containing the lumped mass
model_data (Pin 3)
- Expected type(s):
property_field
data describing the finite element model
center_of_mass (Pin 4)
- Expected type(s):
property_field
inertia_relief (Pin 5)
- Expected type(s):
field
inertia matrix
model_size (Pin 6)
- Expected type(s):
double
size of the model
field_coordinates_and_euler_angles (Pin 7)
- Expected type(s):
double
coordinates and euler angles of all nodes
nod (Pin 8)
- Expected type(s):
vector<int32>
ids of master nodes
meshed_region (Pin 9)
- Expected type(s):
abstract_meshed_region
expanded meshed region.
phi_ortho (Pin 10)
- Expected type(s):
fields_container
Orthonormalized mode shape transformation
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: 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++
#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
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
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.
