InputsFft

class ansys.dpf.core.operators.mapping.fft.InputsFft(op: ansys.dpf.core.dpf_operator.Operator)

Bases: ansys.dpf.core.inputs._Inputs

Intermediate class used to connect user inputs to fft operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mapping.fft()
>>> my_field = dpf.Field()
>>> op.inputs.field.connect(my_field)
>>> my_scale_forward_transform = float()
>>> op.inputs.scale_forward_transform.connect(my_scale_forward_transform)
>>> my_inplace = bool()
>>> op.inputs.inplace.connect(my_inplace)
>>> my_force_fft_points = int()
>>> op.inputs.force_fft_points.connect(my_force_fft_points)
>>> my_cutoff_frequency = float()
>>> op.inputs.cutoff_frequency.connect(my_cutoff_frequency)
>>> my_scale_right_amplitude = bool()
>>> op.inputs.scale_right_amplitude.connect(my_scale_right_amplitude)

Overview

Properties

field	Allows to connect field input to the operator.
scale_forward_transform	Allows to connect scale_forward_transform input to the operator.
inplace	Allows to connect inplace input to the operator.
force_fft_points	Allows to connect force_fft_points input to the operator.
cutoff_frequency	Allows to connect cutoff_frequency input to the operator.
scale_right_amplitude	Allows to connect scale_right_amplitude input to the operator.

Import detail

from ansys.dpf.core.operators.mapping.fft import InputsFft

Property detail

property InputsFft.field: ansys.dpf.core.inputs.Input

Allows to connect field input to the operator.

Field or Fields Container.

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mapping.fft()
>>> op.inputs.field.connect(my_field)
>>> # or
>>> op.inputs.field(my_field)

property InputsFft.scale_forward_transform: ansys.dpf.core.inputs.Input

Allows to connect scale_forward_transform input to the operator.

Scale for Forward Transform, default is 2/field_num_elementary_data.

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mapping.fft()
>>> op.inputs.scale_forward_transform.connect(my_scale_forward_transform)
>>> # or
>>> op.inputs.scale_forward_transform(my_scale_forward_transform)

property InputsFft.inplace: ansys.dpf.core.inputs.Input

Allows to connect inplace input to the operator.

True if inplace, default is false.

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mapping.fft()
>>> op.inputs.inplace.connect(my_inplace)
>>> # or
>>> op.inputs.inplace(my_inplace)

property InputsFft.force_fft_points: ansys.dpf.core.inputs.Input

Allows to connect force_fft_points input to the operator.

Explicitely define number of fft points to either rescope or perform zero padding.

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mapping.fft()
>>> op.inputs.force_fft_points.connect(my_force_fft_points)
>>> # or
>>> op.inputs.force_fft_points(my_force_fft_points)

property InputsFft.cutoff_frequency: ansys.dpf.core.inputs.Input

Allows to connect cutoff_frequency input to the operator.

Restrict output frequency up to this cutoff frequency

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mapping.fft()
>>> op.inputs.cutoff_frequency.connect(my_cutoff_frequency)
>>> # or
>>> op.inputs.cutoff_frequency(my_cutoff_frequency)

property InputsFft.scale_right_amplitude: ansys.dpf.core.inputs.Input

Allows to connect scale_right_amplitude input to the operator.

If set to true (default is false), 2/field_num_entities scaling will be applied, to have right amplitude values.

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mapping.fft()
>>> op.inputs.scale_right_amplitude.connect(my_scale_right_amplitude)
>>> # or
>>> op.inputs.scale_right_amplitude(my_scale_right_amplitude)