Coverage for src/beamme/geometric_search/arborx.py: 88%

1# The MIT License (MIT) 

2# 

3# Copyright (c) 2018-2026 BeamMe Authors 

4# 

5# Permission is hereby granted, free of charge, to any person obtaining a copy 

6# of this software and associated documentation files (the "Software"), to deal 

7# in the Software without restriction, including without limitation the rights 

8# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 

9# copies of the Software, and to permit persons to whom the Software is 

10# furnished to do so, subject to the following conditions: 

11# 

12# The above copyright notice and this permission notice shall be included in 

13# all copies or substantial portions of the Software. 

14# 

15# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 

16# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 

17# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 

18# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 

19# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 

20# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 

21# THE SOFTWARE. 

22"""This file defines the interface to the ArborX geometric search functionality.""" 

23 

24from beamme.geometric_search.utils import arborx_is_available as _arborx_is_available 

25 

26if _arborx_is_available(): 

27 from beamme.geometric_search.arborx_lib import ( 

28 find_close_points as _find_close_points, 

29 ) 

30 from beamme.geometric_search.arborx_lib import ( 

31 kokkos_finalize as _kokkos_finalize, 

32 ) 

33 from beamme.geometric_search.arborx_lib import ( 

34 kokkos_initialize as _kokkos_initialize, 

35 ) 

36 

37 

38class KokkosScopeGuardWrapper: 

39 """Wrap the initialize and finalize calls to Kokkos.""" 

40 

41 def __init__(self): 

42 """Call initialize when this object is created.""" 

43 _kokkos_initialize() 

44 

45 def __del__(self): 

46 """Finalize Kokkos after this object goes out of scope, i.e., at the end of this 

47 modules lifetime.""" 

48 _kokkos_finalize() 

49 

50 

51if _arborx_is_available(): 

52 # Create the scope guard 

53 kokkos_scope_guard_wrapper = KokkosScopeGuardWrapper() 

54 

55 

56def find_close_points_arborx(point_coordinates, tol): 

57 """Call the ArborX implementation of find close_points.""" 

58 if _arborx_is_available(): 

59 return _find_close_points(point_coordinates, tol) 

60 else: 

61 raise ModuleNotFoundError("ArborX functionality is not available")