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

Configuration for a separable Hermite-Gaussian beam stimulus. More...

#include <hermite_gaussian_beam.h>

Collaboration diagram for SimStimulusHermiteGaussianBeamConfig:

Public Attributes

size_t field_index
 
double amplitude
 
unsigned int mode_u
 
unsigned int mode_v
 
double waist_u
 
double waist_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 separable Hermite-Gaussian beam stimulus.

Member Data Documentation

◆ amplitude

double SimStimulusHermiteGaussianBeamConfig::amplitude

Output amplitude scale.

◆ carrier_u

double SimStimulusHermiteGaussianBeamConfig::carrier_u

Carrier tilt along local u.

◆ carrier_v

double SimStimulusHermiteGaussianBeamConfig::carrier_v

Carrier tilt along local v.

◆ center_u

double SimStimulusHermiteGaussianBeamConfig::center_u

Beam center in local u.

◆ center_v

double SimStimulusHermiteGaussianBeamConfig::center_v

Beam center in local v.

◆ coord

SimStimulusCoordConfig SimStimulusHermiteGaussianBeamConfig::coord

Coordinate mapping into the local beam frame.

◆ field_index

size_t SimStimulusHermiteGaussianBeamConfig::field_index

Target field index.

◆ mode_u

unsigned int SimStimulusHermiteGaussianBeamConfig::mode_u

Hermite mode index along local u.

◆ mode_v

unsigned int SimStimulusHermiteGaussianBeamConfig::mode_v

Hermite mode index along local v.

◆ omega

double SimStimulusHermiteGaussianBeamConfig::omega

Temporal angular frequency.

◆ orientation

double SimStimulusHermiteGaussianBeamConfig::orientation

Local beam orientation angle.

◆ orientation_rate

double SimStimulusHermiteGaussianBeamConfig::orientation_rate

Orientation drift rate.

◆ phase

double SimStimulusHermiteGaussianBeamConfig::phase

Phase offset.

◆ rotation

double SimStimulusHermiteGaussianBeamConfig::rotation

Global complex-output rotation.

◆ scale_by_dt

bool SimStimulusHermiteGaussianBeamConfig::scale_by_dt

Scale writes by dt when true.

◆ time_offset

double SimStimulusHermiteGaussianBeamConfig::time_offset

Additional time offset before evaluation.

◆ velocity_u

double SimStimulusHermiteGaussianBeamConfig::velocity_u

Beam center drift in local u.

◆ velocity_v

double SimStimulusHermiteGaussianBeamConfig::velocity_v

Beam center drift in local v.

◆ waist_u

double SimStimulusHermiteGaussianBeamConfig::waist_u

Beam waist along local u.

◆ waist_v

double SimStimulusHermiteGaussianBeamConfig::waist_v

Beam waist along local v.


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