result:write cms rbd file
Last update: 31.07.2026Version: 0.0.0
Description
Write the invariant terms and the model data in a cms_rbd 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 | center_of_mass | Required | field |
| 2 | inertia_relief | Required | field |
| 3 | model_size | Required | double |
| 4 | master_node_coordinates | Required | vector<double> |
| 5 | v_trsf | Required | vector<double> |
| 6 | k_mat | Required | field |
| 7 | mass_mat | Required | field |
| 8 | c_mat | Required | field |
| 9 | rhs | Required | field |
| 10 | dn | Required | vector<double> |
| 11 | dr_cross_n | Required | vector<double> |
| 12 | drn | Required | vector<double> |
| 13 | dn_cross_n | Required | vector<double> |
| 14 | dnx_y | Required | vector<double> |
| 15 | dny_y | Required | vector<double> |
| 16 | dnz_y | Required | vector<double> |
| 17 | dyx_n | Required | vector<double> |
| 18 | dyy_n | Required | vector<double> |
| 19 | dyz_n | Required | vector<double> |
| 20 | dnxn | Required | vector<double> |
| 21 | dnyn | Required | vector<double> |
| 22 | dnzn | Required | vector<double> |
| 23 | file_path | Required | string |
model_data (Pin 0)
- Required: Yes
- Expected type(s):
property_field
data describing the finite element model
center_of_mass (Pin 1)
- Required: Yes
- Expected type(s):
field
center of mass of the body
inertia_relief (Pin 2)
- Required: Yes
- Expected type(s):
field
inertia matrix
model_size (Pin 3)
- Required: Yes
- Expected type(s):
double
size of the diagonal box containing the body
master_node_coordinates (Pin 4)
- Required: Yes
- Expected type(s):
vector<double>
v_trsf (Pin 5)
- Required: Yes
- Expected type(s):
vector<double>
translational and rotational shape functions
k_mat (Pin 6)
- Required: Yes
- Expected type(s):
field
mass_mat (Pin 7)
- Required: Yes
- Expected type(s):
field
c_mat (Pin 8)
- Required: Yes
- Expected type(s):
field
rhs (Pin 9)
- Required: Yes
- Expected type(s):
field
dn (Pin 10)
- Required: Yes
- Expected type(s):
vector<double>
dr_cross_n (Pin 11)
- Required: Yes
- Expected type(s):
vector<double>
drn (Pin 12)
- Required: Yes
- Expected type(s):
vector<double>
dn_cross_n (Pin 13)
- Required: Yes
- Expected type(s):
vector<double>
dnx_y (Pin 14)
- Required: Yes
- Expected type(s):
vector<double>
dny_y (Pin 15)
- Required: Yes
- Expected type(s):
vector<double>
dnz_y (Pin 16)
- Required: Yes
- Expected type(s):
vector<double>
dyx_n (Pin 17)
- Required: Yes
- Expected type(s):
vector<double>
dyy_n (Pin 18)
- Required: Yes
- Expected type(s):
vector<double>
dyz_n (Pin 19)
- Required: Yes
- Expected type(s):
vector<double>
dnxn (Pin 20)
- Required: Yes
- Expected type(s):
vector<double>
dnyn (Pin 21)
- Required: Yes
- Expected type(s):
vector<double>
dnzn (Pin 22)
- Required: Yes
- Expected type(s):
vector<double>
file_path (Pin 23)
- Required: Yes
- Expected type(s):
string
path with cms_rbd extension where the export occurs
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 | data_sources | data_sources |
data_sources (Pin 0)
- Expected type(s):
data_sources
Data Source containing the cms_rbd 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_cms_rbd_file
Full name: result.write_cms_rbd_file
Internal name: write_cms_rbd_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_cms_rbd_file"); // operator instantiation
op.connect(0, my_model_data);
op.connect(1, my_center_of_mass);
op.connect(2, my_inertia_relief);
op.connect(3, my_model_size);
op.connect(4, my_master_node_coordinates);
op.connect(5, my_v_trsf);
op.connect(6, my_k_mat);
op.connect(7, my_mass_mat);
op.connect(8, my_c_mat);
op.connect(9, my_rhs);
op.connect(10, my_dn);
op.connect(11, my_dr_cross_n);
op.connect(12, my_drn);
op.connect(13, my_dn_cross_n);
op.connect(14, my_dnx_y);
op.connect(15, my_dny_y);
op.connect(16, my_dnz_y);
op.connect(17, my_dyx_n);
op.connect(18, my_dyy_n);
op.connect(19, my_dyz_n);
op.connect(20, my_dnxn);
op.connect(21, my_dnyn);
op.connect(22, my_dnzn);
op.connect(23, my_file_path);
ansys::dpf::DataSources my_data_sources = op.getOutput<ansys::dpf::DataSources>(0);
CPython
import ansys.dpf.core as dpf
op = dpf.operators.result.write_cms_rbd_file() # operator instantiation
op.inputs.model_data.connect(my_model_data)
op.inputs.center_of_mass.connect(my_center_of_mass)
op.inputs.inertia_relief.connect(my_inertia_relief)
op.inputs.model_size.connect(my_model_size)
op.inputs.master_node_coordinates.connect(my_master_node_coordinates)
op.inputs.v_trsf.connect(my_v_trsf)
op.inputs.k_mat.connect(my_k_mat)
op.inputs.mass_mat.connect(my_mass_mat)
op.inputs.c_mat.connect(my_c_mat)
op.inputs.rhs.connect(my_rhs)
op.inputs.dn.connect(my_dn)
op.inputs.dr_cross_n.connect(my_dr_cross_n)
op.inputs.drn.connect(my_drn)
op.inputs.dn_cross_n.connect(my_dn_cross_n)
op.inputs.dnx_y.connect(my_dnx_y)
op.inputs.dny_y.connect(my_dny_y)
op.inputs.dnz_y.connect(my_dnz_y)
op.inputs.dyx_n.connect(my_dyx_n)
op.inputs.dyy_n.connect(my_dyy_n)
op.inputs.dyz_n.connect(my_dyz_n)
op.inputs.dnxn.connect(my_dnxn)
op.inputs.dnyn.connect(my_dnyn)
op.inputs.dnzn.connect(my_dnzn)
op.inputs.file_path.connect(my_file_path)
my_data_sources = op.outputs.data_sources()
IPython
import mech_dpf
import Ans.DataProcessing as dpf
op = dpf.operators.result.write_cms_rbd_file() # operator instantiation
op.inputs.model_data.Connect(my_model_data)
op.inputs.center_of_mass.Connect(my_center_of_mass)
op.inputs.inertia_relief.Connect(my_inertia_relief)
op.inputs.model_size.Connect(my_model_size)
op.inputs.master_node_coordinates.Connect(my_master_node_coordinates)
op.inputs.v_trsf.Connect(my_v_trsf)
op.inputs.k_mat.Connect(my_k_mat)
op.inputs.mass_mat.Connect(my_mass_mat)
op.inputs.c_mat.Connect(my_c_mat)
op.inputs.rhs.Connect(my_rhs)
op.inputs.dn.Connect(my_dn)
op.inputs.dr_cross_n.Connect(my_dr_cross_n)
op.inputs.drn.Connect(my_drn)
op.inputs.dn_cross_n.Connect(my_dn_cross_n)
op.inputs.dnx_y.Connect(my_dnx_y)
op.inputs.dny_y.Connect(my_dny_y)
op.inputs.dnz_y.Connect(my_dnz_y)
op.inputs.dyx_n.Connect(my_dyx_n)
op.inputs.dyy_n.Connect(my_dyy_n)
op.inputs.dyz_n.Connect(my_dyz_n)
op.inputs.dnxn.Connect(my_dnxn)
op.inputs.dnyn.Connect(my_dnyn)
op.inputs.dnzn.Connect(my_dnzn)
op.inputs.file_path.Connect(my_file_path)
my_data_sources = op.outputs.data_sources.GetData()
Changelog
- Version 0.0.0: Initial release.
