traveling_wave_packet.h

Go to the documentation of this file.

 
#ifndef OAKFIELD_STIMULUS_TRAVELING_WAVE_PACKET_H
#define OAKFIELD_STIMULUS_TRAVELING_WAVE_PACKET_H
 
#include "coords.h"
#include "oakfield/operator_split.h"
 
#include <stdbool.h>
#include <stddef.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct SimContext;
 
typedef struct SimStimulusTravelingWavePacketConfig {
    size_t field_index;           
    double amplitude;             
    double sigma_u;               
    double sigma_v;               
    double center_u;              
    double center_v;              
    double velocity_u;            
    double velocity_v;            
    double orientation;           
    double orientation_rate;      
    double carrier_u;             
    double carrier_v;             
    double omega;                 
    double phase;                 
    SimStimulusCoordConfig coord; 
    double time_offset;           
    double rotation;              
    bool scale_by_dt;             
} SimStimulusTravelingWavePacketConfig;
 
SimResult
sim_add_stimulus_traveling_wave_packet_operator(struct SimContext *context,
                                                const SimStimulusTravelingWavePacketConfig *config,
                                                size_t *out_index);
 
SimResult
sim_stimulus_traveling_wave_packet_config(struct SimContext *context, size_t operator_index,
                                          SimStimulusTravelingWavePacketConfig *out_config);
 
SimResult
sim_stimulus_traveling_wave_packet_update(struct SimContext *context, size_t operator_index,
                                          const SimStimulusTravelingWavePacketConfig *config);
 
#ifdef __cplusplus
}
#endif
 
#endif /* OAKFIELD_STIMULUS_TRAVELING_WAVE_PACKET_H */