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

Configuration for a drifting Gaussian-envelope traveling wave packet. More...

#include <traveling_wave_packet.h>

Collaboration diagram for SimStimulusTravelingWavePacketConfig:

Public Attributes

size_t field_index
 
double amplitude
 
double sigma_u
 
double sigma_v
 
double center_u
 
double center_v
 
double velocity_u
 
double velocity_v
 
double orientation
 
double orientation_rate
 
double carrier_u
 
double carrier_v
 
double omega
 
double phase
 
SimStimulusCoordConfig coord
 
double time_offset
 
double rotation
 
bool scale_by_dt
 

Detailed Description

Configuration for a drifting Gaussian-envelope traveling wave packet.

Member Data Documentation

◆ amplitude

double SimStimulusTravelingWavePacketConfig::amplitude

Output amplitude scale.

◆ carrier_u

double SimStimulusTravelingWavePacketConfig::carrier_u

Carrier wavenumber along local u.

◆ carrier_v

double SimStimulusTravelingWavePacketConfig::carrier_v

Carrier wavenumber along local v.

◆ center_u

double SimStimulusTravelingWavePacketConfig::center_u

Packet center in local u.

◆ center_v

double SimStimulusTravelingWavePacketConfig::center_v

Packet center in local v.

◆ coord

SimStimulusCoordConfig SimStimulusTravelingWavePacketConfig::coord

Coordinate mapping into the local packet frame.

◆ field_index

size_t SimStimulusTravelingWavePacketConfig::field_index

Target field index.

◆ omega

double SimStimulusTravelingWavePacketConfig::omega

Temporal angular frequency.

◆ orientation

double SimStimulusTravelingWavePacketConfig::orientation

Local packet orientation angle.

◆ orientation_rate

double SimStimulusTravelingWavePacketConfig::orientation_rate

Orientation drift rate.

◆ phase

double SimStimulusTravelingWavePacketConfig::phase

Phase offset.

◆ rotation

double SimStimulusTravelingWavePacketConfig::rotation

Global complex-output rotation.

◆ scale_by_dt

bool SimStimulusTravelingWavePacketConfig::scale_by_dt

Scale writes by dt when true.

◆ sigma_u

double SimStimulusTravelingWavePacketConfig::sigma_u

Gaussian packet width along local u.

◆ sigma_v

double SimStimulusTravelingWavePacketConfig::sigma_v

Gaussian packet width along local v.

◆ time_offset

double SimStimulusTravelingWavePacketConfig::time_offset

Additional time offset before evaluation.

◆ velocity_u

double SimStimulusTravelingWavePacketConfig::velocity_u

Packet-center drift in local u.

◆ velocity_v

double SimStimulusTravelingWavePacketConfig::velocity_v

Packet-center drift in local v.


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