Configuration for harmonic spectral-line stimulus fields. More...
#include <spectral_lines.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 |
| unsigned int | harmonic_count |
| double | harmonic_power |
| SimStimulusSpectralLinesTwistKind | twist_kind |
| unsigned int | twist_q |
| unsigned int | twist_k |
| SimStimulusSpectralLinesTwistPreset | twist_preset |
| bool | twist_zero_non_units |
| bool | twist_table_is_complex |
| bool | use_wavevector |
| bool | fixed_clock |
| bool | scale_by_dt |
Detailed Description
Configuration for harmonic spectral-line stimulus fields.
Member Data Documentation
◆ amplitude
| double SimStimulusSpectralLinesConfig::amplitude |
Base amplitude for the first harmonic.
◆ coord
| SimStimulusCoordConfig SimStimulusSpectralLinesConfig::coord |
Spatial coordinate mapping configuration.
◆ field_index
| size_t SimStimulusSpectralLinesConfig::field_index |
Target field index.
◆ fixed_clock
| bool SimStimulusSpectralLinesConfig::fixed_clock |
Lock evolution to nominal_dt instead of adaptive dt.
◆ harmonic_count
| unsigned int SimStimulusSpectralLinesConfig::harmonic_count |
Number of harmonics (>= 1).
◆ harmonic_power
| double SimStimulusSpectralLinesConfig::harmonic_power |
Power-law exponent p in 1 / n^p amplitude scaling.
◆ kx
| double SimStimulusSpectralLinesConfig::kx |
Optional wavevector X component (rad / unit).
◆ ky
| double SimStimulusSpectralLinesConfig::ky |
Optional wavevector Y component (rad / unit).
◆ nominal_dt
| double SimStimulusSpectralLinesConfig::nominal_dt |
Nominal dt when fixed_clock is enabled.
◆ omega
| double SimStimulusSpectralLinesConfig::omega |
Base temporal frequency ω0 (rad / s).
◆ phase
| double SimStimulusSpectralLinesConfig::phase |
Base phase offset φ0 (radians).
◆ scale_by_dt
| bool SimStimulusSpectralLinesConfig::scale_by_dt |
Scale writes by dt when true; else dt-independent.
◆ time_offset
| double SimStimulusSpectralLinesConfig::time_offset |
Additional time shift applied before evaluation.
◆ twist_k
| unsigned int SimStimulusSpectralLinesConfig::twist_k |
Optional character index (Mathematica-style).
◆ twist_kind
| SimStimulusSpectralLinesTwistKind SimStimulusSpectralLinesConfig::twist_kind |
Harmonic twist mode.
◆ twist_preset
| SimStimulusSpectralLinesTwistPreset SimStimulusSpectralLinesConfig::twist_preset |
DIRICHLET preset selector.
◆ twist_q
| unsigned int SimStimulusSpectralLinesConfig::twist_q |
Modulus q for DIRICHLET twist mode.
◆ twist_table_is_complex
| bool SimStimulusSpectralLinesConfig::twist_table_is_complex |
When true, χ-table imaginary values are used.
◆ twist_zero_non_units
| bool SimStimulusSpectralLinesConfig::twist_zero_non_units |
Zero χ on non-units for table mode (gcd(n,q) != 1).
◆ use_wavevector
| bool SimStimulusSpectralLinesConfig::use_wavevector |
When true, use (kx,ky) instead of wavenumber+coord.
◆ wavenumber
| double SimStimulusSpectralLinesConfig::wavenumber |
Base spatial wavenumber k0 (rad / unit).
The documentation for this struct was generated from the following file:
