Oakfield API Documentation 1.0.0
Numerical core APIs
Loading...
Searching...
No Matches
gaussian.h
Go to the documentation of this file.
1
7#ifndef OAKFIELD_STIMULUS_GAUSSIAN_H
8#define OAKFIELD_STIMULUS_GAUSSIAN_H
9
10#include "coords.h"
12
13#include <stdbool.h>
14#include <stddef.h>
15
16#ifdef __cplusplus
17extern "C" {
18#endif
19
20struct SimContext;
21
37
51 const SimStimulusGaussianConfig *config,
52 size_t *out_index);
53
64SimResult sim_stimulus_gaussian_config(struct SimContext *context, size_t operator_index,
65 SimStimulusGaussianConfig *out_config);
66
80SimResult sim_stimulus_gaussian_update(struct SimContext *context, size_t operator_index,
81 const SimStimulusGaussianConfig *config);
82
83#ifdef __cplusplus
84}
85#endif
86
87#endif /* OAKFIELD_STIMULUS_GAUSSIAN_H */
Shared spatial coordinate helpers for stimulus operators.
SimResult
Return codes shared by libsimcore modules.
Definition field.h:29
SimResult sim_add_stimulus_gaussian_operator(struct SimContext *context, const SimStimulusGaussianConfig *config, size_t *out_index)
Register a traveling Gaussian-envelope stimulus operator.
SimResult sim_stimulus_gaussian_config(struct SimContext *context, size_t operator_index, SimStimulusGaussianConfig *out_config)
Copy the current Gaussian configuration from a registered operator.
SimResult sim_stimulus_gaussian_update(struct SimContext *context, size_t operator_index, const SimStimulusGaussianConfig *config)
Replace or renormalize a registered Gaussian stimulus configuration.
Declarative complex-first operator splitting (substep expansion at plan time).
Simulation runtime state.
Definition sim_context.h:70
Shared coordinate mapping configuration used by stimulus operators.
Definition coords.h:53
Parameterization for Gaussian-envelope stimulus operators.
Definition gaussian.h:25
double sigma_y
Definition gaussian.h:29
double sigma_x
Definition gaussian.h:28
bool fixed_clock
Definition gaussian.h:34
double amplitude
Definition gaussian.h:27
bool scale_by_dt
Definition gaussian.h:35
SimStimulusCoordConfig coord
Definition gaussian.h:31
double nominal_dt
Definition gaussian.h:33
double rotation
Definition gaussian.h:32
double time_offset
Definition gaussian.h:30
size_t field_index
Definition gaussian.h:26