workflow_energy_per_component#

Autogenerated DPF operator classes.

class ansys.dpf.core.operators.result.workflow_energy_per_component.workflow_energy_per_component(time_scoping=None, mesh_scoping=None, energy_type=None, data_sources=None, named_selection1=None, named_selection2=None, config=None, server=None)#

Calculates the cumulated energy per component (Named Selection). For cyclic and multistage models, the expansion will be automatically done.

Parameters:

time_scoping (Scoping, optional) –
mesh_scoping (Scoping or ScopingsContainer, optional) – When the input is a scoping, it is treated as the master scoping. all named selections will intersect with it. when the input is a scopings container, named selections will not be needed.
energy_type (int, optional) – Type of energy to be processed: (0: strain + kinetic energy (default), 1: strain energy, 2: kinetic energy, 3: all energy types)
data_sources (DataSources) –
named_selection1 (str, optional) – Named selections. intersection of all named selections with the master scoping will be done.
named_selection2 (str, optional) – Named selections. intersection of all named selections with the master scoping will be done.

Returns:

component_energy (FieldsContainer)
component_energy_percentage (FieldsContainer)
component_total_energy (FieldsContainer, optional)
component_total_energy_percentage (FieldsContainer, optional)
component_strain_energy (FieldsContainer, optional)
component_strain_energy_percentage (FieldsContainer, optional)
component_kinetic_energy (FieldsContainer, optional)
component_kinetic_energy_percentage (FieldsContainer, optional)

Examples

>>> from ansys.dpf import core as dpf

>>> # Instantiate operator
>>> op = dpf.operators.result.workflow_energy_per_component()

>>> # Make input connections
>>> my_time_scoping = dpf.Scoping()
>>> op.inputs.time_scoping.connect(my_time_scoping)
>>> my_mesh_scoping = dpf.Scoping()
>>> op.inputs.mesh_scoping.connect(my_mesh_scoping)
>>> my_energy_type = int()
>>> op.inputs.energy_type.connect(my_energy_type)
>>> my_data_sources = dpf.DataSources()
>>> op.inputs.data_sources.connect(my_data_sources)
>>> my_named_selection1 = str()
>>> op.inputs.named_selection1.connect(my_named_selection1)
>>> my_named_selection2 = str()
>>> op.inputs.named_selection2.connect(my_named_selection2)

>>> # Instantiate operator and connect inputs in one line
>>> op = dpf.operators.result.workflow_energy_per_component(
...     time_scoping=my_time_scoping,
...     mesh_scoping=my_mesh_scoping,
...     energy_type=my_energy_type,
...     data_sources=my_data_sources,
...     named_selection1=my_named_selection1,
...     named_selection2=my_named_selection2,
... )

>>> # Get output data
>>> result_component_energy = op.outputs.component_energy()
>>> result_component_energy_percentage = op.outputs.component_energy_percentage()
>>> result_component_total_energy = op.outputs.component_total_energy()
>>> result_component_total_energy_percentage = op.outputs.component_total_energy_percentage()
>>> result_component_strain_energy = op.outputs.component_strain_energy()
>>> result_component_strain_energy_percentage = op.outputs.component_strain_energy_percentage()
>>> result_component_kinetic_energy = op.outputs.component_kinetic_energy()
>>> result_component_kinetic_energy_percentage = op.outputs.component_kinetic_energy_percentage()

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:: InputsWorkflowEnergyPerComponent

property outputs#

Enables to get outputs of the operator by evaluating it

Returns:: outputs
Return type:: OutputsWorkflowEnergyPerComponent

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.result.workflow_energy_per_component.InputsWorkflowEnergyPerComponent(op: ansys.dpf.core.dpf_operator.Operator)#

Intermediate class used to connect user inputs to workflow_energy_per_component operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.workflow_energy_per_component()
>>> my_time_scoping = dpf.Scoping()
>>> op.inputs.time_scoping.connect(my_time_scoping)
>>> my_mesh_scoping = dpf.Scoping()
>>> op.inputs.mesh_scoping.connect(my_mesh_scoping)
>>> my_energy_type = int()
>>> op.inputs.energy_type.connect(my_energy_type)
>>> my_data_sources = dpf.DataSources()
>>> op.inputs.data_sources.connect(my_data_sources)
>>> my_named_selection1 = str()
>>> op.inputs.named_selection1.connect(my_named_selection1)
>>> my_named_selection2 = str()
>>> op.inputs.named_selection2.connect(my_named_selection2)

property time_scoping#

Allows to connect time_scoping input to the operator.

Parameters:: my_time_scoping (Scoping) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.workflow_energy_per_component()
>>> op.inputs.time_scoping.connect(my_time_scoping)
>>> # or
>>> op.inputs.time_scoping(my_time_scoping)

property mesh_scoping#

Allows to connect mesh_scoping input to the operator.

When the input is a scoping, it is treated as the master scoping. all named selections will intersect with it. when the input is a scopings container, named selections will not be needed.

