airy_beam.h File Reference

Finite-energy separable Airy beam stimulus. More...

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

Include dependency graph for airy_beam.h:

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

Go to the source code of this file.

Classes
struct	SimStimulusAiryBeamConfig
	Configuration for a finite-energy separable Airy beam stimulus. More...

Typedefs
typedef struct SimStimulusAiryBeamConfig	SimStimulusAiryBeamConfig
	Configuration for a finite-energy separable Airy beam stimulus.

Functions
SimResult	sim_add_stimulus_airy_beam_operator (struct SimContext *context, const SimStimulusAiryBeamConfig *config, size_t *out_index)
	Register a finite-energy Airy beam stimulus operator.
SimResult	sim_stimulus_airy_beam_config (struct SimContext *context, size_t operator_index, SimStimulusAiryBeamConfig *out_config)
	Copy the current Airy beam configuration from a registered operator.
SimResult	sim_stimulus_airy_beam_update (struct SimContext *context, size_t operator_index, const SimStimulusAiryBeamConfig *config)
	Replace or renormalize a registered Airy beam stimulus configuration.

Detailed Description

Finite-energy separable Airy beam stimulus.

Evaluates a local beam frame (u, v) and injects A * Ai(u / s_u) * Ai(v / s_v) * exp(a_u * u / s_u + a_v * v / s_v)

• 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_airy_beam_operator()

SimResult sim_add_stimulus_airy_beam_operator	(	struct SimContext *	context,
		const SimStimulusAiryBeamConfig *	config,
		size_t *	out_index
	)

Register a finite-energy Airy beam stimulus operator.

The implementation copies and normalizes config, then registers a split operator that writes the Airy beam into the configured target field.

Parameters

	context	Simulation context that will own the operator.
	config	Optional Airy beam 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_airy_beam_config()

SimResult sim_stimulus_airy_beam_config	(	struct SimContext *	context,
		size_t	operator_index,
		SimStimulusAiryBeamConfig *	out_config
	)

Copy the current Airy beam configuration from a registered operator.

Parameters

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

SimResult sim_stimulus_airy_beam_update	(	struct SimContext *	context,
		size_t	operator_index,
		const SimStimulusAiryBeamConfig *	config
	)

Replace or renormalize a registered Airy beam stimulus configuration.

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

Parameters

context	Simulation context containing the operator.
operator_index	Index of the Airy beam operator to update.
config	Optional replacement configuration.

Returns

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