Shared configuration for sinusoidal stimulus variants. More...
#include <sinusoidal.h>
Public Attributes | |
| size_t | field_index |
| double | amplitude |
| double | wavenumber |
| double | kx |
| double | ky |
| double | omega |
| double | phase |
| SimStimulusCoordConfig | coord |
| double | time_offset |
| double | nominal_dt |
| double | kdot |
| double | wdot |
| double | rotation |
| bool | use_wavevector |
| bool | fixed_clock |
| bool | scale_by_dt |
Detailed Description
Shared configuration for sinusoidal stimulus variants.
Member Data Documentation
◆ amplitude
| double SimStimulusSinusoidalConfig::amplitude |
Signal amplitude.
◆ coord
| SimStimulusCoordConfig SimStimulusSinusoidalConfig::coord |
Spatial coordinate mapping configuration.
◆ field_index
| size_t SimStimulusSinusoidalConfig::field_index |
Target field index.
◆ fixed_clock
| bool SimStimulusSinusoidalConfig::fixed_clock |
Lock the driving clock to nominal_dt instead of adaptive dt.
◆ kdot
| double SimStimulusSinusoidalConfig::kdot |
Wavenumber sweep rate for chirp (rad / unit / s).
◆ kx
| double SimStimulusSinusoidalConfig::kx |
Optional wavevector X component (rad / unit).
◆ ky
| double SimStimulusSinusoidalConfig::ky |
Optional wavevector Y component (rad / unit).
◆ nominal_dt
| double SimStimulusSinusoidalConfig::nominal_dt |
Optional nominal dt when fixed_clock is enabled (<=0 uses actual dt).
◆ omega
| double SimStimulusSinusoidalConfig::omega |
Base angular frequency (rad / s).
◆ phase
| double SimStimulusSinusoidalConfig::phase |
Global phase offset (radians).
◆ rotation
| double SimStimulusSinusoidalConfig::rotation |
Rotation applied when writing into complex fields (radians).
◆ scale_by_dt
| bool SimStimulusSinusoidalConfig::scale_by_dt |
When true, scale writes by substep dt; false = dt-independent signal.
◆ time_offset
| double SimStimulusSinusoidalConfig::time_offset |
Additional time offset applied before evaluation.
◆ use_wavevector
| bool SimStimulusSinusoidalConfig::use_wavevector |
When true, use (kx,ky) instead of wavenumber+coord.
◆ wavenumber
| double SimStimulusSinusoidalConfig::wavenumber |
Base spatial wavenumber (rad / unit).
◆ wdot
| double SimStimulusSinusoidalConfig::wdot |
Frequency sweep rate for chirp (rad / s^2).
The documentation for this struct was generated from the following file:
