`compute_total_strain_2`#

class ansys.dpf.core.operators.result.compute_total_strain_2.compute_total_strain_2(time_scoping=None, scoping=None, streams_container=None, data_sources=None, extrapolate=None, nonlinear=None, abstract_meshed_region=None, requested_location=None, displacement=None, config=None, server=None)#

Bases: ansys.dpf.core.dpf_operator.Operator

Computes the strain from a displacement field. Only SOLID185 (B-Bar, Simplified Enhanced Strain, Enhanced Strain formulations), SOLID186 (Full Integration) & SOLID187 elements are supported. Layered elements are not supported. Thermal strains are not supported. Only one value of material properties are allowed per element for isotropic and orthotropic elasticity. Material nonlinearity is not supported Only linear analysis are supported without On Demand Expansion. All coordinates are global coordinates. Euler Angles need to be included in the database. Get the 2nd principal component.

Inputs#

time_scoping: Scoping or int or float or Field, optional: time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on “TimeFreq_steps”. Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1.. Will only be used if no displacement input is given (will be applied on displacement operator).
scoping: Scoping, optional: The element scoping on which the result is computed.
streams_container: StreamsContainer, optional: Optional if a mesh or a data_sources have been connected. Required if no displacement input have been connected.
data_sources: DataSources: Optional if a mesh or a streams_container have been connected, or if the displacement’s field has a mesh support. Required if no displacement input have been connected.
extrapolate: int, optional: Whether to extrapolate the data from the integration points to the nodes.
nonlinear: int, optional: Whether to use nonlinear geometry or nonlinear material (1 = large strain, 2 = hyperelasticity).
abstract_meshed_region: MeshedRegion, optional: The underlying mesh. Optional if a data_sources or a streams_container have been connected, or if the displacement’s field has a mesh support.
requested_location: str, optional: Average the Elemental Nodal result to the requested location.
displacement: FieldsContainer or Field, optional: Field/or fields container containing only the displacement field (nodal). If none specified, read displacements from result file using the data_sources.

Outputs#

fields_container: FieldsContainer: The computed result fields container (elemental nodal).

Examples

>>> from ansys.dpf import core as dpf

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

>>> # Make input connections
>>> my_time_scoping = dpf.Scoping()
>>> op.inputs.time_scoping.connect(my_time_scoping)
>>> my_scoping = dpf.Scoping()
>>> op.inputs.scoping.connect(my_scoping)
>>> my_streams_container = dpf.StreamsContainer()
>>> op.inputs.streams_container.connect(my_streams_container)
>>> my_data_sources = dpf.DataSources()
>>> op.inputs.data_sources.connect(my_data_sources)
>>> my_extrapolate = int()
>>> op.inputs.extrapolate.connect(my_extrapolate)
>>> my_nonlinear = int()
>>> op.inputs.nonlinear.connect(my_nonlinear)
>>> my_abstract_meshed_region = dpf.MeshedRegion()
>>> op.inputs.abstract_meshed_region.connect(my_abstract_meshed_region)
>>> my_requested_location = str()
>>> op.inputs.requested_location.connect(my_requested_location)
>>> my_displacement = dpf.FieldsContainer()
>>> op.inputs.displacement.connect(my_displacement)

>>> # Instantiate operator and connect inputs in one line
>>> op = dpf.operators.result.compute_total_strain_2(
...     time_scoping=my_time_scoping,
...     scoping=my_scoping,
...     streams_container=my_streams_container,
...     data_sources=my_data_sources,
...     extrapolate=my_extrapolate,
...     nonlinear=my_nonlinear,
...     abstract_meshed_region=my_abstract_meshed_region,
...     requested_location=my_requested_location,
...     displacement=my_displacement,
... )

>>> # Get output data
>>> result_fields_container = op.outputs.fields_container()

Overview#

Methods

`connect`	Connect an input on the operator using a pin number.
`connect_operator_as_input`	Connect an operator as an input on a pin.
`get_output`	Retrieve the output of the operator on the pin number.
`run`	Evaluate this operator.
`eval`	Evaluate this operator.

Properties

