Oakfield API Documentation 1.0.0
Numerical core APIs
Loading...
Searching...
No Matches
SimFourierWaveformConfig Struct Reference

Configuration for Fourier waveform stimulus. More...

#include <fourier.h>

Public Attributes

size_t field_index
 
double amplitude
 
double frequency
 
double phase
 
double duty
 
double rotation
 
double nominal_dt
 
SimFourierWaveformShape shape
 
SimFourierWaveformMethod method
 
bool fixed_clock
 
bool scale_by_dt
 

Detailed Description

Configuration for Fourier waveform stimulus.

All frequencies are in Hz. Phase is normalized to [0,1).

Member Data Documentation

◆ amplitude

double SimFourierWaveformConfig::amplitude

Output amplitude.

◆ duty

double SimFourierWaveformConfig::duty

Duty cycle for square/triangle (0..1, default 0.5).

◆ field_index

size_t SimFourierWaveformConfig::field_index

Target field.

◆ fixed_clock

bool SimFourierWaveformConfig::fixed_clock

Use nominal_dt (or current dt) for phase increments.

◆ frequency

double SimFourierWaveformConfig::frequency

Fundamental frequency (Hz).

◆ method

SimFourierWaveformMethod SimFourierWaveformConfig::method

Bandlimiting strategy.

◆ nominal_dt

double SimFourierWaveformConfig::nominal_dt

Optional fixed clock dt when fixed_clock is true.

◆ phase

double SimFourierWaveformConfig::phase

Initial phase in cycles [0,1).

◆ rotation

double SimFourierWaveformConfig::rotation

Rotation when writing complex fields (radians).

◆ scale_by_dt

bool SimFourierWaveformConfig::scale_by_dt

Scale writes by substep dt (force-like semantics).

◆ shape

SimFourierWaveformShape SimFourierWaveformConfig::shape

Waveform shape.


The documentation for this struct was generated from the following file: