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

Configuration for the thermostat operator. More...

#include <thermostat.h>

Public Attributes

size_t field_index
 
ThermostatMode mode
 
double E_target
 
double lambda_base
 
double lambda_soft_gain
 
double lambda_min
 
double lambda_max
 
double lambda_smooth
 
double lambda_rebuild_thresh
 
double softplus_k
 
double mu
 
bool auto_nu_guard
 
size_t memory_field
 
bool use_memory_field
 

Detailed Description

Configuration for the thermostat operator.

The operator updates internal scalars such as lambda_eff and optionally uses a memory target field for additive or multiplicative regulation modes.

Member Data Documentation

◆ auto_nu_guard

bool ThermostatOperatorConfig::auto_nu_guard

If true, compute minimal nu so Re(L) >= 0 when alpha < 0.

◆ E_target

double ThermostatOperatorConfig::E_target

Desired mean energy averaged over |u|^2.

◆ field_index

size_t ThermostatOperatorConfig::field_index

Target field containing u.

◆ lambda_base

double ThermostatOperatorConfig::lambda_base

Base (unregulated) lambda.

◆ lambda_max

double ThermostatOperatorConfig::lambda_max

Upper clamp; ignored if not finite.

◆ lambda_min

double ThermostatOperatorConfig::lambda_min

Lower clamp; ignored if not finite.

◆ lambda_rebuild_thresh

double ThermostatOperatorConfig::lambda_rebuild_thresh

Threshold for integrator rebuild trigger.

◆ lambda_smooth

double ThermostatOperatorConfig::lambda_smooth

Exponential smoothing factor [0,1].

◆ lambda_soft_gain

double ThermostatOperatorConfig::lambda_soft_gain

Gain applied to (E - E_target) in soft lambda.

◆ memory_field

size_t ThermostatOperatorConfig::memory_field

Index of M field; set to (size_t)-1 if unused.

◆ mode

ThermostatMode ThermostatOperatorConfig::mode

Regulation mode.

◆ mu

double ThermostatOperatorConfig::mu

Relaxation strength for ADD/MULT modes (0..1).

◆ softplus_k

double ThermostatOperatorConfig::softplus_k

Softness for smooth clamp (>=0).

◆ use_memory_field

bool ThermostatOperatorConfig::use_memory_field

True if memory_field refers to a valid field.


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