result:cms subfile info provider
Last update: 31.07.2026Version: 0.0.0
Description
Read required information from a subfile.
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) |
|---|---|---|---|
| 4 | data_sources | Required | data_sources |
| 200 | cms_subfile_data | Required | bool |
| 300 | output_maxdof_on_masternodes | bool |
data_sources (Pin 4)
- Required: Yes
- Expected type(s):
data_sources
Data_sources (must contain at least one subfile).
cms_subfile_data (Pin 200)
- Required: Yes
- Expected type(s):
bool
If this pin i set to true, data are return in a field.
output_maxdof_on_masternodes (Pin 300)
- Required: No
- Expected type(s):
bool
If this pin is set to true, compute and add field with max degrees of freedom on master nodes
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 | int32 | int32 |
| 1 | field | property_field |
int32 (Pin 0)
- Expected type(s):
int32
returns integer values in the order : unit system used, stiffness matrix present key, damping matrix present key, mass matrix present key, number of master nodes, number of virtual nodes
field (Pin 1)
- Expected type(s):
property_field
returns integer values in the order : number of load vectors (nvects), number of nodes (nnod), number of virtual nodes (nvnodes), number of modes (nvmodes)
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: mapdl
Scripting name: cms_subfile_info_provider
Full name: result.cms_subfile_info_provider
Internal name: cms_subfile_info_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("cms_subfile_info_provider"); // operator instantiation
op.connect(4, my_data_sources);
op.connect(200, my_cms_subfile_data);
op.connect(300, my_output_maxdof_on_masternodes);
int my_int32 = op.getOutput<int>(0);
ansys::dpf::PropertyField my_field = op.getOutput<ansys::dpf::PropertyField>(1);
CPython
import ansys.dpf.core as dpf
op = dpf.operators.result.cms_subfile_info_provider() # operator instantiation
op.inputs.data_sources.connect(my_data_sources)
op.inputs.cms_subfile_data.connect(my_cms_subfile_data)
op.inputs.output_maxdof_on_masternodes.connect(my_output_maxdof_on_masternodes)
my_int32 = op.outputs.int32()
my_field = op.outputs.field()
IPython
import mech_dpf
import Ans.DataProcessing as dpf
op = dpf.operators.result.cms_subfile_info_provider() # operator instantiation
op.inputs.data_sources.Connect(my_data_sources)
op.inputs.cms_subfile_data.Connect(my_cms_subfile_data)
op.inputs.output_maxdof_on_masternodes.Connect(my_output_maxdof_on_masternodes)
my_int32 = op.outputs.int32.GetData()
my_field = op.outputs.field.GetData()
Changelog
- Version 0.0.0: Initial release.