Oakfield API Documentation 1.0.0
Numerical core APIs
Loading...
Searching...
No Matches
checkerboard.h
Go to the documentation of this file.
1
9#ifndef OAKFIELD_STIMULUS_CHECKERBOARD_H
10#define OAKFIELD_STIMULUS_CHECKERBOARD_H
11
12#include "coords.h"
14
15#include <stdbool.h>
16#include <stddef.h>
17
18#ifdef __cplusplus
19extern "C" {
20#endif
21
22struct SimContext;
23
37
52 size_t *out_index);
53
64SimResult sim_stimulus_checkerboard_config(struct SimContext *context, size_t operator_index,
66
80SimResult sim_stimulus_checkerboard_update(struct SimContext *context, size_t operator_index,
81 const SimStimulusCheckerboardConfig *config);
82
83#ifdef __cplusplus
84}
85#endif
86
87#endif /* OAKFIELD_STIMULUS_CHECKERBOARD_H */
SimResult sim_add_stimulus_checkerboard_operator(struct SimContext *context, const SimStimulusCheckerboardConfig *config, size_t *out_index)
Register a checkerboard or stripe stimulus operator.
SimResult sim_stimulus_checkerboard_update(struct SimContext *context, size_t operator_index, const SimStimulusCheckerboardConfig *config)
Replace or renormalize a registered checkerboard stimulus configuration.
SimResult sim_stimulus_checkerboard_config(struct SimContext *context, size_t operator_index, SimStimulusCheckerboardConfig *out_config)
Copy the current checkerboard configuration from a registered operator.
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).
Simulation runtime state.
Definition sim_context.h:70
Configuration for checkerboard or stripe pattern stimulus writes.
Definition checkerboard.h:27
double complex_phase
Definition checkerboard.h:34
double period_x
Definition checkerboard.h:30
double amplitude
Definition checkerboard.h:29
size_t field_index
Definition checkerboard.h:28
SimStimulusCoordConfig coord
Definition checkerboard.h:32
bool scale_by_dt
Definition checkerboard.h:35
double period_y
Definition checkerboard.h:31
double phase
Definition checkerboard.h:33
Shared coordinate mapping configuration used by stimulus operators.
Definition coords.h:53