sweeping_phase

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).

available inputs:
  • real_field (Field, FieldsContainer)

  • imaginary_field (Field, FieldsContainer)

  • angle (float)

  • unit_name (str)

  • abs_value (bool)

  • imaginary_part_null (bool)

available outputs:
  • field (Field)

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()

Returns the default config for a given operator. This config can then be changed to the user needs and be used to instantiate the given operator

Parameters
  • name (str) – Name of the operator. For example ‘U’.

  • 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

Returns a copy of the current config of the operator. To use the config that you modify, please use operator.config = new_config or create an operator with the new config as a parameter.

Returns

config

Return type

Config

connect(pin, inpt, pin_out=0)

Connect an input on the operator using a pin number.

Parameters

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 ]])
get_output(pin=0, output_type=None)

Returns the output of the operator on the pin number.

Parameters
  • pin (int, optional) – Number of the output pin.

  • output_type (core.type enum, optional) – The requested type of the output.

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

  • pindoc: field or fields container with only one field is expected

Parameters

my_real_field (Field, 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

  • pindoc: field or fields container with only one field is expected

Parameters

my_imaginary_field (Field, 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

  • pindoc: 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

  • pindoc: 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)

Allows you to connect any input (an entity or an operator output) to any input pin of this operator.

The matching input type corresponding to the output is looked for.

Parameters

inpt (str, int, double, Field, FieldsContainer, Scoping, DataSources, MeshedRegion, ScopingsContainer, CyclicSupport, ..., Output, Outputs, Operator) – 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 .. rubric:: 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()