## On this page

  

 

 # mesh:beam properties

 Last update: 31.07.2026 

**Version: 0.0.0**

## Description

Reads the beam's properties from the result files contained in the streams or data sources.

## Supported file types

This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver):

- mapdl: rst, rstp

## 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)**3**[streams](#input_3)[`streams_container`](../../core-concepts/dpf-types.md#streams-container)**4**[data\_sources](#input_4)Required[`data_sources`](../../core-concepts/dpf-types.md#data-sources)<a id="input_3"></a>

### streams (Pin 3)

- **Required:** No
- **Expected type(s):** [`streams_container`](../../core-concepts/dpf-types.md#streams-container)

Result file container allowed to be kept open to cache data.

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

### data\_sources (Pin 4)

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

Result file path container, used if no streams are set.

## 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[mesh\_out](#output_0)[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region)**1**[field\_type\_section\_id](#output_1)[`field`](../../core-concepts/dpf-types.md#field)**2**[field\_area](#output_2)[`field`](../../core-concepts/dpf-types.md#field)**3**[field\_moment\_inertia](#output_3)[`field`](../../core-concepts/dpf-types.md#field)**4**[field\_geometry](#output_4)[`field`](../../core-concepts/dpf-types.md#field)**5**[field\_young\_modulus](#output_5)[`field`](../../core-concepts/dpf-types.md#field)**6**[field\_poisson\_ratio](#output_6)[`field`](../../core-concepts/dpf-types.md#field)**7**[field\_shear\_modulus](#output_7)[`field`](../../core-concepts/dpf-types.md#field)**8**[field\_beam\_length](#output_8)[`field`](../../core-concepts/dpf-types.md#field)**9**[field\_torsion\_constant](#output_9)[`field`](../../core-concepts/dpf-types.md#field)**10**[field\_warping\_constant](#output_10)[`field`](../../core-concepts/dpf-types.md#field)**11**[field\_offset\_type](#output_11)[`field`](../../core-concepts/dpf-types.md#field)**12**[field\_offset\_y](#output_12)[`field`](../../core-concepts/dpf-types.md#field)**13**[field\_offset\_z](#output_13)[`field`](../../core-concepts/dpf-types.md#field)<a id="output_0"></a>

### mesh\_out (Pin 0)

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

This mesh updates a new map containing a field of the beam's properties if there is at least one beam in mesh.

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

### field\_type\_section\_id (Pin 1)

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

This field contains the section ID of beams. 1:REC; 3:CSOLID, 4:CTUBE, 5:CHAN, 6:Z, 7:L, 8:I, 9:T, 11:HATS, 12:HREC.

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

### field\_area (Pin 2)

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

This field contains the area of beams.

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

### field\_moment\_inertia (Pin 3)

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

This field contains the inertia moment of beams. Iyy, Iyz, Izz.

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

### field\_geometry (Pin 4)

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

This field contains the geometry of beams. REC:b,h. CSOLID:Ri. CTUBE:Ri, Re. CHAN:w1,w2,w3,t1,t2,t3. Z:w1,w2,w3,t1,t2,t3. L:w1,w2,t1,t2. I:w1,w2,w3,t1,t2,t3. T:w1,w2,t1,t2. HATS: w1,w2,w3,w4,t1,t2,t3,t4. HREC:w1,w2,t1,t2,t3,t4.

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

### field\_young\_modulus (Pin 5)

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

This field contains the Young's modulus of beams.

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

### field\_poisson\_ratio (Pin 6)

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

This field contains the Poisson's ratio of beams.

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

### field\_shear\_modulus (Pin 7)

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

This field contains the Shear Modulus of beams.

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

### field\_beam\_length (Pin 8)

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

This field contains the length of beams.

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

### field\_torsion\_constant (Pin 9)

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

This field contains the Torsion Constant of beams.

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

### field\_warping\_constant (Pin 10)

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

This field contains the Warping Constant of beams.

<a id="output_11"></a>

### field\_offset\_type (Pin 11)

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

This field contains offset type of beams.

<a id="output_12"></a>

### field\_offset\_y (Pin 12)

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

This field contains offset y of beams.

<a id="output_13"></a>

### field\_offset\_z (Pin 13)

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

This field contains offset z of beams.

## 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.

### [num\_threads](../../core-concepts/operator-configurations.md#num_threads)

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

Number of threads to use to run in parallel

### [run\_in\_parallel](../../core-concepts/operator-configurations.md#run_in_parallel)

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

Loops are allowed to run in parallel if the value of this config is set to true.

## Scripting

This operator can be accessed through scripting interfaces using these identifiers.

**Category**: mesh

**Plugin**: core

**Scripting name**: beam\_properties

**Full name**: mesh.beam\_properties

**Internal name**: beam\_properties

**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("beam_properties"); // operator instantiation
op.connect(3, my_streams);
op.connect(4, my_data_sources);
ansys::dpf::MeshedRegion my_mesh_out = op.getOutput<ansys::dpf::MeshedRegion>(0);
ansys::dpf::Field my_field_type_section_id = op.getOutput<ansys::dpf::Field>(1);
ansys::dpf::Field my_field_area = op.getOutput<ansys::dpf::Field>(2);
ansys::dpf::Field my_field_moment_inertia = op.getOutput<ansys::dpf::Field>(3);
ansys::dpf::Field my_field_geometry = op.getOutput<ansys::dpf::Field>(4);
ansys::dpf::Field my_field_young_modulus = op.getOutput<ansys::dpf::Field>(5);
ansys::dpf::Field my_field_poisson_ratio = op.getOutput<ansys::dpf::Field>(6);
ansys::dpf::Field my_field_shear_modulus = op.getOutput<ansys::dpf::Field>(7);
ansys::dpf::Field my_field_beam_length = op.getOutput<ansys::dpf::Field>(8);
ansys::dpf::Field my_field_torsion_constant = op.getOutput<ansys::dpf::Field>(9);
ansys::dpf::Field my_field_warping_constant = op.getOutput<ansys::dpf::Field>(10);
ansys::dpf::Field my_field_offset_type = op.getOutput<ansys::dpf::Field>(11);
ansys::dpf::Field my_field_offset_y = op.getOutput<ansys::dpf::Field>(12);
ansys::dpf::Field my_field_offset_z = op.getOutput<ansys::dpf::Field>(13);

```

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

op = dpf.operators.mesh.beam_properties() # operator instantiation
op.inputs.streams.connect(my_streams)
op.inputs.data_sources.connect(my_data_sources)
my_mesh_out = op.outputs.mesh_out()
my_field_type_section_id = op.outputs.field_type_section_id()
my_field_area = op.outputs.field_area()
my_field_moment_inertia = op.outputs.field_moment_inertia()
my_field_geometry = op.outputs.field_geometry()
my_field_young_modulus = op.outputs.field_young_modulus()
my_field_poisson_ratio = op.outputs.field_poisson_ratio()
my_field_shear_modulus = op.outputs.field_shear_modulus()
my_field_beam_length = op.outputs.field_beam_length()
my_field_torsion_constant = op.outputs.field_torsion_constant()
my_field_warping_constant = op.outputs.field_warping_constant()
my_field_offset_type = op.outputs.field_offset_type()
my_field_offset_y = op.outputs.field_offset_y()
my_field_offset_z = op.outputs.field_offset_z()

```

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

op = dpf.operators.mesh.beam_properties() # operator instantiation
op.inputs.streams.Connect(my_streams)
op.inputs.data_sources.Connect(my_data_sources)
my_mesh_out = op.outputs.mesh_out.GetData()
my_field_type_section_id = op.outputs.field_type_section_id.GetData()
my_field_area = op.outputs.field_area.GetData()
my_field_moment_inertia = op.outputs.field_moment_inertia.GetData()
my_field_geometry = op.outputs.field_geometry.GetData()
my_field_young_modulus = op.outputs.field_young_modulus.GetData()
my_field_poisson_ratio = op.outputs.field_poisson_ratio.GetData()
my_field_shear_modulus = op.outputs.field_shear_modulus.GetData()
my_field_beam_length = op.outputs.field_beam_length.GetData()
my_field_torsion_constant = op.outputs.field_torsion_constant.GetData()
my_field_warping_constant = op.outputs.field_warping_constant.GetData()
my_field_offset_type = op.outputs.field_offset_type.GetData()
my_field_offset_y = op.outputs.field_offset_y.GetData()
my_field_offset_z = op.outputs.field_offset_z.GetData()

```

  
## Changelog

- Version 0.0.0: Initial release.