math:fft multi harmonic solution minmax

Version: 0.0.0

Description

Evaluate min max fields on multi harmonic solution. min and max fields are calculated based on evaluating a fourier series sum wrt rpms and using the gradient method for adaptive time steping

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.

fields_container (Pin 0)

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

rpm_scoping (Pin 1)

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

rpm scoping, by default the fourier series sum is evaluated using all the rpms

fs_ratio (Pin 2)

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

field or fields container with only one field is expected

num_subdivisions (Pin 3)

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

connect number subdivisions, used for uniform discretization

max_num_subdivisions (Pin 4)

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

connect max number subdivisions, used to avoid huge number of sudivisions

num_cycles (Pin 5)

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

Number of cycle of the periodic signal (default is 2)

use_harmonic_zero (Pin 6)

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

use harmonic zero for first rpm (default is false)

calculate_time_series (Pin 7)

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

calculates time series output (output pin 2), setting it to false enhance performance if only min/max are required (default is true)

substeps_selector (Pin 8)

• Required: No
• Expected type(s): vector<int32>

substeps to evaluate (frequencies), by default the operator is evaluated using all the available steps

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.

field_min (Pin 0)

• Expected type(s): fields_container

field_max (Pin 1)

• Expected type(s): fields_container

all_fields (Pin 2)

• Expected type(s): fields_container

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_multi_harmonic_minmax

Full name: math.fft_multi_harmonic_minmax

Internal name: fft_multi_harmonic_minmax

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.

#include "dpf_api.h"

ansys::dpf::Operator op("fft_multi_harmonic_minmax"); // operator instantiation
op.connect(0, my_fields_container);
op.connect(1, my_rpm_scoping);
op.connect(2, my_fs_ratio);
op.connect(3, my_num_subdivisions);
op.connect(4, my_max_num_subdivisions);
op.connect(5, my_num_cycles);
op.connect(6, my_use_harmonic_zero);
op.connect(7, my_calculate_time_series);
op.connect(8, my_substeps_selector);
ansys::dpf::FieldsContainer my_field_min = op.getOutput<ansys::dpf::FieldsContainer>(0);
ansys::dpf::FieldsContainer my_field_max = op.getOutput<ansys::dpf::FieldsContainer>(1);
ansys::dpf::FieldsContainer my_all_fields = op.getOutput<ansys::dpf::FieldsContainer>(2);

import ansys.dpf.core as dpf

op = dpf.operators.math.fft_multi_harmonic_minmax() # operator instantiation
op.inputs.fields_container.connect(my_fields_container)
op.inputs.rpm_scoping.connect(my_rpm_scoping)
op.inputs.fs_ratio.connect(my_fs_ratio)
op.inputs.num_subdivisions.connect(my_num_subdivisions)
op.inputs.max_num_subdivisions.connect(my_max_num_subdivisions)
op.inputs.num_cycles.connect(my_num_cycles)
op.inputs.use_harmonic_zero.connect(my_use_harmonic_zero)
op.inputs.calculate_time_series.connect(my_calculate_time_series)
op.inputs.substeps_selector.connect(my_substeps_selector)
my_field_min = op.outputs.field_min()
my_field_max = op.outputs.field_max()
my_all_fields = op.outputs.all_fields()

import mech_dpf
import Ans.DataProcessing as dpf

op = dpf.operators.math.fft_multi_harmonic_minmax() # operator instantiation
op.inputs.fields_container.Connect(my_fields_container)
op.inputs.rpm_scoping.Connect(my_rpm_scoping)
op.inputs.fs_ratio.Connect(my_fs_ratio)
op.inputs.num_subdivisions.Connect(my_num_subdivisions)
op.inputs.max_num_subdivisions.Connect(my_max_num_subdivisions)
op.inputs.num_cycles.Connect(my_num_cycles)
op.inputs.use_harmonic_zero.Connect(my_use_harmonic_zero)
op.inputs.calculate_time_series.Connect(my_calculate_time_series)
op.inputs.substeps_selector.Connect(my_substeps_selector)
my_field_min = op.outputs.field_min.GetData()
my_field_max = op.outputs.field_max.GetData()
my_all_fields = op.outputs.all_fields.GetData()

Changelog

• Version 0.0.0: Initial release.