beam_properties#

Autogenerated DPF operator classes.

class ansys.dpf.core.operators.mesh.beam_properties.beam_properties(streams=None, data_sources=None, config=None, server=None)#

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

Parameters:

streams (StreamsContainer, optional) – Result file container allowed to be kept open to cache data.
data_sources (DataSources) – Result file path container, used if no streams are set.

Examples

>>> from ansys.dpf import core as dpf

>>> # Instantiate operator
>>> op = dpf.operators.mesh.beam_properties()

>>> # Make input connections
>>> my_streams = dpf.StreamsContainer()
>>> op.inputs.streams.connect(my_streams)
>>> my_data_sources = dpf.DataSources()
>>> op.inputs.data_sources.connect(my_data_sources)

>>> # Instantiate operator and connect inputs in one line
>>> op = dpf.operators.mesh.beam_properties(
...     streams=my_streams,
...     data_sources=my_data_sources,
... )

>>> # Get output data
>>> result_mesh_out = op.outputs.mesh_out()
>>> result_field_type_section_id = op.outputs.field_type_section_id()
>>> result_field_area = op.outputs.field_area()
>>> result_field_moment_inertia = op.outputs.field_moment_inertia()
>>> result_field_geometry = op.outputs.field_geometry()
>>> result_field_young_modulus = op.outputs.field_young_modulus()
>>> result_field_poisson_ratio = op.outputs.field_poisson_ratio()
>>> result_field_shear_modulus = op.outputs.field_shear_modulus()
>>> result_field_beam_length = op.outputs.field_beam_length()
>>> result_field_torsion_constant = op.outputs.field_torsion_constant()
>>> result_field_warping_constant = op.outputs.field_warping_constant()
>>> result_field_offset_type = op.outputs.field_offset_type()
>>> result_field_offset_y = op.outputs.field_offset_y()
>>> result_field_offset_z = op.outputs.field_offset_z()

static default_config(server=None)#

Returns the default config of the operator.

This config can then be changed to the user needs and be used to instantiate the operator. The Configuration allows to customize how the operation will be processed by the operator.

Parameters:: server (server.DPFServer, optional) – Server with channel connected to the remote or local instance. When None, attempts to use the global server.

property inputs#

Enables to connect inputs to the operator

Returns:: inputs
Return type:: InputsBeamProperties

property outputs#

Enables to get outputs of the operator by evaluating it

Returns:: outputs
Return type:: OutputsBeamProperties

property config#

Copy of the operator’s current configuration.

You can modify the copy of the configuration and then use operator.config = new_config or instantiate an operator with the new configuration as a parameter.

For information on an operator’s options, see the documentation for that operator.

Returns:: Copy of the operator’s current configuration.
Return type:: ansys.dpf.core.config.Config

Examples

Modify the copy of an operator’s configuration and set it as current config of the operator.

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.math.add()
>>> config_add = op.config
>>> config_add.set_work_by_index_option(True)
>>> op.config = config_add

connect(pin, inpt, pin_out=0)#

Connect an input on the operator using a pin number.

Parameters:

pin (int) – Number of the input pin.
inpt (str, int, double, bool, list[int], list[float], Field, FieldsContainer, Scoping,) –
ScopingsContainer – Operator, os.PathLike Object to connect to.
MeshedRegion – Operator, os.PathLike Object to connect to.
MeshesContainer – Operator, os.PathLike Object to connect to.
DataSources – Operator, os.PathLike Object to connect to.
CyclicSupport – Operator, os.PathLike Object to connect to.
dict – Operator, os.PathLike Object to connect to.
Outputs – Operator, os.PathLike Object to connect to.
pin_out (int, optional) – If the input is an operator, the output pin of the input operator. The default is 0.

Examples

Compute the minimum of displacement by chaining the "U" and "min_max_fc" operators.

