DPF Framework 2026 R1

math:sweeping phase (fields container)

Last update: 31.07.2026

Version: 0.0.0

Description

Shifts the phase of all the corresponding real and imaginary fields of a fields container for a given angle (in 2) of a unit (in 4). An output field is computed for each pair of real and imaginary fields in the input fields_container as field_out = real_field*cos(angle) - imaginary_field*sin(angle).

Inputs

This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. Some inputs are required, while others are optional and provide additional configuration. Each parameter is detailed in the sections that follow the table.

Pin number Name Status Expected type(s)
0 fields_container Required fields_container
2 angle Required double
3 unit_name string
4 abs_value Required bool

fields_container (Pin 0)

angle (Pin 2)

  • Required: Yes
  • Expected type(s): double

unit_name (Pin 3)

  • Required: No
  • Expected type(s): string

String Unit. Supported values: "deg" or "rad". Default: "rad".

abs_value (Pin 4)

  • Required: Yes
  • Expected type(s): bool

Outputs

This table lists the output pins for this operator. Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. Each output is detailed in the sections that follow the table.

Pin number Name Expected type(s)
0 fields_container fields_container

fields_container (Pin 0)

Configurations

This operator supports configuration options that modify its behavior.

mutex

  • Expected type(s): bool
  • Default value: false

If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads.

Scripting

This operator can be accessed through scripting interfaces using these identifiers.

Category: math

Plugin: core

Scripting name: None

Full name: None

Internal name: sweeping_phase_fc

License: None

Examples

These examples demonstrate how to use this operator in different programming environments. Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output.

C++ 
#include "dpf_api.h"

ansys::dpf::Operator op("sweeping_phase_fc"); // operator instantiation
op.connect(0, my_fields_container);
op.connect(2, my_angle);
op.connect(3, my_unit_name);
op.connect(4, my_abs_value);
ansys::dpf::FieldsContainer my_fields_container = op.getOutput<ansys::dpf::FieldsContainer>(0);
CPython 
import ansys.dpf.core as dpf

op = dpf.operators.math.None() # operator instantiation
op.inputs.fields_container.connect(my_fields_container)
op.inputs.angle.connect(my_angle)
op.inputs.unit_name.connect(my_unit_name)
op.inputs.abs_value.connect(my_abs_value)
my_fields_container = op.outputs.fields_container()
IPython 
import mech_dpf
import Ans.DataProcessing as dpf

op = dpf.operators.math.None() # operator instantiation
op.inputs.fields_container.Connect(my_fields_container)
op.inputs.angle.Connect(my_angle)
op.inputs.unit_name.Connect(my_unit_name)
op.inputs.abs_value.Connect(my_abs_value)
my_fields_container = op.outputs.fields_container.GetData()

Changelog

  • Version 0.0.0: Initial release.

Connect with Ansys