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

Configuration for hysteretic operators. More...

#include <hysteretic.h>

Public Attributes

size_t input_field
 
size_t output_field
 
SimHystereticMode mode
 
SimHystereticThresholdMode threshold_mode
 
SimHystereticInputMode input_mode
 
double input_gain
 
double input_bias
 
double threshold_low
 
double threshold_high
 
double threshold_center
 
double threshold_width
 
double output_low
 
double output_high
 
double state_min
 
double state_max
 
double smooth
 
double rate_limit
 
bool accumulate
 
bool scale_by_dt
 
bool initialize_from_input
 
double initial_output
 
double initial_input
 
double initial_z
 
double play_radius
 
double bw_alpha
 
double bw_A
 
double bw_beta
 
double bw_gamma
 
double bw_n
 
double bw_z_clamp
 
double bw_xdot_clamp
 
double output_gain
 
double output_bias
 

Detailed Description

Configuration for hysteretic operators.

Member Data Documentation

◆ accumulate

bool SimHystereticOperatorConfig::accumulate

Accumulate into output.

◆ bw_A

double SimHystereticOperatorConfig::bw_A

Bouc-Wen A scale.

◆ bw_alpha

double SimHystereticOperatorConfig::bw_alpha

Bouc-Wen alpha (linear blend).

◆ bw_beta

double SimHystereticOperatorConfig::bw_beta

Bouc-Wen beta parameter.

◆ bw_gamma

double SimHystereticOperatorConfig::bw_gamma

Bouc-Wen gamma parameter.

◆ bw_n

double SimHystereticOperatorConfig::bw_n

Bouc-Wen exponent n (>=1).

◆ bw_xdot_clamp

double SimHystereticOperatorConfig::bw_xdot_clamp

Clamp for input derivative (<=0 disables).

◆ bw_z_clamp

double SimHystereticOperatorConfig::bw_z_clamp

Clamp for Bouc-Wen z state (<=0 disables).

◆ initial_input

double SimHystereticOperatorConfig::initial_input

Initial input history (Bouc-Wen).

◆ initial_output

double SimHystereticOperatorConfig::initial_output

Initial output state.

◆ initial_z

double SimHystereticOperatorConfig::initial_z

Initial Bouc-Wen internal state.

◆ initialize_from_input

bool SimHystereticOperatorConfig::initialize_from_input

Initialize state from input.

◆ input_bias

double SimHystereticOperatorConfig::input_bias

Input bias.

◆ input_field

size_t SimHystereticOperatorConfig::input_field

Input field index.

◆ input_gain

double SimHystereticOperatorConfig::input_gain

Input scaling factor.

◆ input_mode

SimHystereticInputMode SimHystereticOperatorConfig::input_mode

Input preprocessing mode.

◆ mode

SimHystereticMode SimHystereticOperatorConfig::mode

Hysteresis mode.

◆ output_bias

double SimHystereticOperatorConfig::output_bias

Output bias.

◆ output_field

size_t SimHystereticOperatorConfig::output_field

Output field index.

◆ output_gain

double SimHystereticOperatorConfig::output_gain

Output scaling factor.

◆ output_high

double SimHystereticOperatorConfig::output_high

Schmitt high output value.

◆ output_low

double SimHystereticOperatorConfig::output_low

Schmitt low output value.

◆ play_radius

double SimHystereticOperatorConfig::play_radius

Play/deadband radius (<=0 uses band).

◆ rate_limit

double SimHystereticOperatorConfig::rate_limit

Max |delta| per second (0 disables).

◆ scale_by_dt

bool SimHystereticOperatorConfig::scale_by_dt

Scale accumulation by dt.

◆ smooth

double SimHystereticOperatorConfig::smooth

Output smoothing factor [0,1].

◆ state_max

double SimHystereticOperatorConfig::state_max

Clamp max for internal state.

◆ state_min

double SimHystereticOperatorConfig::state_min

Clamp min for internal state.

◆ threshold_center

double SimHystereticOperatorConfig::threshold_center

Threshold center (center/width mode).

◆ threshold_high

double SimHystereticOperatorConfig::threshold_high

Upper threshold (bounds mode).

◆ threshold_low

double SimHystereticOperatorConfig::threshold_low

Lower threshold (bounds mode).

◆ threshold_mode

SimHystereticThresholdMode SimHystereticOperatorConfig::threshold_mode

Threshold mode.

◆ threshold_width

double SimHystereticOperatorConfig::threshold_width

Threshold width (center/width mode).


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