Oakfield API Documentation 1.0.0
Numerical core APIs
Loading...
Searching...
No Matches
ornstein_uhlenbeck.h
Go to the documentation of this file.
1
5#ifndef OAKFIELD_ORNSTEIN_UHLENBECK_H
6#define OAKFIELD_ORNSTEIN_UHLENBECK_H
7
9
10#include <stddef.h>
11#include <stdint.h>
12
13#ifdef __cplusplus
14extern "C" {
15#endif
16
17struct SimContext;
18
28
40
52 size_t *out_index);
53
64SimResult sim_ornstein_uhlenbeck_config(struct SimContext *context, size_t operator_index,
66
79SimResult sim_ornstein_uhlenbeck_update(struct SimContext *context, size_t operator_index,
81
82#ifdef __cplusplus
83}
84#endif
85
86#endif /* OAKFIELD_ORNSTEIN_UHLENBECK_H */
SimResult
Return codes shared by libsimcore modules.
Definition field.h:29
Declarative complex-first operator splitting (substep expansion at plan time).
SimResult sim_ornstein_uhlenbeck_update(struct SimContext *context, size_t operator_index, const SimOrnsteinUhlenbeckOperatorConfig *config)
Replace the configuration of a registered OU operator.
SimOrnsteinUhlenbeckComplexMode
Coordinate system used when applying OU noise to complex fields.
Definition ornstein_uhlenbeck.h:22
@ SIM_ORNSTEIN_UHLENBECK_COMPLEX_MODE_POLAR
Definition ornstein_uhlenbeck.h:25
@ SIM_ORNSTEIN_UHLENBECK_COMPLEX_MODE_COMPONENT
Definition ornstein_uhlenbeck.h:23
SimResult sim_ornstein_uhlenbeck_config(struct SimContext *context, size_t operator_index, SimOrnsteinUhlenbeckOperatorConfig *out_config)
Copy the current OU configuration from a registered operator.
SimResult sim_add_ornstein_uhlenbeck_operator(struct SimContext *context, const SimOrnsteinUhlenbeckOperatorConfig *config, size_t *out_index)
Register an Ornstein-Uhlenbeck process operator.
Simulation runtime state.
Definition sim_context.h:70
Configuration for the Ornstein-Uhlenbeck operator.
Definition ornstein_uhlenbeck.h:32
double mean
Definition ornstein_uhlenbeck.h:34
SimOrnsteinUhlenbeckComplexMode complex_mode
Definition ornstein_uhlenbeck.h:38
double sigma
Definition ornstein_uhlenbeck.h:35
uint64_t seed
Definition ornstein_uhlenbeck.h:37
double tau
Definition ornstein_uhlenbeck.h:36
size_t field_index
Definition ornstein_uhlenbeck.h:33