InputsComputeTotalStrainYz

class ansys.dpf.core.operators.result.compute_total_strain_YZ.InputsComputeTotalStrainYz(op: ansys.dpf.core.dpf_operator.Operator)

Bases: ansys.dpf.core.inputs._Inputs

Intermediate class used to connect user inputs to compute_total_strain_YZ operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.compute_total_strain_YZ()
>>> 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)

Overview

Methods

connect

Connect any input (an entity or an operator output) to any input pin of this operator.

Properties

time_scoping	Allows to connect time_scoping input to the operator.
scoping	Allows to connect scoping input to the operator.
streams_container	Allows to connect streams_container input to the operator.
data_sources	Allows to connect data_sources input to the operator.
extrapolate	Allows to connect extrapolate input to the operator.
nonlinear	Allows to connect nonlinear input to the operator.
abstract_meshed_region	Allows to connect abstract_meshed_region input to the operator.
requested_location	Allows to connect requested_location input to the operator.
displacement	Allows to connect displacement input to the operator.

Special methods

__str__
__call__
__getitem__

Import detail

from ansys.dpf.core.operators.result.compute_total_strain_YZ import InputsComputeTotalStrainYz

Property detail

property InputsComputeTotalStrainYz.time_scoping: ansys.dpf.core.inputs.Input[ansys.dpf.core.scoping.Scoping | int | float | ansys.dpf.core.field.Field]

Allows to connect time_scoping input to the operator.

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

Returns:

An Input instance for this pin.

Return type:

input

Examples

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

property InputsComputeTotalStrainYz.scoping: ansys.dpf.core.inputs.Input[ansys.dpf.core.scoping.Scoping]

Allows to connect scoping input to the operator.

The element scoping on which the result is computed.

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.compute_total_strain_YZ()
>>> op.inputs.scoping.connect(my_scoping)
>>> # or
>>> op.inputs.scoping(my_scoping)

property InputsComputeTotalStrainYz.streams_container: ansys.dpf.core.inputs.Input[ansys.dpf.core.streams_container.StreamsContainer]

Allows to connect streams_container input to the operator.

Optional if a mesh or a data_sources have been connected. Required if no displacement input have been connected.

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.compute_total_strain_YZ()
>>> op.inputs.streams_container.connect(my_streams_container)
>>> # or
>>> op.inputs.streams_container(my_streams_container)

property InputsComputeTotalStrainYz.data_sources: ansys.dpf.core.inputs.Input[ansys.dpf.core.data_sources.DataSources]

Allows to connect data_sources input to the operator.

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.

Returns:

An Input instance for this pin.

Return type:

input

Examples

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

property InputsComputeTotalStrainYz.extrapolate: ansys.dpf.core.inputs.Input[int]

Allows to connect extrapolate input to the operator.

Whether to extrapolate the data from the integration points to the nodes.

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.compute_total_strain_YZ()
>>> op.inputs.extrapolate.connect(my_extrapolate)
>>> # or
>>> op.inputs.extrapolate(my_extrapolate)

property InputsComputeTotalStrainYz.nonlinear: ansys.dpf.core.inputs.Input[int]

Allows to connect nonlinear input to the operator.

Whether to use nonlinear geometry or nonlinear material (1 = large strain, 2 = hyperelasticity).

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.compute_total_strain_YZ()
>>> op.inputs.nonlinear.connect(my_nonlinear)
>>> # or
>>> op.inputs.nonlinear(my_nonlinear)

property InputsComputeTotalStrainYz.abstract_meshed_region: ansys.dpf.core.inputs.Input[ansys.dpf.core.meshed_region.MeshedRegion]

Allows to connect abstract_meshed_region input to the operator.

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.

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.compute_total_strain_YZ()
>>> op.inputs.abstract_meshed_region.connect(my_abstract_meshed_region)
>>> # or
>>> op.inputs.abstract_meshed_region(my_abstract_meshed_region)

property InputsComputeTotalStrainYz.requested_location: ansys.dpf.core.inputs.Input[str]

Allows to connect requested_location input to the operator.

Average the Elemental Nodal result to the requested location.

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.compute_total_strain_YZ()
>>> op.inputs.requested_location.connect(my_requested_location)
>>> # or
>>> op.inputs.requested_location(my_requested_location)

property InputsComputeTotalStrainYz.displacement: ansys.dpf.core.inputs.Input[ansys.dpf.core.fields_container.FieldsContainer | ansys.dpf.core.field.Field]

Allows to connect displacement input to the operator.

Field/or fields container containing only the displacement field (nodal). If none specified, read displacements from result file using the data_sources.

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.compute_total_strain_YZ()
>>> op.inputs.displacement.connect(my_displacement)
>>> # or
>>> op.inputs.displacement(my_displacement)

Method detail

InputsComputeTotalStrainYz.__str__()

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

Deprecated since version Deprecated: in favor of explicit output-to-input connections.

InputsComputeTotalStrainYz.__call__(inpt)

InputsComputeTotalStrainYz.__getitem__(item) → Input