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

Configuration for a Chladni nodal-line stimulus on a rectangular plate. More...

#include <chladni.h>

Collaboration diagram for SimStimulusChladniConfig:

Public Attributes

size_t field_index
 
double amplitude
 
unsigned int mode_x
 
unsigned int mode_y
 
double plate_width
 
double plate_height
 
double mix
 
double line_width
 
double omega
 
double phase
 
SimStimulusCoordConfig coord
 
double time_offset
 
double rotation
 
bool scale_by_dt
 

Detailed Description

Configuration for a Chladni nodal-line stimulus on a rectangular plate.

Member Data Documentation

◆ amplitude

double SimStimulusChladniConfig::amplitude

Overall write amplitude.

◆ coord

SimStimulusCoordConfig SimStimulusChladniConfig::coord

Coordinate mapping into the plate frame.

◆ field_index

size_t SimStimulusChladniConfig::field_index

Target field index.

◆ line_width

double SimStimulusChladniConfig::line_width

Gaussian band width around the nodal set.

◆ mix

double SimStimulusChladniConfig::mix

Antisymmetric blend factor between swapped modes.

◆ mode_x

unsigned int SimStimulusChladniConfig::mode_x

Plate mode number m along local u.

◆ mode_y

unsigned int SimStimulusChladniConfig::mode_y

Plate mode number n along local v.

◆ omega

double SimStimulusChladniConfig::omega

Temporal angular frequency (rad/s).

◆ phase

double SimStimulusChladniConfig::phase

Phase offset (radians).

◆ plate_height

double SimStimulusChladniConfig::plate_height

Plate height Ly in local v coordinates.

◆ plate_width

double SimStimulusChladniConfig::plate_width

Plate width Lx in local u coordinates.

◆ rotation

double SimStimulusChladniConfig::rotation

Complex-output rotation (radians).

◆ scale_by_dt

bool SimStimulusChladniConfig::scale_by_dt

When true, scale writes by dt.

◆ time_offset

double SimStimulusChladniConfig::time_offset

Additional time offset before evaluation.


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