gradient.h

Go to the documentation of this file.

 
#ifndef OAKFIELD_GRADIENT_H
#define OAKFIELD_GRADIENT_H
 
#include "oakfield/operator_split.h"
 
#include <stdbool.h>
#include <stddef.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct SimContext;
 
#define SIM_GRADIENT_AXIS_AUTO ((size_t)SIZE_MAX)
 
typedef enum SimGradientStencil {
    SIM_GRADIENT_STENCIL_CENTRAL_2 = 0, 
    SIM_GRADIENT_STENCIL_CENTRAL_4,     
    SIM_GRADIENT_STENCIL_FORWARD_1,     
    SIM_GRADIENT_STENCIL_BACKWARD_1,    
    SIM_GRADIENT_STENCIL_FORWARD_2,     
    SIM_GRADIENT_STENCIL_BACKWARD_2     
} SimGradientStencil;
 
typedef struct SimGradientOperatorConfig {
    size_t input_field;           
    size_t output_field_x;        
    size_t output_field_y;        
    double spacing_x;             
    double spacing_y;             
    size_t axis_x;                
    size_t axis_y;                
    SimGradientStencil stencil;   
    SimIRBoundaryPolicy boundary; 
    bool accumulate;              
    bool scale_by_dt;             
} SimGradientOperatorConfig;
 
SimResult sim_add_gradient_operator(struct SimContext *context,
                                    const SimGradientOperatorConfig *config, size_t *out_index);
 
SimResult sim_gradient_config(struct SimContext *context, size_t operator_index,
                              SimGradientOperatorConfig *out_config);
 
SimResult sim_gradient_update(struct SimContext *context, size_t operator_index,
                              const SimGradientOperatorConfig *config);
 
#ifdef __cplusplus
}
#endif
 
#endif /* OAKFIELD_GRADIENT_H */