spatial_derivative.h

Go to the documentation of this file.

 
#ifndef OAKFIELD_SPATIAL_DERIVATIVE_H
#define OAKFIELD_SPATIAL_DERIVATIVE_H
 
#include "oakfield/operator_split.h"
 
#include <stdbool.h>
#include <stddef.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct SimContext;
 
typedef enum SimSpatialDerivativeMethod {
    SIM_SPATIAL_DERIVATIVE_METHOD_CENTRAL = 0, 
    SIM_SPATIAL_DERIVATIVE_METHOD_FORWARD = 1, 
    SIM_SPATIAL_DERIVATIVE_METHOD_BACKWARD = 2 
} SimSpatialDerivativeMethod;
 
typedef struct SimSpatialDerivativeOperatorConfig {
    size_t input_field;                
    size_t output_field;               
    double spacing;                    
    SimSpatialDerivativeMethod method; 
    size_t axis;                       
    bool skew_forward; 
    bool accumulate;   
    SimIRBoundaryPolicy boundary; 
} SimSpatialDerivativeOperatorConfig;
 
const char *sim_spatial_derivative_method_name(SimSpatialDerivativeMethod method);
 
bool sim_spatial_derivative_method_from_string(const char *name,
                                               SimSpatialDerivativeMethod *out_method);
 
SimResult sim_add_spatial_derivative_operator(struct SimContext *context,
                                              const SimSpatialDerivativeOperatorConfig *config,
                                              size_t *out_index);
 
SimResult sim_spatial_derivative_config(struct SimContext *context, size_t operator_index,
                                        SimSpatialDerivativeOperatorConfig *out_config);
 
SimResult sim_spatial_derivative_update(struct SimContext *context, size_t operator_index,
                                        const SimSpatialDerivativeOperatorConfig *config);
 
#ifdef __cplusplus
}
#endif
 
#endif /* OAKFIELD_SPATIAL_DERIVATIVE_H */