hermite_gaussian_beam.h File Reference

Hermite-Gaussian beam stimulus with separable transverse modes. More...

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

Include dependency graph for hermite_gaussian_beam.h:

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

Go to the source code of this file.

Classes
struct	SimStimulusHermiteGaussianBeamConfig
	Configuration for a separable Hermite-Gaussian beam stimulus. More...

Typedefs
typedef struct SimStimulusHermiteGaussianBeamConfig	SimStimulusHermiteGaussianBeamConfig
	Configuration for a separable Hermite-Gaussian beam stimulus.

Functions
SimResult	sim_add_stimulus_hermite_gaussian_beam_operator (struct SimContext *context, const SimStimulusHermiteGaussianBeamConfig *config, size_t *out_index)
	Register a Hermite-Gaussian beam stimulus operator.
SimResult	sim_stimulus_hermite_gaussian_beam_config (struct SimContext *context, size_t operator_index, SimStimulusHermiteGaussianBeamConfig *out_config)
	Copy the current Hermite-Gaussian configuration from a registered operator.
SimResult	sim_stimulus_hermite_gaussian_beam_update (struct SimContext *context, size_t operator_index, const SimStimulusHermiteGaussianBeamConfig *config)
	Replace or renormalize a registered Hermite-Gaussian beam configuration.

Detailed Description

Hermite-Gaussian beam stimulus with separable transverse modes.

Evaluates a local beam frame (u, v) and injects A * H_m(sqrt(2) * u / w_u) * H_n(sqrt(2) * v / w_v)

• exp(-(u^2 / w_u^2 + v^2 / w_v^2))
• exp(i * (k_u * u + k_v * v - omega * t + phi)), where the local coordinates can drift and rotate over time.

Real fields receive the real component. Complex fields receive the full complex beam with an additional global rotation.

Function Documentation

sim_add_stimulus_hermite_gaussian_beam_operator()

SimResult sim_add_stimulus_hermite_gaussian_beam_operator	(	struct SimContext *	context,
		const SimStimulusHermiteGaussianBeamConfig *	config,
		size_t *	out_index
	)

Register a Hermite-Gaussian beam stimulus operator.

The implementation copies and normalizes config, then registers a split operator that writes the separable transverse mode into the target field.

Parameters

	context	Simulation context that will own the operator.
	config	Optional Hermite-Gaussian 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_hermite_gaussian_beam_config()

SimResult sim_stimulus_hermite_gaussian_beam_config	(	struct SimContext *	context,
		size_t	operator_index,
		SimStimulusHermiteGaussianBeamConfig *	out_config
	)

Copy the current Hermite-Gaussian configuration from a registered operator.

Parameters

	context	Simulation context containing the operator.
	operator_index	Index returned by sim_add_stimulus_hermite_gaussian_beam_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_hermite_gaussian_beam_update()

SimResult sim_stimulus_hermite_gaussian_beam_update	(	struct SimContext *	context,
		size_t	operator_index,
		const SimStimulusHermiteGaussianBeamConfig *	config
	)

Replace or renormalize a registered Hermite-Gaussian beam 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 Hermite-Gaussian beam operator to update.
config	Optional replacement configuration.

Returns

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