operators/stimulus/fourier.h

Go to the documentation of this file.

 
#ifndef OAKFIELD_STIMULUS_FOURIER_H
#define OAKFIELD_STIMULUS_FOURIER_H
 
#include "oakfield/operator_split.h"
 
#include <stdbool.h>
#include <stddef.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct SimContext;
 
typedef enum SimFourierWaveformShape {
    SIM_FOURIER_WAVEFORM_SAW = 0, 
    SIM_FOURIER_WAVEFORM_SQUARE,  
    SIM_FOURIER_WAVEFORM_TRIANGLE 
} SimFourierWaveformShape;
 
typedef enum SimFourierWaveformMethod {
    SIM_FOURIER_METHOD_BLIT = 0, 
    SIM_FOURIER_METHOD_POLYBLEP, 
    SIM_FOURIER_METHOD_MINIBLEP  
} SimFourierWaveformMethod;
 
typedef struct SimFourierWaveformConfig {
    size_t field_index;              
    double amplitude;                
    double frequency;                
    double phase;                    
    double duty;                     
    double rotation;                 
    double nominal_dt;               
    SimFourierWaveformShape shape;   
    SimFourierWaveformMethod method; 
    bool fixed_clock;                
    bool scale_by_dt;                
} SimFourierWaveformConfig;
 
SimResult sim_add_stimulus_fourier_operator(struct SimContext *context,
                                            const SimFourierWaveformConfig *config,
                                            size_t *out_index);
 
SimResult sim_stimulus_fourier_config(struct SimContext *context, size_t operator_index,
                                      SimFourierWaveformConfig *out_config);
 
SimResult sim_stimulus_fourier_update(struct SimContext *context, size_t operator_index,
                                      const SimFourierWaveformConfig *config);
 
#ifdef __cplusplus
}
#endif
 
#endif /* OAKFIELD_STIMULUS_FOURIER_H */