wave_modes.h

Go to the documentation of this file.

 
#ifndef OAKFIELD_STIMULUS_WAVE_MODES_H
#define OAKFIELD_STIMULUS_WAVE_MODES_H
 
#include "coords.h"
#include "oakfield/operator_split.h"
 
#include <stdbool.h>
#include <stddef.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct SimContext;
 
typedef struct SimStimulusWaveModesConfig {
    size_t field_index;           
    double amplitude;             
    unsigned int mode_u;          
    unsigned int mode_v;          
    double extent_u;              
    double extent_v;              
    double wave_speed;            
    double phase;                 
    SimStimulusCoordConfig coord; 
    double time_offset;           
    double rotation;              
    bool scale_by_dt;             
} SimStimulusWaveModesConfig;
 
SimResult sim_add_stimulus_wave_modes_operator(struct SimContext *context,
                                               const SimStimulusWaveModesConfig *config,
                                               size_t *out_index);
 
SimResult sim_stimulus_wave_modes_config(struct SimContext *context, size_t operator_index,
                                         SimStimulusWaveModesConfig *out_config);
 
SimResult sim_stimulus_wave_modes_update(struct SimContext *context, size_t operator_index,
                                         const SimStimulusWaveModesConfig *config);
 
#ifdef __cplusplus
}
#endif
 
#endif /* OAKFIELD_STIMULUS_WAVE_MODES_H */