Oakfield API Documentation 1.0.0
Numerical core APIs
Loading...
Searching...
No Matches
white_noise.h
Go to the documentation of this file.
1
9#ifndef OAKFIELD_STIMULUS_WHITE_NOISE_H
10#define OAKFIELD_STIMULUS_WHITE_NOISE_H
11
13
14#include <stdbool.h>
15#include <stddef.h>
16#include <stdint.h>
17
18#ifdef __cplusplus
19extern "C" {
20#endif
21
22struct SimContext;
23
36
50 const SimStimulusWhiteNoiseConfig *config,
51 size_t *out_index);
52
63SimResult sim_stimulus_white_noise_config(struct SimContext *context, size_t operator_index,
64 SimStimulusWhiteNoiseConfig *out_config);
65
79SimResult sim_stimulus_white_noise_update(struct SimContext *context, size_t operator_index,
80 const SimStimulusWhiteNoiseConfig *config);
81
82#ifdef __cplusplus
83}
84#endif
85
86#endif /* OAKFIELD_STIMULUS_WHITE_NOISE_H */
SimResult
Return codes shared by libsimcore modules.
Definition field.h:29
Declarative complex-first operator splitting (substep expansion at plan time).
Simulation runtime state.
Definition sim_context.h:70
Configuration for seeded Gaussian white-noise stimulus injection.
Definition white_noise.h:27
bool fixed_clock
Definition white_noise.h:33
uint64_t seed
Definition white_noise.h:32
double sigma
Definition white_noise.h:29
double mean
Definition white_noise.h:30
bool scale_by_dt
Definition white_noise.h:34
size_t field_index
Definition white_noise.h:28
double nominal_dt
Definition white_noise.h:31
SimResult sim_stimulus_white_noise_config(struct SimContext *context, size_t operator_index, SimStimulusWhiteNoiseConfig *out_config)
Copy the current white-noise configuration from a registered operator.
SimResult sim_add_stimulus_white_noise_operator(struct SimContext *context, const SimStimulusWhiteNoiseConfig *config, size_t *out_index)
Register a seeded white-noise stimulus operator.
SimResult sim_stimulus_white_noise_update(struct SimContext *context, size_t operator_index, const SimStimulusWhiteNoiseConfig *config)
Replace or renormalize a registered white-noise stimulus configuration.