Skip to main content

DPF Framework 2026 R1

math:fft gradient evaluation

Last update: 31.07.2026

Version: 0.0.0

Description

Evaluate min max based on the fast fourier transform at a given field, using gradient method for adaptative time step.

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
1 time_scoping scoping
2 fs_ratio int32

fields_container (Pin 0)

time_scoping (Pin 1)

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

if specified only the results at these set ids are used

fs_ratio (Pin 2)

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

default value = 20

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 coefficients fields_container

coefficients (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: fft_gradient_eval

Full name: math.fft_gradient_eval

Internal name: fft_eval_gr

License: any_dpf_supported_increments

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("fft_eval_gr"); // operator instantiation
op.connect(0, my_fields_container);
op.connect(1, my_time_scoping);
op.connect(2, my_fs_ratio);
ansys::dpf::FieldsContainer my_coefficients = op.getOutput<ansys::dpf::FieldsContainer>(0);
CPython
import ansys.dpf.core as dpf

op = dpf.operators.math.fft_gradient_eval() # operator instantiation
op.inputs.fields_container.connect(my_fields_container)
op.inputs.time_scoping.connect(my_time_scoping)
op.inputs.fs_ratio.connect(my_fs_ratio)
my_coefficients = op.outputs.coefficients()
IPython
import mech_dpf
import Ans.DataProcessing as dpf

op = dpf.operators.math.fft_gradient_eval() # operator instantiation
op.inputs.fields_container.Connect(my_fields_container)
op.inputs.time_scoping.Connect(my_time_scoping)
op.inputs.fs_ratio.Connect(my_fs_ratio)
my_coefficients = op.outputs.coefficients.GetData()

Changelog

  • Version 0.0.0: Initial release.

Connect with Ansys