Finite-difference gradient operator writing X/Y derivative fields. More...

#include "oakfield/operator_split.h"
#include <stdbool.h>
#include <stddef.h>

Include dependency graph for gradient.h:

This graph shows which files directly or indirectly include this file:

Classes
struct	SimGradientOperatorConfig
	Configuration for writing finite-difference gradient components. More...

Macros
#define	SIM_GRADIENT_AXIS_AUTO ((size_t)SIZE_MAX)

Typedefs
typedef enum SimGradientStencil	SimGradientStencil
	Finite-difference stencils available for gradient derivatives.

typedef struct SimGradientOperatorConfig	SimGradientOperatorConfig
	Configuration for writing finite-difference gradient components.

Enumerations
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 }
	Finite-difference stencils available for gradient derivatives. More...

Functions
SimResult	sim_add_gradient_operator (struct SimContext context, const SimGradientOperatorConfig config, size_t *out_index)
	Register a finite-difference gradient operator.

SimResult	sim_gradient_config (struct SimContext context, size_t operator_index, SimGradientOperatorConfig out_config)
	Copy the current gradient configuration from a registered operator.

SimResult	sim_gradient_update (struct SimContext context, size_t operator_index, const SimGradientOperatorConfig config)
	Replace the configuration of a registered gradient operator.

Detailed Description

Finite-difference gradient operator writing X/Y derivative fields.

Enumeration Type Documentation

Finite-difference stencils available for gradient derivatives.

Enumerator
SIM_GRADIENT_STENCIL_CENTRAL_2	Second-order central difference.
SIM_GRADIENT_STENCIL_CENTRAL_4	Fourth-order central difference.
SIM_GRADIENT_STENCIL_FORWARD_1	First-order forward difference.
SIM_GRADIENT_STENCIL_BACKWARD_1	First-order backward difference.
SIM_GRADIENT_STENCIL_FORWARD_2	Second-order forward difference.
SIM_GRADIENT_STENCIL_BACKWARD_2	Second-order backward difference.

SimResult sim_add_gradient_operator	(	struct SimContext *	context,
		const SimGradientOperatorConfig *	config,
		size_t *	out_index
	)

Register a finite-difference gradient operator.

Parameters

	context	Simulation context that will own the operator.
	config	Optional gradient configuration; NULL selects normalized defaults.
[out]	out_index	Optional destination for the registered operator index.

Returns: SIM_RESULT_OK on success, or an error code from argument validation, field compatibility checks, allocation, or split registration.

SimResult sim_gradient_config	(	struct SimContext *	context,
		size_t	operator_index,
		SimGradientOperatorConfig *	out_config
	)

Copy the current gradient configuration from a registered operator.

Parameters

	context	Simulation context containing the operator.
	operator_index	Index returned by sim_add_gradient_operator().
[out]	out_config	Receives the normalized configuration.

Returns: SIM_RESULT_OK on success, SIM_RESULT_INVALID_ARGUMENT for NULL pointers, SIM_RESULT_NOT_FOUND for a missing operator, or SIM_RESULT_INVALID_STATE when the operator has no gradient state.

SimResult sim_gradient_update	(	struct SimContext *	context,
		size_t	operator_index,
		const SimGradientOperatorConfig *	config
	)

Replace the configuration of a registered gradient operator.

config is required. The replacement is normalized and field compatibility is checked before storing it.

Parameters

context	Simulation context containing the operator.
operator_index	Index of the gradient operator to update.
config	Replacement gradient configuration.

Returns: SIM_RESULT_OK on success, or an error code from argument validation, lookup, state validation, or field compatibility checks.