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

Configuration parameters for the legacy sinusoidal stimulus operator. More...

#include <stimulus.h>

Collaboration diagram for StimulusOperatorConfig:

Public Attributes

size_t field_index
 
double amplitude
 
double wavenumber
 
double omega
 
double phase
 
SimStimulusCoordConfig coord
 
double time_offset
 
bool scale_by_dt
 

Detailed Description

Configuration parameters for the legacy sinusoidal stimulus operator.

Member Data Documentation

◆ amplitude

double StimulusOperatorConfig::amplitude

Signal amplitude.

◆ coord

SimStimulusCoordConfig StimulusOperatorConfig::coord

Spatial coordinate mapping configuration.

◆ field_index

size_t StimulusOperatorConfig::field_index

Field index receiving the forcing term.

◆ omega

double StimulusOperatorConfig::omega

Angular frequency (rad / s).

◆ phase

double StimulusOperatorConfig::phase

Phase offset (radians).

◆ scale_by_dt

bool StimulusOperatorConfig::scale_by_dt

When true, scale writes by substep dt; false = dt-independent signal.

◆ time_offset

double StimulusOperatorConfig::time_offset

Time offset applied before evaluating the driving function.

◆ wavenumber

double StimulusOperatorConfig::wavenumber

Spatial wavenumber (rad / unit).


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