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

Configuration parameters for integrator construction. More...

#include <integrator.h>

Collaboration diagram for IntegratorConfig:

Public Attributes

IntegratorDriftFn drift
 
IntegratorNoiseFn noise
 
IntegratorDestroyFn destroy
 
void * userdata
 
size_t target_field_index
 
double initial_dt
 
double min_dt
 
double max_dt
 
double tolerance
 
double safety
 
bool adaptive
 
bool enable_stochastic
 
double stochastic_strength
 
uint32_t random_seed
 
size_t workspace_hint
 
double subordination_alpha
 
size_t subordination_quadrature_n
 

Detailed Description

Configuration parameters for integrator construction.

Zero-initialized optional fields select the defaults in integrator_configure(). The drift callback is required for all concrete integrators.

Member Data Documentation

◆ adaptive

bool IntegratorConfig::adaptive

Enable adaptive timestep control.

◆ destroy

IntegratorDestroyFn IntegratorConfig::destroy

Optional teardown hook for integrator-owned state.

◆ drift

IntegratorDriftFn IntegratorConfig::drift

Deterministic drift evaluator (required).

◆ enable_stochastic

bool IntegratorConfig::enable_stochastic

Enable stochastic source injection.

◆ initial_dt

double IntegratorConfig::initial_dt

Initial timestep suggestion.

◆ max_dt

double IntegratorConfig::max_dt

Upper bound on adaptive timesteps.

◆ min_dt

double IntegratorConfig::min_dt

Lower bound on adaptive timesteps.

◆ noise

IntegratorNoiseFn IntegratorConfig::noise

Optional stochastic sample generator.

◆ random_seed

uint32_t IntegratorConfig::random_seed

Seed for the internal RNG.

◆ safety

double IntegratorConfig::safety

Safety factor for step adjustment.

◆ stochastic_strength

double IntegratorConfig::stochastic_strength

Scaling applied to stochastic sources.

◆ subordination_alpha

double IntegratorConfig::subordination_alpha

Optional alpha override for the subordination integrator.

◆ subordination_quadrature_n

size_t IntegratorConfig::subordination_quadrature_n

Optional quadrature sample count override for subordination.

◆ target_field_index

size_t IntegratorConfig::target_field_index

Context field index advanced by this integrator.

◆ tolerance

double IntegratorConfig::tolerance

Error tolerance for adaptivity.

◆ userdata

void* IntegratorConfig::userdata

User payload forwarded to callbacks.

◆ workspace_hint

size_t IntegratorConfig::workspace_hint

Optional preallocation hint (elements).


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