SimStimulusWaveModesConfig Struct Reference

Configuration for rectangular standing wave-equation mode stimuli. More...

#include <wave_modes.h>

Collaboration diagram for SimStimulusWaveModesConfig:

Public Attributes
size_t	field_index
double	amplitude
unsigned int	mode_u
unsigned int	mode_v
double	extent_u
double	extent_v
double	wave_speed
double	phase
SimStimulusCoordConfig	coord
double	time_offset
double	rotation
bool	scale_by_dt

Detailed Description

Configuration for rectangular standing wave-equation mode stimuli.

Member Data Documentation

amplitude

double SimStimulusWaveModesConfig::amplitude

Output amplitude scale.

coord

SimStimulusCoordConfig SimStimulusWaveModesConfig::coord

Coordinate mapping into the local chart.

extent_u

double SimStimulusWaveModesConfig::extent_u

Rectangular extent along local u.

extent_v

double SimStimulusWaveModesConfig::extent_v

Rectangular extent along local v.

field_index

size_t SimStimulusWaveModesConfig::field_index

Target field index.

mode_u

unsigned int SimStimulusWaveModesConfig::mode_u

Standing-mode index along local u.

mode_v

unsigned int SimStimulusWaveModesConfig::mode_v

Standing-mode index along local v.

phase

double SimStimulusWaveModesConfig::phase

Global phase offset (radians).

rotation

double SimStimulusWaveModesConfig::rotation

Complex-output rotation (radians).

scale_by_dt

bool SimStimulusWaveModesConfig::scale_by_dt

When true, scale writes by dt.

time_offset

double SimStimulusWaveModesConfig::time_offset

Additional time shift before evaluation.

wave_speed

double SimStimulusWaveModesConfig::wave_speed

Wave speed c used to derive omega_{m,n}.

---

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

• wave_modes.h