Source code for lsurf.materials.utils.device_functions

# The Clear BSD License
#
# Copyright (c) 2026 Tobias Heibges
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted (subject to the limitations in the disclaimer
# below) provided that the following conditions are met:
#
#      * Redistributions of source code must retain the above copyright notice,
#      this list of conditions and the following disclaimer.
#
#      * Redistributions in binary form must reproduce the above copyright
#      notice, this list of conditions and the following disclaimer in the
#      documentation and/or other materials provided with the distribution.
#
#      * Neither the name of the copyright holder nor the names of its
#      contributors may be used to endorse or promote products derived from this
#      software without specific prior written permission.
#
# NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY
# THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
# CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
# PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
# BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
# IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.

"""
GPU Device Functions (Numba CUDA compatible)

Contains functions designed to be used in Numba CUDA kernels.
These should be compiled with @cuda.jit(device=True) in GPU modules.
"""

import math


[docs] def device_sellmeier_equation( wl_um: float, B1: float, B2: float, B3: float, C1: float, C2: float, C3: float, ) -> float: """ GPU-compatible Sellmeier equation. For use in Numba CUDA kernels. Computes refractive index from wavelength and Sellmeier coefficients. Parameters ---------- wl_um : float Wavelength in micrometers. B1, B2, B3 : float Sellmeier B coefficients. C1, C2, C3 : float Sellmeier C coefficients in μm². Returns ------- n : float Refractive index. Notes ----- This function is designed to be compiled with @cuda.jit(device=True). Import and compile in your GPU module. """ wl2 = wl_um * wl_um n2_minus_1 = B1 * wl2 / (wl2 - C1) + B2 * wl2 / (wl2 - C2) + B3 * wl2 / (wl2 - C3) return math.sqrt(1.0 + n2_minus_1)
[docs] def device_cauchy_equation( wl_um: float, A: float, B: float, C: float, ) -> float: """ GPU-compatible Cauchy equation. For use in Numba CUDA kernels. Computes refractive index from wavelength and Cauchy coefficients. Parameters ---------- wl_um : float Wavelength in micrometers. A : float Constant term. B : float First-order dispersion coefficient in μm². C : float Second-order dispersion coefficient in μm⁴. Returns ------- n : float Refractive index. Notes ----- This function is designed to be compiled with @cuda.jit(device=True). Import and compile in your GPU module. """ wl2 = wl_um * wl_um return A + B / wl2 + C / (wl2 * wl2)