InputsCgnsResultProvider

class ansys.dpf.core.operators.result.cgns_result_provider.InputsCgnsResultProvider(op: ansys.dpf.core.dpf_operator.Operator)

Bases: ansys.dpf.core.inputs._Inputs

Intermediate class used to connect user inputs to cgns_result_provider operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.cgns_result_provider()
>>> 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_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_result_name = str()
>>> op.inputs.result_name.connect(my_result_name)
>>> my_region_scoping = dpf.Scoping()
>>> op.inputs.region_scoping.connect(my_region_scoping)

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.
streams_container	Allows to connect streams_container input to the operator.
data_sources	Allows to connect data_sources input to the operator.
result_name	Allows to connect result_name input to the operator.
region_scoping	Allows to connect region_scoping input to the operator.

Special methods

__str__
__call__
__getitem__

Import detail

from ansys.dpf.core.operators.result.cgns_result_provider import InputsCgnsResultProvider

Property detail

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

Allows to connect time_scoping input to the operator.

time/freq (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

Returns:

An Input instance for this pin.

Return type:

input

Examples

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

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

Allows to connect mesh_scoping input to the operator.

nodes or elements scoping required in output. The scoping’s location indicates whether nodes or elements are asked. Using scopings container enables to split the result fields container in domains

Returns:

An Input instance for this pin.

Return type:

input

Examples

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

property InputsCgnsResultProvider.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.cgns_result_provider()
>>> op.inputs.streams_container.connect(my_streams_container)
>>> # or
>>> op.inputs.streams_container(my_streams_container)

property InputsCgnsResultProvider.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.cgns_result_provider()
>>> op.inputs.data_sources.connect(my_data_sources)
>>> # or
>>> op.inputs.data_sources(my_data_sources)

property InputsCgnsResultProvider.result_name: ansys.dpf.core.inputs.Input[str]

Allows to connect result_name input to the operator.

name of the result to read. By default the name of the operator is taken.

Returns:

An Input instance for this pin.

Return type:

input

Examples

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

property InputsCgnsResultProvider.region_scoping: ansys.dpf.core.inputs.Input[ansys.dpf.core.scoping.Scoping | int]

Allows to connect region_scoping input to the operator.

Optional zone name/Id of the mesh.

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.cgns_result_provider()
>>> op.inputs.region_scoping.connect(my_region_scoping)
>>> # or
>>> op.inputs.region_scoping(my_region_scoping)

Method detail

InputsCgnsResultProvider.__str__()

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

InputsCgnsResultProvider.__call__(inpt)

InputsCgnsResultProvider.__getitem__(item) → Input