heat_kernel.h File Reference

Heat-kernel stimulus with diffusive Gaussian broadening. More...

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

Include dependency graph for heat_kernel.h:

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

Go to the source code of this file.

Classes
struct	SimStimulusHeatKernelConfig
	Configuration for a diffusive Gaussian heat-kernel stimulus. More...

Typedefs
typedef struct SimStimulusHeatKernelConfig	SimStimulusHeatKernelConfig
	Configuration for a diffusive Gaussian heat-kernel stimulus.

Functions
SimResult	sim_add_stimulus_heat_kernel_operator (struct SimContext *context, const SimStimulusHeatKernelConfig *config, size_t *out_index)
	Register a diffusive heat-kernel stimulus operator.
SimResult	sim_stimulus_heat_kernel_config (struct SimContext *context, size_t operator_index, SimStimulusHeatKernelConfig *out_config)
	Copy the current heat-kernel configuration from a registered operator.
SimResult	sim_stimulus_heat_kernel_update (struct SimContext *context, size_t operator_index, const SimStimulusHeatKernelConfig *config)
	Replace or renormalize a registered heat-kernel stimulus configuration.

Detailed Description

Heat-kernel stimulus with diffusive Gaussian broadening.

Evolves an initial Gaussian profile under the heat equation by expanding its width as sigma(t)^2 = sigma_0^2 + 2 D t for t >= 0.

Function Documentation

sim_add_stimulus_heat_kernel_operator()

SimResult sim_add_stimulus_heat_kernel_operator	(	struct SimContext *	context,
		const SimStimulusHeatKernelConfig *	config,
		size_t *	out_index
	)

Register a diffusive heat-kernel stimulus operator.

The implementation copies and normalizes config, then registers a split operator that evaluates the broadened Gaussian profile on the target field.

Parameters

	context	Simulation context that will own the operator.
	config	Optional heat-kernel 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 validation, allocation, or split-operator registration.

sim_stimulus_heat_kernel_config()

SimResult sim_stimulus_heat_kernel_config	(	struct SimContext *	context,
		size_t	operator_index,
		SimStimulusHeatKernelConfig *	out_config
	)

Copy the current heat-kernel configuration from a registered operator.

Parameters

	context	Simulation context containing the operator.
	operator_index	Index returned by sim_add_stimulus_heat_kernel_operator().
[out]	out_config	Receives the operator's 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 stimulus state.

sim_stimulus_heat_kernel_update()

SimResult sim_stimulus_heat_kernel_update	(	struct SimContext *	context,
		size_t	operator_index,
		const SimStimulusHeatKernelConfig *	config
	)

Replace or renormalize a registered heat-kernel stimulus configuration.

Passing NULL for config keeps the existing configuration and reapplies normalization. A successful update refreshes symbolic state and invalidates the scheduler plan.

Parameters

context	Simulation context containing the operator.
operator_index	Index of the heat-kernel operator to update.
config	Optional replacement configuration.

Returns

SIM_RESULT_OK on success, or an error code if lookup or state validation fails.