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

Configuration for seeded random modes sampled from spectral shells. More...

#include <spectral_shells.h>

Collaboration diagram for SimStimulusSpectralShellsConfig:

Public Attributes

size_t field_index
 
double amplitude
 
double k_min
 
double k_max
 
double shell_width
 
double omega
 
SimStimulusCoordConfig coord
 
double time_offset
 
double nominal_dt
 
double spectral_slope
 
unsigned int shell_count
 
unsigned int modes_per_shell
 
uint64_t seed
 
bool fixed_clock
 
bool scale_by_dt
 

Detailed Description

Configuration for seeded random modes sampled from spectral shells.

Member Data Documentation

◆ amplitude

double SimStimulusSpectralShellsConfig::amplitude

Overall amplitude scale.

◆ coord

SimStimulusCoordConfig SimStimulusSpectralShellsConfig::coord

Sampling lattice origin/spacing.

◆ field_index

size_t SimStimulusSpectralShellsConfig::field_index

Target field index.

◆ fixed_clock

bool SimStimulusSpectralShellsConfig::fixed_clock

Lock evolution to nominal_dt instead of adaptive dt.

◆ k_max

double SimStimulusSpectralShellsConfig::k_max

Maximum shell radius in k-space (rad / unit).

◆ k_min

double SimStimulusSpectralShellsConfig::k_min

Minimum shell radius in k-space (rad / unit).

◆ modes_per_shell

unsigned int SimStimulusSpectralShellsConfig::modes_per_shell

Random Fourier modes per shell.

◆ nominal_dt

double SimStimulusSpectralShellsConfig::nominal_dt

Nominal dt when fixed_clock is enabled.

◆ omega

double SimStimulusSpectralShellsConfig::omega

Temporal angular frequency Ω (rad / s).

◆ scale_by_dt

bool SimStimulusSpectralShellsConfig::scale_by_dt

Scale writes by dt when true; else dt-independent.

◆ seed

uint64_t SimStimulusSpectralShellsConfig::seed

RNG seed for deterministic shell realization.

◆ shell_count

unsigned int SimStimulusSpectralShellsConfig::shell_count

Number of concentric shells.

◆ shell_width

double SimStimulusSpectralShellsConfig::shell_width

Width of each shell (rad / unit); 0 = auto.

◆ spectral_slope

double SimStimulusSpectralShellsConfig::spectral_slope

Spectral slope exponent β, PSD ∝ |k|^{-β}.

◆ time_offset

double SimStimulusSpectralShellsConfig::time_offset

Additional time shift applied before evaluation.


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