Oakfield API Documentation 1.0.0
Numerical core APIs
Loading...
Searching...
No Matches
stimulus/stimulus.h
Go to the documentation of this file.
1
9#ifndef OAKFIELD_STIMULUS_H
10#define OAKFIELD_STIMULUS_H
11
12#include "coords.h"
14#include <stdbool.h>
15
16#ifdef __cplusplus
17extern "C" {
18#endif
19
20struct SimContext;
21struct SimOperator;
22
36
51 const StimulusOperatorConfig *config, size_t *out_index);
52
63SimResult sim_stimulus_config(struct SimContext *context, size_t operator_index,
64 StimulusOperatorConfig *out_config);
65
79SimResult sim_stimulus_update(struct SimContext *context, size_t operator_index,
80 const StimulusOperatorConfig *config);
81#ifdef __cplusplus
82}
83#endif
84
85#endif /* OAKFIELD_STIMULUS_H */
Shared spatial coordinate helpers for stimulus operators.
SimResult
Return codes shared by libsimcore modules.
Definition field.h:29
Declarative complex-first operator splitting (substep expansion at plan time).
SimResult sim_stimulus_config(struct SimContext *context, size_t operator_index, StimulusOperatorConfig *out_config)
Copy the current legacy stimulus configuration from a registered operator.
SimResult sim_add_stimulus_operator(struct SimContext *context, const StimulusOperatorConfig *config, size_t *out_index)
Register the legacy single-mode sinusoidal stimulus operator.
SimResult sim_stimulus_update(struct SimContext *context, size_t operator_index, const StimulusOperatorConfig *config)
Replace or renormalize a registered legacy stimulus configuration.
Simulation runtime state.
Definition sim_context.h:70
Operator instance stored by the registry.
Definition operator.h:344
Shared coordinate mapping configuration used by stimulus operators.
Definition coords.h:53
Configuration parameters for the legacy sinusoidal stimulus operator.
Definition stimulus/stimulus.h:26
bool scale_by_dt
Definition stimulus/stimulus.h:34
double omega
Definition stimulus/stimulus.h:30
double phase
Definition stimulus/stimulus.h:31
size_t field_index
Definition stimulus/stimulus.h:27
double wavenumber
Definition stimulus/stimulus.h:29
double amplitude
Definition stimulus/stimulus.h:28
SimStimulusCoordConfig coord
Definition stimulus/stimulus.h:32
double time_offset
Definition stimulus/stimulus.h:33