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

Configuration for a finite-difference scalar curl operator. More...

#include <curl.h>

Public Attributes

size_t input_field_x
 
size_t input_field_y
 
size_t output_field
 
double spacing_x
 
double spacing_y
 
size_t axis_x
 
size_t axis_y
 
SimCurlStencil stencil
 
SimIRBoundaryPolicy boundary
 
bool accumulate
 
bool scale_by_dt
 

Detailed Description

Configuration for a finite-difference scalar curl operator.

Member Data Documentation

◆ accumulate

bool SimCurlOperatorConfig::accumulate

Add into the output when true.

◆ axis_x

size_t SimCurlOperatorConfig::axis_x

Axis used for X derivatives, or SIM_CURL_AXIS_AUTO.

◆ axis_y

size_t SimCurlOperatorConfig::axis_y

Axis used for Y derivatives, or SIM_CURL_AXIS_AUTO.

◆ boundary

SimIRBoundaryPolicy SimCurlOperatorConfig::boundary

Boundary policy for out-of-range neighbors.

◆ input_field_x

size_t SimCurlOperatorConfig::input_field_x

Field supplying the X component.

◆ input_field_y

size_t SimCurlOperatorConfig::input_field_y

Field supplying the Y component.

◆ output_field

size_t SimCurlOperatorConfig::output_field

Field receiving dY/dx - dX/dy.

◆ scale_by_dt

bool SimCurlOperatorConfig::scale_by_dt

Scale writes by substep dt when true.

◆ spacing_x

double SimCurlOperatorConfig::spacing_x

Grid spacing along axis_x; non-positive values normalize.

◆ spacing_y

double SimCurlOperatorConfig::spacing_y

Grid spacing along axis_y; non-positive values normalize.

◆ stencil

SimCurlStencil SimCurlOperatorConfig::stencil

Finite-difference stencil.


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