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

Configuration for an integer-order cylindrical Bessel beam stimulus. More...

#include <bessel_beam.h>

Collaboration diagram for SimStimulusBesselBeamConfig:

Public Attributes

size_t field_index
 
double amplitude
 
int order
 
double radial_wavenumber
 
double scale_u
 
double scale_v
 
double center_u
 
double center_v
 
double velocity_u
 
double velocity_v
 
double orientation
 
double orientation_rate
 
double omega
 
double phase
 
SimStimulusCoordConfig coord
 
double time_offset
 
double rotation
 
bool scale_by_dt
 

Detailed Description

Configuration for an integer-order cylindrical Bessel beam stimulus.

Member Data Documentation

◆ amplitude

double SimStimulusBesselBeamConfig::amplitude

Output amplitude scale.

◆ center_u

double SimStimulusBesselBeamConfig::center_u

Beam center in local u.

◆ center_v

double SimStimulusBesselBeamConfig::center_v

Beam center in local v.

◆ coord

SimStimulusCoordConfig SimStimulusBesselBeamConfig::coord

Coordinate mapping into the local beam frame.

◆ field_index

size_t SimStimulusBesselBeamConfig::field_index

Target field index.

◆ omega

double SimStimulusBesselBeamConfig::omega

Temporal angular frequency.

◆ order

int SimStimulusBesselBeamConfig::order

Integer Bessel order n.

◆ orientation

double SimStimulusBesselBeamConfig::orientation

Local beam orientation angle.

◆ orientation_rate

double SimStimulusBesselBeamConfig::orientation_rate

Orientation drift rate.

◆ phase

double SimStimulusBesselBeamConfig::phase

Phase offset.

◆ radial_wavenumber

double SimStimulusBesselBeamConfig::radial_wavenumber

Radial wavenumber k_r.

◆ rotation

double SimStimulusBesselBeamConfig::rotation

Global complex-output rotation.

◆ scale_by_dt

bool SimStimulusBesselBeamConfig::scale_by_dt

Scale writes by dt when true.

◆ scale_u

double SimStimulusBesselBeamConfig::scale_u

Radial scale along local u.

◆ scale_v

double SimStimulusBesselBeamConfig::scale_v

Radial scale along local v.

◆ time_offset

double SimStimulusBesselBeamConfig::time_offset

Additional time offset before evaluation.

◆ velocity_u

double SimStimulusBesselBeamConfig::velocity_u

Beam center drift in local u.

◆ velocity_v

double SimStimulusBesselBeamConfig::velocity_v

Beam center drift in local v.


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