hysteretic.h

Go to the documentation of this file.

 
#ifndef OAKFIELD_HYSTERETIC_H
#define OAKFIELD_HYSTERETIC_H
 
#include "oakfield/operator_split.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct SimContext;
 
typedef enum SimHystereticMode {
    SIM_HYSTERETIC_MODE_SCHMITT = 0, 
    SIM_HYSTERETIC_MODE_PLAY,        
    SIM_HYSTERETIC_MODE_BOUC_WEN     
} SimHystereticMode;
 
typedef enum SimHystereticThresholdMode {
    SIM_HYSTERETIC_THRESHOLD_BOUNDS = 0,  
    SIM_HYSTERETIC_THRESHOLD_CENTER_WIDTH 
} SimHystereticThresholdMode;
 
typedef enum SimHystereticInputMode {
    SIM_HYSTERETIC_INPUT_DIRECT = 0, 
    SIM_HYSTERETIC_INPUT_ABS,        
    SIM_HYSTERETIC_INPUT_SQUARED     
} SimHystereticInputMode;
 
typedef struct SimHystereticOperatorConfig {
    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;                        
} SimHystereticOperatorConfig;
 
SimResult sim_add_hysteretic_operator(struct SimContext *context,
                                      const SimHystereticOperatorConfig *config, size_t *out_index);
 
SimResult sim_hysteretic_config(struct SimContext *context, size_t operator_index,
                                SimHystereticOperatorConfig *out_config);
 
SimResult sim_hysteretic_update(struct SimContext *context, size_t operator_index,
                                const SimHystereticOperatorConfig *config);
 
#ifdef __cplusplus
}
#endif
 
#endif /* OAKFIELD_HYSTERETIC_H */