Parameters:: my_mesh_scoping (Scoping or ScopingsContainer) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.workflow_energy_per_component()
>>> op.inputs.mesh_scoping.connect(my_mesh_scoping)
>>> # or
>>> op.inputs.mesh_scoping(my_mesh_scoping)

property energy_type#

Allows to connect energy_type input to the operator.

Type of energy to be processed: (0: strain + kinetic energy (default), 1: strain energy, 2: kinetic energy, 3: all energy types)

Parameters:: my_energy_type (int) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.workflow_energy_per_component()
>>> op.inputs.energy_type.connect(my_energy_type)
>>> # or
>>> op.inputs.energy_type(my_energy_type)

property data_sources#

Allows to connect data_sources input to the operator.

Parameters:: my_data_sources (DataSources) –

Examples

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

property named_selection1#

Allows to connect named_selection1 input to the operator.

Named selections. intersection of all named selections with the master scoping will be done.

Parameters:: my_named_selection1 (str) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.workflow_energy_per_component()
>>> op.inputs.named_selection1.connect(my_named_selection1)
>>> # or
>>> op.inputs.named_selection1(my_named_selection1)

property named_selection2#

Allows to connect named_selection2 input to the operator.

Named selections. intersection of all named selections with the master scoping will be done.

Parameters:: my_named_selection2 (str) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.workflow_energy_per_component()
>>> op.inputs.named_selection2.connect(my_named_selection2)
>>> # or
>>> op.inputs.named_selection2(my_named_selection2)

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.result.workflow_energy_per_component.OutputsWorkflowEnergyPerComponent(op: ansys.dpf.core.dpf_operator.Operator)#

Intermediate class used to get outputs from workflow_energy_per_component operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.workflow_energy_per_component()
>>> # Connect inputs : op.inputs. ...
>>> result_component_energy = op.outputs.component_energy()
>>> result_component_energy_percentage = op.outputs.component_energy_percentage()
>>> result_component_total_energy = op.outputs.component_total_energy()
>>> result_component_total_energy_percentage = op.outputs.component_total_energy_percentage()
>>> result_component_strain_energy = op.outputs.component_strain_energy()
>>> result_component_strain_energy_percentage = op.outputs.component_strain_energy_percentage()
>>> result_component_kinetic_energy = op.outputs.component_kinetic_energy()
>>> result_component_kinetic_energy_percentage = op.outputs.component_kinetic_energy_percentage()

property component_energy#

Allows to get component_energy output of the operator

Returns:: my_component_energy
Return type:: FieldsContainer

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.workflow_energy_per_component()
>>> # Connect inputs : op.inputs. ...
>>> result_component_energy = op.outputs.component_energy()

property component_energy_percentage#

Allows to get component_energy_percentage output of the operator

Returns:: my_component_energy_percentage
Return type:: FieldsContainer

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.workflow_energy_per_component()
>>> # Connect inputs : op.inputs. ...
>>> result_component_energy_percentage = op.outputs.component_energy_percentage()

property component_total_energy#

Allows to get component_total_energy output of the operator

Returns:: my_component_total_energy
Return type:: FieldsContainer

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.workflow_energy_per_component()
>>> # Connect inputs : op.inputs. ...
>>> result_component_total_energy = op.outputs.component_total_energy()

property component_total_energy_percentage#

Allows to get component_total_energy_percentage output of the operator

Returns:: my_component_total_energy_percentage
Return type:: FieldsContainer

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.workflow_energy_per_component()
>>> # Connect inputs : op.inputs. ...
>>> result_component_total_energy_percentage = op.outputs.component_total_energy_percentage()

property component_strain_energy#

Allows to get component_strain_energy output of the operator

Returns:: my_component_strain_energy
Return type:: FieldsContainer

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.workflow_energy_per_component()
>>> # Connect inputs : op.inputs. ...
>>> result_component_strain_energy = op.outputs.component_strain_energy()

property component_strain_energy_percentage#

Allows to get component_strain_energy_percentage output of the operator

Returns:: my_component_strain_energy_percentage
Return type:: FieldsContainer

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.workflow_energy_per_component()
>>> # Connect inputs : op.inputs. ...
>>> result_component_strain_energy_percentage = op.outputs.component_strain_energy_percentage()

property component_kinetic_energy#

Allows to get component_kinetic_energy output of the operator

Returns:: my_component_kinetic_energy
Return type:: FieldsContainer

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.workflow_energy_per_component()
>>> # Connect inputs : op.inputs. ...
>>> result_component_kinetic_energy = op.outputs.component_kinetic_energy()

property component_kinetic_energy_percentage#

Allows to get component_kinetic_energy_percentage output of the operator

Returns:: my_component_kinetic_energy_percentage
Return type:: FieldsContainer

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.workflow_energy_per_component()
>>> # Connect inputs : op.inputs. ...
>>> result_component_kinetic_energy_percentage = op.outputs.component_kinetic_energy_percentage()