`inputs`	Enables to connect inputs to the operator
`outputs`	Enables to get outputs of the operator by evaluating it
`progress_bar`	Enable or disable progress bar display when requesting the operator’s output.
`config`	Copy of the operator’s current configuration.
`id`	Retrieve the unique identifier of the operator.
`specification`	Returns the Specification (or documentation) of this Operator.
`changelog`	Return the changelog of this operator.
`version`	Return the current version of the operator.

Attributes

name

Static methods

`default_config`	Returns the default config of the operator.
`operator_specification`	Documents an Operator with its description (what the Operator does),its inputs and outputs and some properties.

Special methods

`__del__`	Delete this instance.
`__str__`	Describe the entity.
`__add__`	Add two fields or two fields containers.
`__sub__`	Subtract two fields or two fields containers.
`__pow__`	Raise each element of a field or a fields container to power 2.
`__mul__`	Multiply two fields or two fields containers.
`__truediv__`	Perform division with another operator or a scalar.

Import detail#

from ansys.dpf.core.operators.result.compute_total_strain_2 import compute_total_strain_2

Property detail#

property compute_total_strain_2.inputs: InputsComputeTotalStrain2#

Enables to connect inputs to the operator

Returns:: An instance of InputsComputeTotalStrain2.
Return type:: inputs

property compute_total_strain_2.outputs: OutputsComputeTotalStrain2#

Enables to get outputs of the operator by evaluating it

Returns:: An instance of OutputsComputeTotalStrain2.
Return type:: outputs

property compute_total_strain_2.progress_bar: bool#

Enable or disable progress bar display when requesting the operator’s output.

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

property compute_total_strain_2.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

property compute_total_strain_2.id: int#

Retrieve the unique identifier of the operator.

This property returns the unique ID associated with the operator. This property is lazily initialized.

Returns:: The unique identifier of the operator.
Return type:: int

Notes

Property available with server’s version starting at 10.0.

property compute_total_strain_2.specification#

Returns the Specification (or documentation) of this Operator.

Return type:: Specification

property compute_total_strain_2.changelog: ansys.dpf.core.changelog.Changelog#

Return the changelog of this operator.

Requires DPF 11.0 (2026 R1) or above.

Returns:: Changelog of the operator.
Return type:: changelog

property compute_total_strain_2.version: packaging.version.Version#

Return the current version of the operator.

Requires DPF 11.0 (2026 R1) or above.

Attribute detail#

compute_total_strain_2.name = None#

Method detail#

static compute_total_strain_2.default_config(server: ansys.dpf.core.server_types.AnyServerType = None) → ansys.dpf.core.config.Config#

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 with channel connected to the remote or local instance. When None, attempts to use the global server.
Returns:: A new Config instance equivalent to the default config for this operator.
Return type:: config

compute_total_strain_2.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 ]]...

compute_total_strain_2.connect_operator_as_input(pin, op)#

Connect an operator as an input on a pin.

Parameters:

pin (int) – Number of the output pin. The default is 0.
op (ansys.dpf.core.dpf_operator.Operator) – Requested type of the output. The default is None.

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

compute_total_strain_2.__del__()#: Delete this instance.

compute_total_strain_2.__str__()#

Describe the entity.

Returns:: Description of the entity.
Return type:: str

compute_total_strain_2.run()#: Evaluate this operator.

compute_total_strain_2.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()

compute_total_strain_2.__add__(fields_b)#

Add two fields or two fields containers.

Returns:: add
Return type:: operators.math.add_fc

compute_total_strain_2.__sub__(fields_b)#

Subtract two fields or two fields containers.

Returns:: minus
Return type:: operators.math.minus_fc

compute_total_strain_2.__pow__(value)#: Raise each element of a field or a fields container to power 2.

compute_total_strain_2.__mul__(value)#

Multiply two fields or two fields containers.

Returns:: mul
Return type:: operators.math.generalized_inner_product_fc

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

compute_total_strain_2.__truediv__(inpt)#

Perform division with another operator or a scalar.

This method allows the use of the division operator (/) between an Operator instance and either another Operator or a scalar value (float).

compute_total_strain_2#

Inputs#

Outputs#

Overview#

Import detail#

Property detail#

Attribute detail#

Method detail#

`compute_total_strain_2`#