digamma_square.h

Go to the documentation of this file.

 
#ifndef OAKFIELD_STIMULUS_DIGAMMA_SQUARE_H
#define OAKFIELD_STIMULUS_DIGAMMA_SQUARE_H
 
#include "coords.h"
#include "oakfield/math/special_functions.h"
#include "oakfield/operator_split.h"
#include "oakfield/operators/coupling/mixer.h"
 
#include <stdbool.h>
#include <stddef.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct SimContext;
 
typedef enum SimDigammaSquareWaveformShape {
    SIM_DIGAMMA_SQUARE_WAVEFORM_DEFAULT = 0, 
    SIM_DIGAMMA_SQUARE_WAVEFORM_TRIANGLE,    
    SIM_DIGAMMA_SQUARE_WAVEFORM_SAWTOOTH     
} SimDigammaSquareWaveformShape;
 
typedef struct SimStimulusDigammaSquareConfig {
    size_t field_index;           
    size_t warp_field_index;      
    double amplitude;             
    double wavenumber;            
    double kx;                    
    double ky;                    
    double omega;                 
    double phase;                 
    SimStimulusCoordConfig coord; 
    double time_offset;           
    double nominal_dt; 
    double velocity;   
    double harmonics;  
    double a;          
    double rotation;   
    double tolerance;  
    bool fixed_clock;  
    bool scale_by_dt;  
    bool use_wavevector;                 
    bool use_warp;                       
    double warp_mix;                     
    double warp_bias;                    
    SimMixerMode warp_mode;              
    SimDigammaBackend backend;           
    SimDigammaSquareWaveformShape shape; 
} SimStimulusDigammaSquareConfig;
 
typedef struct SimDigammaSquareState {
    SimStimulusDigammaSquareConfig config; 
    SimClockMode clock_mode;               
    double locked_time;                    
    size_t last_step_index;                
    bool clock_initialized;                
    double *buffer;                        
    size_t buffer_capacity;                
    SimComplexDouble *buffer_complex;      
    size_t buffer_complex_capacity;        
#if defined(SIM_HAVE_VDSP)
    double *vdsp_block;   
    double *vdsp_phase;   
    double *vdsp_sin;     
    double *vdsp_cos;     
    size_t vdsp_capacity; 
#endif
    char symbolic[192]; 
} SimDigammaSquareState;
 
SimResult sim_add_stimulus_digamma_square_operator(struct SimContext *context,
                                                   const SimStimulusDigammaSquareConfig *config,
                                                   size_t *out_index);
 
SimResult sim_add_digamma_square_operator(struct SimContext *context, size_t field_index,
                                          const SimStimulusDigammaSquareConfig *config,
                                          size_t *out_index);
 
SimResult sim_stimulus_digamma_square_config(struct SimContext *context, size_t operator_index,
                                             SimStimulusDigammaSquareConfig *out_config);
 
SimResult sim_stimulus_digamma_square_update(struct SimContext *context, size_t operator_index,
                                             const SimStimulusDigammaSquareConfig *config);
 
#ifdef __cplusplus
}
#endif
 
#endif /* OAKFIELD_STIMULUS_DIGAMMA_SQUARE_H */