InputsPoyntingVector

class ansys.dpf.core.operators.result.poynting_vector.InputsPoyntingVector(op: ansys.dpf.core.dpf_operator.Operator)

Bases: ansys.dpf.core.inputs._Inputs

Intermediate class used to connect user inputs to poynting_vector operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.poynting_vector()
>>> my_fields_containerA = dpf.FieldsContainer()
>>> op.inputs.fields_containerA.connect(my_fields_containerA)
>>> my_fields_containerB = dpf.FieldsContainer()
>>> op.inputs.fields_containerB.connect(my_fields_containerB)
>>> my_fields_containerC = dpf.FieldsContainer()
>>> op.inputs.fields_containerC.connect(my_fields_containerC)
>>> my_fields_containerD = dpf.FieldsContainer()
>>> op.inputs.fields_containerD.connect(my_fields_containerD)
>>> my_abstract_meshed_region = dpf.MeshedRegion()
>>> op.inputs.abstract_meshed_region.connect(my_abstract_meshed_region)
>>> my_int32 = int()
>>> op.inputs.int32.connect(my_int32)

Overview

Methods

connect

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

Properties

fields_containerA	Allows to connect fields_containerA input to the operator.
fields_containerB	Allows to connect fields_containerB input to the operator.
fields_containerC	Allows to connect fields_containerC input to the operator.
fields_containerD	Allows to connect fields_containerD input to the operator.
abstract_meshed_region	Allows to connect abstract_meshed_region input to the operator.
int32	Allows to connect int32 input to the operator.

Special methods

__str__
__call__
__getitem__

Import detail

from ansys.dpf.core.operators.result.poynting_vector import InputsPoyntingVector

Property detail

property InputsPoyntingVector.fields_containerA: ansys.dpf.core.inputs.Input[ansys.dpf.core.fields_container.FieldsContainer]

Allows to connect fields_containerA input to the operator.

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.poynting_vector()
>>> op.inputs.fields_containerA.connect(my_fields_containerA)
>>> # or
>>> op.inputs.fields_containerA(my_fields_containerA)

property InputsPoyntingVector.fields_containerB: ansys.dpf.core.inputs.Input[ansys.dpf.core.fields_container.FieldsContainer]

Allows to connect fields_containerB input to the operator.

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.poynting_vector()
>>> op.inputs.fields_containerB.connect(my_fields_containerB)
>>> # or
>>> op.inputs.fields_containerB(my_fields_containerB)

property InputsPoyntingVector.fields_containerC: ansys.dpf.core.inputs.Input[ansys.dpf.core.fields_container.FieldsContainer]

Allows to connect fields_containerC input to the operator.

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.poynting_vector()
>>> op.inputs.fields_containerC.connect(my_fields_containerC)
>>> # or
>>> op.inputs.fields_containerC(my_fields_containerC)

property InputsPoyntingVector.fields_containerD: ansys.dpf.core.inputs.Input[ansys.dpf.core.fields_container.FieldsContainer]

Allows to connect fields_containerD input to the operator.

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.poynting_vector()
>>> op.inputs.fields_containerD.connect(my_fields_containerD)
>>> # or
>>> op.inputs.fields_containerD(my_fields_containerD)

property InputsPoyntingVector.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 mesh region in this pin have to be boundary or skin mesh

Returns:

An Input instance for this pin.

Return type:

input

Examples

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

property InputsPoyntingVector.int32: ansys.dpf.core.inputs.Input[int]

Allows to connect int32 input to the operator.

load step number, if it’s specified, the Poynting Vector is computed only on the substeps of this step

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.poynting_vector()
>>> op.inputs.int32.connect(my_int32)
>>> # or
>>> op.inputs.int32(my_int32)

Method detail

InputsPoyntingVector.__str__()

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

InputsPoyntingVector.__call__(inpt)

InputsPoyntingVector.__getitem__(item) → Input