Oakfield API Documentation 1.0.0
Numerical core APIs
Loading...
Searching...
No Matches
SimSpatialDerivativeOperatorConfig Struct Reference

Configuration for the spatial derivative operator. More...

#include <spatial_derivative.h>

Public Attributes

size_t input_field
 
size_t output_field
 
double spacing
 
SimSpatialDerivativeMethod method
 
size_t axis
 
bool skew_forward
 
bool accumulate
 
SimIRBoundaryPolicy boundary
 

Detailed Description

Configuration for the spatial derivative operator.

Member Data Documentation

◆ accumulate

bool SimSpatialDerivativeOperatorConfig::accumulate

When true, adds into output instead of overwriting.

◆ axis

size_t SimSpatialDerivativeOperatorConfig::axis

Axis along which derivative is taken (0=x).

◆ boundary

SimIRBoundaryPolicy SimSpatialDerivativeOperatorConfig::boundary

Boundary handling policy.

◆ input_field

size_t SimSpatialDerivativeOperatorConfig::input_field

Source field index.

◆ method

SimSpatialDerivativeMethod SimSpatialDerivativeOperatorConfig::method

Finite difference stencil.

◆ output_field

size_t SimSpatialDerivativeOperatorConfig::output_field

Destination field index.

◆ skew_forward

bool SimSpatialDerivativeOperatorConfig::skew_forward

When true, bias to a forward stencil instead of symmetric central.

◆ spacing

double SimSpatialDerivativeOperatorConfig::spacing

Grid spacing dx (> 0).


The documentation for this struct was generated from the following file: