GpuPluginOmp.cpp File Reference

Plugin entry points for the Phase 1 Kokkos/OpenMP surface solver. More...

#include "../solver/GpuPluginAbi.h"
#include "../solver/ISurfaceSolver.hpp"
#include "ExplicitKokkosSurfaceSolver.hpp"
#include <Kokkos_Core.hpp>
#include <cstdlib>
#include <cstring>

Include dependency graph for GpuPluginOmp.cpp:

Functions
OPENSWMM_GPU_ABI int	openswmm_gpu_probe (OpenSwmmGpuProbe *out)
	Query the plugin for a usable GPU device.
OPENSWMM_GPU_ABI int	openswmm_gpu_host_threads (void)
	(v4, optional) Host thread count the plugin's Kokkos runtime is initialised with; 0 when not yet initialised or not a host backend.
OPENSWMM_GPU_ABI void *	openswmm_make_gpu_explicit_solver (const OpenSwmmGpuProbe *probe)
	Construct the Kokkos explicit LTS marcher surface solver.

Detailed Description

Plugin entry points for the Phase 1 Kokkos/OpenMP surface solver.

Exports the GpuPluginAbi.h contract for the openswmm_gpu_omp plugin. The probe advertises a usable Kokkos-OpenMP backend; the factory constructs a CvodeKokkosSurfaceSolver. The core casts the returned void* back to ISurfaceSolver* and owns it.

Kokkos is initialized lazily on first solver construction and is intentionally NOT finalized: only this plugin uses Kokkos, and finalizing at plugin/process teardown risks destroying Views that outlive the call. Leaving the runtime resident is the safe choice for a dlopen()ed plugin.

Author

Caleb Buahin caleb.nosp@m..bua.nosp@m.hin@g.nosp@m.mail.nosp@m..com

Copyright

Copyright (c) 2026 Caleb Buahin. All rights reserved.

License\n Apache-2.0

Function Documentation

openswmm_gpu_host_threads()

OPENSWMM_GPU_ABI int openswmm_gpu_host_threads

(

void

)

(v4, optional) Host thread count the plugin's Kokkos runtime is initialised with; 0 when not yet initialised or not a host backend.

Kokkos initialises once per process, so this is the number every later solver in the process will run with regardless of requested_threads. The core dlsym()s it optionally — a plugin that does not export it is still accepted.

openswmm_gpu_probe()

OPENSWMM_GPU_ABI int openswmm_gpu_probe

(

OpenSwmmGpuProbe *

out

)

Query the plugin for a usable GPU device.

Must be cheap and side-effect-free beyond backend initialization.

Parameters

out	Caller-allocated struct to fill. Zero-initialized on entry by the plugin.

Returns

0 on success with at least one usable device; non-zero if no device is available or the probe failed. A non-zero return tells the core to fall back to the CPU solver.

openswmm_make_gpu_explicit_solver()

OPENSWMM_GPU_ABI void * openswmm_make_gpu_explicit_solver

(

const OpenSwmmGpuProbe *

probe

)

Construct the Kokkos explicit LTS marcher surface solver.

The only solver factory in the contract: the core dlsym()s it and falls back to the serial CPU ExplicitInertialSolver when a plugin does not export it. Implements BOTH cell closures (FLAT and VFR). Returns an ISurfaceSolver* (as void*) owned by the caller, or NULL.