user_system_parameters

user_system_parameters(cls)

Decorate system parameter classes with spatial awareness.

This decorator enables classes to handle spatially varying parameters by transforming them into dataclasses with JAX tree operations and spatial axis tracking.

Parameters

Name Type Description Default
cls type The class to be decorated. required

Returns

Name Type Description
callable A factory function that creates instances with spatial parameter support.

Notes

Similar to the @reaction decorator, this allows parameters to be marked as SpatiallyVarying or SpatiallyConst for vectorized computations.

Back to top