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

#include "../solver/GpuPluginAbi.h"
#include "../solver/ISurfaceSolver.hpp"
#include "CvodeKokkosSurfaceSolver.hpp"
#include "ArkodeKokkosSurfaceSolver.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 void *	openswmm_make_gpu_surface_solver (const OpenSwmmGpuProbe *)
	Construct the GPU surface solver.

OPENSWMM_GPU_ABI void *	openswmm_make_gpu_inertial_solver (const OpenSwmmGpuProbe *)
	Construct the GPU LOCAL-INERTIAL surface solver (MOMENTUM=inertial).

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 MIT License

Function Documentation

◆ 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_inertial_solver()

OPENSWMM_GPU_ABI void * openswmm_make_gpu_inertial_solver ( const OpenSwmmGpuProbe * probe )

Construct the GPU LOCAL-INERTIAL surface solver (MOMENTUM=inertial).

OPTIONAL ABI symbol (does not bump OPENSWMM_GPU_ABI_VERSION): the core dlsym()s it only when the model selects the local-inertial momentum closure, and falls back to the serial CPU ArkodeSurfaceSolver when a plugin does not export it. Returns an ISurfaceSolver* (as void*) owned by the caller, or NULL.

◆ openswmm_make_gpu_surface_solver()

OPENSWMM_GPU_ABI void * openswmm_make_gpu_surface_solver ( const OpenSwmmGpuProbe * probe )

Construct the GPU surface solver.