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

Configuration for a regularized cylindrical wave-emitter stimulus. More...

#include <cylindrical_wave_emitter.h>

Collaboration diagram for SimStimulusCylindricalWaveEmitterConfig:

Public Attributes

size_t field_index
 
double amplitude
 
double radial_wavenumber
 
double attenuation
 
double softening_radius
 
double center_u
 
double center_v
 
double velocity_u
 
double velocity_v
 
double omega
 
double phase
 
SimStimulusCoordConfig coord
 
double time_offset
 
double rotation
 
bool scale_by_dt
 

Detailed Description

Configuration for a regularized cylindrical wave-emitter stimulus.

Member Data Documentation

◆ amplitude

double SimStimulusCylindricalWaveEmitterConfig::amplitude

Output amplitude scale.

◆ attenuation

double SimStimulusCylindricalWaveEmitterConfig::attenuation

Exponential attenuation alpha.

◆ center_u

double SimStimulusCylindricalWaveEmitterConfig::center_u

Emitter center in local u.

◆ center_v

double SimStimulusCylindricalWaveEmitterConfig::center_v

Emitter center in local v.

◆ coord

SimStimulusCoordConfig SimStimulusCylindricalWaveEmitterConfig::coord

Coordinate mapping into the local chart.

◆ field_index

size_t SimStimulusCylindricalWaveEmitterConfig::field_index

Target field index.

◆ omega

double SimStimulusCylindricalWaveEmitterConfig::omega

Temporal angular frequency.

◆ phase

double SimStimulusCylindricalWaveEmitterConfig::phase

Phase offset.

◆ radial_wavenumber

double SimStimulusCylindricalWaveEmitterConfig::radial_wavenumber

Radial wavenumber k_r.

◆ rotation

double SimStimulusCylindricalWaveEmitterConfig::rotation

Global complex-output rotation.

◆ scale_by_dt

bool SimStimulusCylindricalWaveEmitterConfig::scale_by_dt

Scale writes by dt when true.

◆ softening_radius

double SimStimulusCylindricalWaveEmitterConfig::softening_radius

Core radius a used to regularize r_a.

◆ time_offset

double SimStimulusCylindricalWaveEmitterConfig::time_offset

Additional time offset before evaluation.

◆ velocity_u

double SimStimulusCylindricalWaveEmitterConfig::velocity_u

Emitter-center drift in local u.

◆ velocity_v

double SimStimulusCylindricalWaveEmitterConfig::velocity_v

Emitter-center drift in local v.


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