Configuration for writing finite-difference gradient components. More...

#include <gradient.h>

Public Attributes
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

Detailed Description

Configuration for writing finite-difference gradient components.

Member Data Documentation

◆ accumulate

bool SimGradientOperatorConfig::accumulate

Add into output fields when true.

◆ axis_x

size_t SimGradientOperatorConfig::axis_x

X derivative axis, or SIM_GRADIENT_AXIS_AUTO.

◆ axis_y

size_t SimGradientOperatorConfig::axis_y

Y derivative axis, or SIM_GRADIENT_AXIS_AUTO.

◆ boundary

SimIRBoundaryPolicy SimGradientOperatorConfig::boundary

Boundary policy for out-of-range neighbors.

◆ input_field

size_t SimGradientOperatorConfig::input_field

Source scalar field.

◆ output_field_x

size_t SimGradientOperatorConfig::output_field_x

Field receiving derivative along axis_x.

◆ output_field_y

size_t SimGradientOperatorConfig::output_field_y

Field receiving derivative along axis_y.

◆ scale_by_dt

bool SimGradientOperatorConfig::scale_by_dt

Scale writes by substep dt when true.

◆ spacing_x

double SimGradientOperatorConfig::spacing_x

Grid spacing along axis_x; non-positive values normalize.

◆ spacing_y

double SimGradientOperatorConfig::spacing_y

Grid spacing along axis_y; non-positive values normalize.

◆ stencil

SimGradientStencil SimGradientOperatorConfig::stencil

Finite-difference stencil.

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

gradient.h

Public Attributes