`InputsResultProvider`#

class ansys.dpf.core.operators.result.result_provider.InputsResultProvider(op: ansys.dpf.core.dpf_operator.Operator)#

Bases: ansys.dpf.core.inputs._Inputs

Intermediate class used to connect user inputs to result_provider operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.result_provider()
>>> my_time_scoping = dpf.Scoping()
>>> op.inputs.time_scoping.connect(my_time_scoping)
>>> my_mesh_scoping = dpf.ScopingsContainer()
>>> op.inputs.mesh_scoping.connect(my_mesh_scoping)
>>> my_fields_container = dpf.FieldsContainer()
>>> op.inputs.fields_container.connect(my_fields_container)
>>> 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_bool_rotate_to_global = bool()
>>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global)
>>> my_mesh = dpf.MeshedRegion()
>>> op.inputs.mesh.connect(my_mesh)
>>> my_result_name = dpf.()
>>> op.inputs.result_name.connect(my_result_name)
>>> my_result_scripting_name = dpf.()
>>> op.inputs.result_scripting_name.connect(my_result_scripting_name)

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.
`mesh_scoping`	Allows to connect mesh_scoping input to the operator.
`fields_container`	Allows to connect fields_container 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.
`bool_rotate_to_global`	Allows to connect bool_rotate_to_global input to the operator.
`mesh`	Allows to connect mesh input to the operator.
`result_name`	Allows to connect result_name input to the operator.
`result_scripting_name`	Allows to connect result_scripting_name input to the operator.

Special methods

`__str__`
`__call__`
`__getitem__`

Import detail#

from ansys.dpf.core.operators.result.result_provider import InputsResultProvider

Property detail#

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

Returns:: An Input instance for this pin.
Return type:: input

Examples

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

property InputsResultProvider.mesh_scoping: ansys.dpf.core.inputs.Input[ansys.dpf.core.scopings_container.ScopingsContainer | ansys.dpf.core.scoping.Scoping]#

Allows to connect mesh_scoping input to the operator.

nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping’s location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains

Returns:: An Input instance for this pin.
Return type:: input

Examples

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

property InputsResultProvider.fields_container: ansys.dpf.core.inputs.Input[ansys.dpf.core.fields_container.FieldsContainer]#

Allows to connect fields_container input to the operator.

Fields container already allocated modified inplace

Returns:: An Input instance for this pin.
Return type:: input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.result_provider()
>>> op.inputs.fields_container.connect(my_fields_container)
>>> # or
>>> op.inputs.fields_container(my_fields_container)

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

Allows to connect streams_container input to the operator.

result file container allowed to be kept open to cache data

Returns:: An Input instance for this pin.
Return type:: input

Examples

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

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

Allows to connect data_sources input to the operator.

result file path container, used if no streams are set

Returns:: An Input instance for this pin.
Return type:: input

Examples

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

property InputsResultProvider.bool_rotate_to_global: ansys.dpf.core.inputs.Input[bool]#

Allows to connect bool_rotate_to_global input to the operator.

Rotate the result to the global coordinate system if rotations are available and if the requested result is a 3D vector or a symmetrical 3x3 matrix (default true). Please check your results carefully if ‘false’ is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect.

Returns:: An Input instance for this pin.
Return type:: input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.result_provider()
>>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global)
>>> # or
>>> op.inputs.bool_rotate_to_global(my_bool_rotate_to_global)

property InputsResultProvider.mesh: ansys.dpf.core.inputs.Input[ansys.dpf.core.meshed_region.MeshedRegion | ansys.dpf.core.meshes_container.MeshesContainer]#

Allows to connect mesh input to the operator.

prevents from reading the mesh in the result files

Returns:: An Input instance for this pin.
Return type:: input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.result_provider()
>>> op.inputs.mesh.connect(my_mesh)
>>> # or
>>> op.inputs.mesh(my_mesh)

property InputsResultProvider.result_name: ansys.dpf.core.inputs.Input#

Allows to connect result_name input to the operator.

Specifies the scripting name of the raw/internal Name of the result to extract from the file

Returns:: An Input instance for this pin.
Return type:: input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.result_provider()
>>> op.inputs.result_name.connect(my_result_name)
>>> # or
>>> op.inputs.result_name(my_result_name)

property InputsResultProvider.result_scripting_name: ansys.dpf.core.inputs.Input#

Allows to connect result_scripting_name input to the operator.

Specifies the scripting name of the result to extract;see ResultInfo for details. Use either “result name” or “result scripting name” with their appropriate pin, but not both.

Returns:: An Input instance for this pin.
Return type:: input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.result_provider()
>>> op.inputs.result_scripting_name.connect(my_result_scripting_name)
>>> # or
>>> op.inputs.result_scripting_name(my_result_scripting_name)

Method detail#

InputsResultProvider.__str__()#

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

InputsResultProvider.__call__(inpt)#

InputsResultProvider.__getitem__(item) → Input#

InputsResultProvider#

Overview#

Import detail#

Property detail#

Method detail#

`InputsResultProvider`#