InputsIntegrateOverTimeFreq

class ansys.dpf.core.operators.metadata.integrate_over_time_freq.InputsIntegrateOverTimeFreq(op: ansys.dpf.core.dpf_operator.Operator)

Bases: ansys.dpf.core.inputs._Inputs

Intermediate class used to connect user inputs to integrate_over_time_freq operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.metadata.integrate_over_time_freq()
>>> my_field = dpf.Field()
>>> op.inputs.field.connect(my_field)
>>> my_scoping = dpf.Scoping()
>>> op.inputs.scoping.connect(my_scoping)
>>> my_time_freq_support = dpf.TimeFreqSupport()
>>> op.inputs.time_freq_support.connect(my_time_freq_support)

Overview

Methods

connect

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

Properties

field	Allows to connect field input to the operator.
scoping	Allows to connect scoping input to the operator.
time_freq_support	Allows to connect time_freq_support input to the operator.

Special methods

__str__
__call__
__getitem__

Import detail

from ansys.dpf.core.operators.metadata.integrate_over_time_freq import InputsIntegrateOverTimeFreq

Property detail

property InputsIntegrateOverTimeFreq.field: ansys.dpf.core.inputs.Input[ansys.dpf.core.field.Field]

Allows to connect field 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.metadata.integrate_over_time_freq()
>>> op.inputs.field.connect(my_field)
>>> # or
>>> op.inputs.field(my_field)

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

Allows to connect scoping input to the operator.

Integrate the input field over a specific scoping.

Returns:

An Input instance for this pin.

Return type:

input

Examples

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

property InputsIntegrateOverTimeFreq.time_freq_support: ansys.dpf.core.inputs.Input[ansys.dpf.core.time_freq_support.TimeFreqSupport]

Allows to connect time_freq_support input to the operator.

Time Freq to integrate on, otherwise time freq support from the input field is taken.

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.metadata.integrate_over_time_freq()
>>> op.inputs.time_freq_support.connect(my_time_freq_support)
>>> # or
>>> op.inputs.time_freq_support(my_time_freq_support)

Method detail

InputsIntegrateOverTimeFreq.__str__()

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

InputsIntegrateOverTimeFreq.__call__(inpt)

InputsIntegrateOverTimeFreq.__getitem__(item) → Input