sweeping_phase#

Autogenerated DPF operator classes.

class ansys.dpf.core.operators.math.sweeping_phase.sweeping_phase(real_field=None, imaginary_field=None, angle=None, unit_name=None, abs_value=None, imaginary_part_null=None, config=None, server=None)#

Shift the phase of a real and an imaginary fields (in 0 and 1) of a given angle (in 3) of unit (in 4).

Parameters
  • real_field (Field or FieldsContainer) – Field or fields container with only one field is expected

  • imaginary_field (Field or FieldsContainer) – Field or fields container with only one field is expected

  • angle (float) –

  • unit_name (str) – String unit

  • abs_value (bool) –

  • imaginary_part_null (bool) – If the imaginary part field is empty and this pin is true, then the imaginary part is supposed to be 0 (default is false)

Examples

>>> from ansys.dpf import core as dpf
>>> # Instantiate operator
>>> op = dpf.operators.math.sweeping_phase()
>>> # Make input connections
>>> my_real_field = dpf.Field()
>>> op.inputs.real_field.connect(my_real_field)
>>> my_imaginary_field = dpf.Field()
>>> op.inputs.imaginary_field.connect(my_imaginary_field)
>>> my_angle = float()
>>> op.inputs.angle.connect(my_angle)
>>> my_unit_name = str()
>>> op.inputs.unit_name.connect(my_unit_name)
>>> my_abs_value = bool()
>>> op.inputs.abs_value.connect(my_abs_value)
>>> my_imaginary_part_null = bool()
>>> op.inputs.imaginary_part_null.connect(my_imaginary_part_null)
>>> # Instantiate operator and connect inputs in one line
>>> op = dpf.operators.math.sweeping_phase(
...     real_field=my_real_field,
...     imaginary_field=my_imaginary_field,
...     angle=my_angle,
...     unit_name=my_unit_name,
...     abs_value=my_abs_value,
...     imaginary_part_null=my_imaginary_part_null,
... )
>>> # Get output data
>>> result_field = op.outputs.field()
static default_config(server=None)#

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.DPFServer, optional) – Server with channel connected to the remote or local instance. When None, attempts to use the the global server.

property inputs#

Enables to connect inputs to the operator

Returns

inputs

Return type

InputsSweepingPhase

property outputs#

Enables to get outputs of the operator by evaluationg it

Returns

outputs

Return type

OutputsSweepingPhase

property config#

Copy of the operator’s current configuration.

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

Returns

Copy of the operator’s current configuration.

Return type

ansys.dpf.core.config.Config

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 of int, list of doubles,) –

    Field, FieldsContainer, Scoping, ScopingsContainer, MeshedRegion,

    MeshesContainer, DataSources, 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.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
array([[0.59428386, 0.00201751, 0.0006032 ]])
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.multishells_rst)
>>> disp_op = dpf.operators.result.displacement()
>>> disp_op.inputs.data_sources(data_src)
>>> normfc = math.norm_fc(disp_op).eval()
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, optional) – Requested type of the output. The default is None.

Returns

Output of the operator.

Return type

type

static operator_specification(op_name, server=None)#

Put the grpc spec message in self._spec

property progress_bar: bool#

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

run()#

Evaluate this operator.

class ansys.dpf.core.operators.math.sweeping_phase.InputsSweepingPhase(op: ansys.dpf.core.dpf_operator.Operator)#

Intermediate class used to connect user inputs to sweeping_phase operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.math.sweeping_phase()
>>> my_real_field = dpf.Field()
>>> op.inputs.real_field.connect(my_real_field)
>>> my_imaginary_field = dpf.Field()
>>> op.inputs.imaginary_field.connect(my_imaginary_field)
>>> my_angle = float()
>>> op.inputs.angle.connect(my_angle)
>>> my_unit_name = str()
>>> op.inputs.unit_name.connect(my_unit_name)
>>> my_abs_value = bool()
>>> op.inputs.abs_value.connect(my_abs_value)
>>> my_imaginary_part_null = bool()
>>> op.inputs.imaginary_part_null.connect(my_imaginary_part_null)
property real_field#

Allows to connect real_field input to the operator.

Field or fields container with only one field is expected

Parameters

my_real_field (Field or FieldsContainer) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.math.sweeping_phase()
>>> op.inputs.real_field.connect(my_real_field)
>>> # or
>>> op.inputs.real_field(my_real_field)
property imaginary_field#

Allows to connect imaginary_field input to the operator.

Field or fields container with only one field is expected

Parameters

my_imaginary_field (Field or FieldsContainer) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.math.sweeping_phase()
>>> op.inputs.imaginary_field.connect(my_imaginary_field)
>>> # or
>>> op.inputs.imaginary_field(my_imaginary_field)
property angle#

Allows to connect angle input to the operator.

Parameters

my_angle (float) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.math.sweeping_phase()
>>> op.inputs.angle.connect(my_angle)
>>> # or
>>> op.inputs.angle(my_angle)
property unit_name#

Allows to connect unit_name input to the operator.

String unit

Parameters

my_unit_name (str) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.math.sweeping_phase()
>>> op.inputs.unit_name.connect(my_unit_name)
>>> # or
>>> op.inputs.unit_name(my_unit_name)
property abs_value#

Allows to connect abs_value input to the operator.

Parameters

my_abs_value (bool) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.math.sweeping_phase()
>>> op.inputs.abs_value.connect(my_abs_value)
>>> # or
>>> op.inputs.abs_value(my_abs_value)
property imaginary_part_null#

Allows to connect imaginary_part_null input to the operator.

If the imaginary part field is empty and this pin is true, then the imaginary part is supposed to be 0 (default is false)

Parameters

my_imaginary_part_null (bool) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.math.sweeping_phase()
>>> op.inputs.imaginary_part_null.connect(my_imaginary_part_null)
>>> # or
>>> op.inputs.imaginary_part_null(my_imaginary_part_null)
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.

Parameters

inpt (str, int, double, Field, FieldsContainer, Scoping,) –

DataSources, MeshedRegion, ScopingsContainer, CyclicSupport,

…, Output, Outputs, Operator, os.PathLike

Input of the operator.

class ansys.dpf.core.operators.math.sweeping_phase.OutputsSweepingPhase(op: ansys.dpf.core.dpf_operator.Operator)#

Intermediate class used to get outputs from sweeping_phase operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.math.sweeping_phase()
>>> # Connect inputs : op.inputs. ...
>>> result_field = op.outputs.field()
property field#

Allows to get field output of the operator

Returns

my_field

Return type

Field

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.math.sweeping_phase()
>>> # Connect inputs : op.inputs. ...
>>> result_field = op.outputs.field()