sinusoidal.h

Go to the documentation of this file.

 
#ifndef OAKFIELD_STIMULUS_SINUSOIDAL_H
#define OAKFIELD_STIMULUS_SINUSOIDAL_H
 
#include "coords.h"
#include "oakfield/operator_split.h"
 
#include <stdbool.h>
#include <stddef.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct SimContext;
 
typedef struct SimStimulusSinusoidalConfig {
    size_t field_index;           
    double amplitude;             
    double wavenumber;            
    double kx;                    
    double ky;                    
    double omega;                 
    double phase;                 
    SimStimulusCoordConfig coord; 
    double time_offset;           
    double nominal_dt; 
    double kdot;       
    double wdot;       
    double rotation;   
    bool use_wavevector; 
    bool fixed_clock;    
    bool scale_by_dt; 
} SimStimulusSinusoidalConfig;
 
typedef enum SimStimulusSinusoidalMode {
    SIM_STIMULUS_SINUSOIDAL_SINE = 0, 
    SIM_STIMULUS_SINUSOIDAL_STANDING, 
    SIM_STIMULUS_SINUSOIDAL_CHIRP     
} SimStimulusSinusoidalMode;
 
typedef struct SimStimulusSinusoidalState {
    SimStimulusSinusoidalConfig config; 
    SimStimulusSinusoidalMode mode;     
    SimClockMode clock_mode;            
    double locked_time;                 
    size_t last_step_index;             
    bool clock_initialized;             
    double snapshot_locked_time;        
    size_t snapshot_last_step_index;    
    bool snapshot_clock_initialized;    
    double *buffer;                     
    size_t buffer_capacity;             
    double *vdsp_block;                 
    double *vdsp_theta;                 
    double *vdsp_value;                 
    size_t vdsp_capacity;               
    char symbolic[192];                 
} SimStimulusSinusoidalState;
 
SimResult sim_add_stimulus_sine_operator(struct SimContext *context,
                                         const SimStimulusSinusoidalConfig *config,
                                         size_t *out_index);
 
SimResult sim_add_stimulus_standing_operator(struct SimContext *context,
                                             const SimStimulusSinusoidalConfig *config,
                                             size_t *out_index);
 
SimResult sim_add_stimulus_chirp_operator(struct SimContext *context,
                                          const SimStimulusSinusoidalConfig *config,
                                          size_t *out_index);
 
SimResult sim_stimulus_sinusoidal_config(struct SimContext *context, size_t operator_index,
                                         SimStimulusSinusoidalConfig *out_config);
 
SimResult sim_stimulus_sinusoidal_update(struct SimContext *context, size_t operator_index,
                                         const SimStimulusSinusoidalConfig *config);
 
#ifdef __cplusplus
}
#endif
 
#endif /* OAKFIELD_STIMULUS_SINUSOIDAL_H */