>>> from ansys.dpf import core as dpf
>>> from ansys.dpf.core import examples
>>> data_src = dpf.DataSources(examples.find_multishells_rst())
>>> disp_op = dpf.operators.result.displacement()
>>> disp_op.inputs.data_sources(data_src)
>>> max_fc_op = dpf.operators.min_max.min_max_fc()
>>> max_fc_op.inputs.connect(disp_op.outputs)
>>> max_field = max_fc_op.outputs.field_max()
>>> max_field.data
DPFArray([[0.59428386, 0.00201751, 0.0006032 ]]...

connect_operator_as_input(pin, op)#: Connects an operator as an input on a pin. :type pin: :param pin: Number of the output pin. The default is 0. :type pin: int :type op: :param op: Requested type of the output. The default is None. :type op: ansys.dpf.core.dpf_operator.Operator

eval(pin=None)#

Evaluate this operator.

Parameters:: pin (int) – Number of the output pin. The default is None.
Returns:: output – Returns the first output of the operator by default and the output of a given pin when specified. Or, it only evaluates the operator without output.
Return type:: FieldsContainer, Field, MeshedRegion, Scoping

Examples

Use the eval method.

>>> from ansys.dpf import core as dpf
>>> import ansys.dpf.core.operators.math as math
>>> from ansys.dpf.core import examples
>>> data_src = dpf.DataSources(examples.find_multishells_rst())
>>> disp_op = dpf.operators.result.displacement()
>>> disp_op.inputs.data_sources(data_src)
>>> normfc = math.norm_fc(disp_op).eval()

get_output(pin=0, output_type=None)#

Retrieve the output of the operator on the pin number.

To activate the progress bar for server version higher or equal to 3.0, use my_op.progress_bar=True

Parameters:

pin (int, optional) – Number of the output pin. The default is 0.
output_type (ansys.dpf.core.common.types, type, optional) – Requested type of the output. The default is None.

Returns:

Output of the operator.

Return type:

type

static operator_specification(op_name, server=None)#: Documents an Operator with its description (what the Operator does), its inputs and outputs and some properties

property progress_bar: bool#: With this property, the user can choose to print a progress bar when the operator’s output is requested, default is False

run()#: Evaluate this operator.

property specification#

Returns the Specification (or documentation) of this Operator

Return type:: Specification

class ansys.dpf.core.operators.mesh.beam_properties.InputsBeamProperties(op: ansys.dpf.core.dpf_operator.Operator)#

Intermediate class used to connect user inputs to beam_properties operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.beam_properties()
>>> my_streams = dpf.StreamsContainer()
>>> op.inputs.streams.connect(my_streams)
>>> my_data_sources = dpf.DataSources()
>>> op.inputs.data_sources.connect(my_data_sources)

property streams#

Allows to connect streams input to the operator.

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

Parameters:: my_streams (StreamsContainer) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.beam_properties()
>>> op.inputs.streams.connect(my_streams)
>>> # or
>>> op.inputs.streams(my_streams)

property data_sources#

Allows to connect data_sources input to the operator.

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

Parameters:: my_data_sources (DataSources) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.beam_properties()
>>> op.inputs.data_sources.connect(my_data_sources)
>>> # or
>>> op.inputs.data_sources(my_data_sources)

connect(inpt)#

Connect any input (an entity or an operator output) to any input pin of this operator. Searches for the input type corresponding to the output.

Parameters:

inpt (str, int, double, bool, list[int], list[float], Field, FieldsContainer, Scoping,) –
ScopingsContainer (E501) – Input of the operator.
MeshedRegion (E501) – Input of the operator.
MeshesContainer (E501) – Input of the operator.
DataSources (E501) – Input of the operator.
CyclicSupport (E501) – Input of the operator.
Outputs (E501) – Input of the operator.
noqa (os.PathLike #) – Input of the operator.

class ansys.dpf.core.operators.mesh.beam_properties.OutputsBeamProperties(op: ansys.dpf.core.dpf_operator.Operator)#

Intermediate class used to get outputs from beam_properties operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.beam_properties()
>>> # Connect inputs : op.inputs. ...
>>> result_mesh_out = op.outputs.mesh_out()
>>> result_field_type_section_id = op.outputs.field_type_section_id()
>>> result_field_area = op.outputs.field_area()
>>> result_field_moment_inertia = op.outputs.field_moment_inertia()
>>> result_field_geometry = op.outputs.field_geometry()
>>> result_field_young_modulus = op.outputs.field_young_modulus()
>>> result_field_poisson_ratio = op.outputs.field_poisson_ratio()
>>> result_field_shear_modulus = op.outputs.field_shear_modulus()
>>> result_field_beam_length = op.outputs.field_beam_length()
>>> result_field_torsion_constant = op.outputs.field_torsion_constant()
>>> result_field_warping_constant = op.outputs.field_warping_constant()
>>> result_field_offset_type = op.outputs.field_offset_type()
>>> result_field_offset_y = op.outputs.field_offset_y()
>>> result_field_offset_z = op.outputs.field_offset_z()

property mesh_out#

Allows to get mesh_out output of the operator

Returns:: my_mesh_out
Return type:: MeshedRegion

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.beam_properties()
>>> # Connect inputs : op.inputs. ...
>>> result_mesh_out = op.outputs.mesh_out()

property field_type_section_id#

Allows to get field_type_section_id output of the operator

Returns:: my_field_type_section_id
Return type:: Field

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.beam_properties()
>>> # Connect inputs : op.inputs. ...
>>> result_field_type_section_id = op.outputs.field_type_section_id()

property field_area#

Allows to get field_area output of the operator

Returns:: my_field_area
Return type:: Field

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.beam_properties()
>>> # Connect inputs : op.inputs. ...
>>> result_field_area = op.outputs.field_area()

property field_moment_inertia#

Allows to get field_moment_inertia output of the operator

Returns:: my_field_moment_inertia
Return type:: Field

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.beam_properties()
>>> # Connect inputs : op.inputs. ...
>>> result_field_moment_inertia = op.outputs.field_moment_inertia()

property field_geometry#

Allows to get field_geometry output of the operator

Returns:: my_field_geometry
Return type:: Field

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.beam_properties()
>>> # Connect inputs : op.inputs. ...
>>> result_field_geometry = op.outputs.field_geometry()

property field_young_modulus#

Allows to get field_young_modulus output of the operator

Returns:: my_field_young_modulus
Return type:: Field

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.beam_properties()
>>> # Connect inputs : op.inputs. ...
>>> result_field_young_modulus = op.outputs.field_young_modulus()

property field_poisson_ratio#

Allows to get field_poisson_ratio output of the operator

Returns:: my_field_poisson_ratio
Return type:: Field

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.beam_properties()
>>> # Connect inputs : op.inputs. ...
>>> result_field_poisson_ratio = op.outputs.field_poisson_ratio()

property field_shear_modulus#

Allows to get field_shear_modulus output of the operator

Returns:: my_field_shear_modulus
Return type:: Field

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.beam_properties()
>>> # Connect inputs : op.inputs. ...
>>> result_field_shear_modulus = op.outputs.field_shear_modulus()

property field_beam_length#

Allows to get field_beam_length output of the operator

Returns:: my_field_beam_length
Return type:: Field

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.beam_properties()
>>> # Connect inputs : op.inputs. ...
>>> result_field_beam_length = op.outputs.field_beam_length()

property field_torsion_constant#

Allows to get field_torsion_constant output of the operator

Returns:: my_field_torsion_constant
Return type:: Field

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.beam_properties()
>>> # Connect inputs : op.inputs. ...
>>> result_field_torsion_constant = op.outputs.field_torsion_constant()

property field_warping_constant#

Allows to get field_warping_constant output of the operator

Returns:: my_field_warping_constant
Return type:: Field

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.beam_properties()
>>> # Connect inputs : op.inputs. ...
>>> result_field_warping_constant = op.outputs.field_warping_constant()

property field_offset_type#

Allows to get field_offset_type output of the operator

Returns:: my_field_offset_type
Return type:: Field

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.beam_properties()
>>> # Connect inputs : op.inputs. ...
>>> result_field_offset_type = op.outputs.field_offset_type()

property field_offset_y#

Allows to get field_offset_y output of the operator

Returns:: my_field_offset_y
Return type:: Field

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.beam_properties()
>>> # Connect inputs : op.inputs. ...
>>> result_field_offset_y = op.outputs.field_offset_y()

property field_offset_z#

Allows to get field_offset_z output of the operator

Returns:: my_field_offset_z
Return type:: Field

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.beam_properties()
>>> # Connect inputs : op.inputs. ...
>>> result_field_offset_z = op.outputs.field_offset_z()