spectral_lines.h

Go to the documentation of this file.

 
#ifndef OAKFIELD_STIMULUS_SPECTRAL_LINES_H
#define OAKFIELD_STIMULUS_SPECTRAL_LINES_H
 
#include "coords.h"
#include "oakfield/operator_split.h"
 
#include <stdbool.h>
#include <stddef.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct SimContext;
 
typedef enum SimStimulusSpectralLinesTwistKind {
    SIM_SPECTRAL_LINES_TWIST_NONE = 0,    
    SIM_SPECTRAL_LINES_TWIST_ALTERNATING, 
    SIM_SPECTRAL_LINES_TWIST_DIRICHLET    
} SimStimulusSpectralLinesTwistKind;
 
typedef enum SimStimulusSpectralLinesTwistPreset {
    SIM_SPECTRAL_LINES_TWIST_PRESET_PRINCIPAL = 0, 
    SIM_SPECTRAL_LINES_TWIST_PRESET_CHI4,          
    SIM_SPECTRAL_LINES_TWIST_PRESET_QUADRATIC,     
    SIM_SPECTRAL_LINES_TWIST_PRESET_TABLE          
} SimStimulusSpectralLinesTwistPreset;
 
typedef struct SimStimulusSpectralLinesConfig {
    size_t field_index;           
    double amplitude;             
    double wavenumber;            
    double kx;                    
    double ky;                    
    double omega;                 
    double phase;                 
    SimStimulusCoordConfig coord; 
    double time_offset;           
    double nominal_dt;            
    unsigned int harmonic_count;  
    double harmonic_power;        
    SimStimulusSpectralLinesTwistKind twist_kind; 
    unsigned int twist_q;                         
    unsigned int twist_k; 
    SimStimulusSpectralLinesTwistPreset twist_preset; 
    bool twist_zero_non_units;   
    bool twist_table_is_complex; 
    bool use_wavevector;         
    bool fixed_clock;            
    bool scale_by_dt;            
} SimStimulusSpectralLinesConfig;
 
SimResult sim_add_stimulus_spectral_lines_operator(struct SimContext *context,
                                                   const SimStimulusSpectralLinesConfig *config,
                                                   size_t *out_index);
 
SimResult sim_stimulus_spectral_lines_config(struct SimContext *context, size_t operator_index,
                                             SimStimulusSpectralLinesConfig *out_config);
 
SimResult sim_stimulus_spectral_lines_update(struct SimContext *context, size_t operator_index,
                                             const SimStimulusSpectralLinesConfig *config);
 
SimResult sim_stimulus_spectral_lines_set_twist_table(struct SimContext *context,
                                                      size_t operator_index, unsigned int q,
                                                      const double *chi_re, const double *chi_im,
                                                      bool zero_non_units);
 
#ifdef __cplusplus
}
#endif
 
#endif /* OAKFIELD_STIMULUS_SPECTRAL_LINES_H */