`modulus`#

class ansys.dpf.core.operators.math.modulus.modulus(fields_container=None, config=None, server=None)#

Bases: ansys.dpf.core.dpf_operator.Operator

Computes element-wise modulus of field containers containing complex fields.

Parameters:: fields_container (FieldsContainer)
Returns:: fields_container
Return type:: FieldsContainer

Examples

>>> from ansys.dpf import core as dpf

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

>>> # Make input connections
>>> my_fields_container = dpf.FieldsContainer()
>>> op.inputs.fields_container.connect(my_fields_container)

>>> # Instantiate operator and connect inputs in one line
>>> op = dpf.operators.math.modulus(
...     fields_container=my_fields_container,
... )

>>> # Get output data
>>> result_fields_container = op.outputs.fields_container()

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.modulus import modulus

Property detail#

property modulus.inputs: InputsModulus#

Enables to connect inputs to the operator

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

property modulus.outputs: OutputsModulus#

Enables to get outputs of the operator by evaluating it

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

Method detail#

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