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:
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#

connect

Connect an input on the operator using a pin number.

connect_operator_as_input

Connect an operator as an input on a pin.

get_output

Retrieve the output of the operator on the pin number.

run

Evaluate this operator.

eval

Evaluate this operator.

inputs

Enables to connect inputs to the operator

outputs

Enables to get outputs of the operator by evaluating it

progress_bar

Enable or disable progress bar display when requesting the operator’s output.

config

Copy of the operator’s current configuration.

id

Retrieve the unique identifier of the operator.

specification

Returns the Specification (or documentation) of this Operator.

name

default_config

Returns the default config of the operator.

operator_specification

Documents an Operator with its description (what the Operator does),its inputs and outputs and some properties.

__del__

Delete this instance.

__str__

Describe the entity.

__add__

Add two fields or two fields containers.

__sub__

Subtract two fields or two fields containers.

__pow__

Raise each element of a field or a fields container to power 2.

__mul__

Multiply two fields or two fields containers.

__truediv__

Perform division with another operator or a scalar.

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

property amplitude.progress_bar: bool#

Enable or disable progress bar display when requesting the operator’s output.

With this property, the user can choose to print a progress bar when the operator’s output is requested, default is False

property amplitude.config#

Copy of the operator’s current configuration.

You can modify the copy of the configuration and then use operator.config = new_config or instantiate an operator with the new configuration as a parameter.

For information on an operator’s options, see the documentation for that operator.

Returns:

Copy of the operator’s current configuration.

Return type:

ansys.dpf.core.config.Config

Examples

Modify the copy of an operator’s configuration and set it as current config of the operator.

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.math.add()
>>> config_add = op.config
>>> config_add.set_work_by_index_option(True)
>>> op.config = config_add
property amplitude.id: int#

Retrieve the unique identifier of the operator.

This property returns the unique ID associated with the operator. This property is lazily initialized.

Returns:

The unique identifier of the operator.

Return type:

int

Notes

Property available with server’s version starting at 10.0.

property amplitude.specification#

Returns the Specification (or documentation) of this Operator.

Return type:

Specification

Attribute detail#

amplitude.name = None#

Method detail#

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

Returns the default config of the operator.

This config can then be changed to the user needs and be used to instantiate the operator. The Configuration allows to customize how the operation will be processed by the operator.

Parameters:

server – Server with channel connected to the remote or local instance. When None, attempts to use the global server.

Returns:

A new Config instance equivalent to the default config for this operator.

Return type:

config

amplitude.connect(pin, inpt, pin_out=0)#

Connect an input on the operator using a pin number.

Parameters:

  • pin (int) – Number of the input pin.

  • inpt (str, int, double, bool, list[int], list[float], Field, FieldsContainer, Scoping,)

  • ScopingsContainer – Operator, os.PathLike Object to connect to.

  • MeshedRegion – Operator, os.PathLike Object to connect to.

  • MeshesContainer – Operator, os.PathLike Object to connect to.

  • DataSources – Operator, os.PathLike Object to connect to.

  • CyclicSupport – Operator, os.PathLike Object to connect to.

  • dict – Operator, os.PathLike Object to connect to.

  • Outputs – Operator, os.PathLike Object to connect to.

  • pin_out (int, optional) – If the input is an operator, the output pin of the input operator. The default is 0.

Examples

Compute the minimum of displacement by chaining the "U" and "min_max_fc" operators.

>>> from ansys.dpf import core as dpf
>>> from ansys.dpf.core import examples
>>> data_src = dpf.DataSources(examples.find_multishells_rst())
>>> disp_op = dpf.operators.result.displacement()
>>> disp_op.inputs.data_sources(data_src)
>>> max_fc_op = dpf.operators.min_max.min_max_fc()
>>> max_fc_op.inputs.connect(disp_op.outputs)
>>> max_field = max_fc_op.outputs.field_max()
>>> max_field.data
DPFArray([[0.59428386, 0.00201751, 0.0006032 ]]...
amplitude.connect_operator_as_input(pin, op)#

Connect an operator as an input on a pin.

Parameters:
amplitude.get_output(pin=0, output_type=None)#

Retrieve the output of the operator on the pin number.

To activate the progress bar for server version higher or equal to 3.0, use my_op.progress_bar=True

Parameters:

  • pin (int, optional) – Number of the output pin. The default is 0.

  • output_type (ansys.dpf.core.common.types, type, optional) – Requested type of the output. The default is None.

Returns:

Output of the operator.

Return type:

type

amplitude.__del__()#

Delete this instance.

amplitude.__str__()#

Describe the entity.

Returns:

Description of the entity.

Return type:

str

amplitude.run()#

Evaluate this operator.

amplitude.eval(pin=None)#

Evaluate this operator.

Parameters:

pin (int) – Number of the output pin. The default is None.

Returns:

output – Returns the first output of the operator by default and the output of a given pin when specified. Or, it only evaluates the operator without output.

Return type:

FieldsContainer, Field, MeshedRegion, Scoping

Examples

Use the eval method.

>>> from ansys.dpf import core as dpf
>>> import ansys.dpf.core.operators.math as math
>>> from ansys.dpf.core import examples
>>> data_src = dpf.DataSources(examples.find_multishells_rst())
>>> disp_op = dpf.operators.result.displacement()
>>> disp_op.inputs.data_sources(data_src)
>>> normfc = math.norm_fc(disp_op).eval()
amplitude.__add__(fields_b)#

Add two fields or two fields containers.

Returns:

add

Return type:

operators.math.add_fc

amplitude.__sub__(fields_b)#

Subtract two fields or two fields containers.

Returns:

minus

Return type:

operators.math.minus_fc

amplitude.__pow__(value)#

Raise each element of a field or a fields container to power 2.

amplitude.__mul__(value)#

Multiply two fields or two fields containers.

Returns:

mul

Return type:

operators.math.generalized_inner_product_fc

static amplitude.operator_specification(op_name, server=None)#

Documents an Operator with its description (what the Operator does),its inputs and outputs and some properties.

amplitude.__truediv__(inpt)#

Perform division with another operator or a scalar.

This method allows the use of the division operator (/) between an Operator instance and either another Operator or a scalar value (float).