`amplitude`#

class ansys.dpf.core.operators.math.amplitude.amplitude(fieldA=None, fieldB=None, config=None, server=None)#

Bases: ansys.dpf.core.dpf_operator.Operator

Computes amplitude of a real and an imaginary field.

Parameters:

fieldA (Field or FieldsContainer) – field or fields container with only one field is expected
fieldB (Field or FieldsContainer) – field or fields container with only one field is expected

Returns:

field

Return type:

Field

Examples

>>> from ansys.dpf import core as dpf

>>> # Instantiate operator
>>> op = dpf.operators.math.amplitude()

>>> # Make input connections
>>> my_fieldA = dpf.Field()
>>> op.inputs.fieldA.connect(my_fieldA)
>>> my_fieldB = dpf.Field()
>>> op.inputs.fieldB.connect(my_fieldB)

>>> # Instantiate operator and connect inputs in one line
>>> op = dpf.operators.math.amplitude(
...     fieldA=my_fieldA,
...     fieldB=my_fieldB,
... )

>>> # Get output data
>>> result_field = op.outputs.field()

Overview#

Properties

`inputs`	Enables to connect inputs to the operator
`outputs`	Enables to get outputs of the operator by evaluating it

Static methods

default_config

Returns the default config of the operator.

Import detail#

from ansys.dpf.core.operators.math.amplitude import amplitude

Property detail#

property amplitude.inputs: InputsAmplitude#

Enables to connect inputs to the operator

Returns:: An instance of InputsAmplitude.
Return type:: inputs

property amplitude.outputs: OutputsAmplitude#

Enables to get outputs of the operator by evaluating it

Returns:: An instance of OutputsAmplitude.
Return type:: outputs

Method detail#

static amplitude.default_config(server: ansys.dpf.core.server_types.AnyServerType = None) → ansys.dpf.core.config.Config#