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

Configuration for a diffusive Gaussian heat-kernel stimulus. More...

#include <heat_kernel.h>

Collaboration diagram for SimStimulusHeatKernelConfig:

Public Attributes

size_t field_index
 
double amplitude
 
double diffusivity
 
double sigma_x
 
double sigma_y
 
double time_offset
 
SimStimulusCoordConfig coord
 
double rotation
 
double nominal_dt
 
bool fixed_clock
 
bool scale_by_dt
 
bool preserve_mass
 

Detailed Description

Configuration for a diffusive Gaussian heat-kernel stimulus.

Member Data Documentation

◆ amplitude

double SimStimulusHeatKernelConfig::amplitude

Initial amplitude scale.

◆ coord

SimStimulusCoordConfig SimStimulusHeatKernelConfig::coord

Spatial coordinate mapping configuration.

◆ diffusivity

double SimStimulusHeatKernelConfig::diffusivity

Heat diffusivity D (units^2 / s).

◆ field_index

size_t SimStimulusHeatKernelConfig::field_index

Target field index.

◆ fixed_clock

bool SimStimulusHeatKernelConfig::fixed_clock

Hold the driving clock to nominal_dt when true.

◆ nominal_dt

double SimStimulusHeatKernelConfig::nominal_dt

Nominal dt used when fixed_clock is true.

◆ preserve_mass

bool SimStimulusHeatKernelConfig::preserve_mass

Preserve integrated mass as the profile broadens.

◆ rotation

double SimStimulusHeatKernelConfig::rotation

Complex output rotation (radians).

◆ scale_by_dt

bool SimStimulusHeatKernelConfig::scale_by_dt

When true, scale writes by dt.

◆ sigma_x

double SimStimulusHeatKernelConfig::sigma_x

Initial sigma along X (units).

◆ sigma_y

double SimStimulusHeatKernelConfig::sigma_y

Initial sigma along Y (units).

◆ time_offset

double SimStimulusHeatKernelConfig::time_offset

Extra time shift before evaluation.


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