SimDivergenceOperatorConfig Struct Reference

Configuration for a finite-difference vector divergence operator. More...

#include <divergence.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
SimDivergenceStencil	stencil
SimIRBoundaryPolicy	boundary
bool	accumulate
bool	scale_by_dt

Detailed Description

Configuration for a finite-difference vector divergence operator.

Member Data Documentation

accumulate

bool SimDivergenceOperatorConfig::accumulate

Add into the output when true.

axis_x

size_t SimDivergenceOperatorConfig::axis_x

Axis used for X derivatives, or SIM_DIVERGENCE_AXIS_AUTO.

axis_y

size_t SimDivergenceOperatorConfig::axis_y

Axis used for Y derivatives, or SIM_DIVERGENCE_AXIS_AUTO.

boundary

SimIRBoundaryPolicy SimDivergenceOperatorConfig::boundary

Boundary policy for out-of-range neighbors.

input_field_x

size_t SimDivergenceOperatorConfig::input_field_x

Field supplying the X component.

input_field_y

size_t SimDivergenceOperatorConfig::input_field_y

Field supplying the Y component.

output_field

size_t SimDivergenceOperatorConfig::output_field

Field receiving dX/dx + dY/dy.

scale_by_dt

bool SimDivergenceOperatorConfig::scale_by_dt

Scale writes by substep dt when true.

spacing_x

double SimDivergenceOperatorConfig::spacing_x

Grid spacing along axis_x; non-positive values normalize.

spacing_y

double SimDivergenceOperatorConfig::spacing_y

Grid spacing along axis_y; non-positive values normalize.

stencil

SimDivergenceStencil SimDivergenceOperatorConfig::stencil

Finite-difference stencil.

---

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

• divergence.h