Class ODEBackend

java.lang.Object

org.episteme.nativ.physics.classical.mechanics.collision.backends.ODEBackend

All Implemented Interfaces:

AlgorithmProvider, Backend, ComputeBackend, CPUBackend, NativeCollisionProvider, NativeBackend, CollisionProvider, MechanicsBackend, SimulationProvider

@AutoService({MechanicsBackend.class,ComputeBackend.class,Backend.class,SimulationProvider.class})
public class ODEBackend
extends Object
implements NativeCollisionProvider, MechanicsBackend, CPUBackend, NativeBackend, SimulationProvider

Implementation of MechanicsBackend for ODE (Open Dynamics Engine).

This provider prefers the native ODE library (via Project Panama) for maximum performance, but falls back to the ode4j Java port if the native library is not available.

Since:

1.1

Author:

Silvere Martin-Michiellot, Gemini AI (Google DeepMind)

Constructor Summary

Constructors

Constructor	Description
ODEBackend()

Method Summary

Modifier and Type	Method	Description
Object	createBackend()	Creates and returns the backend instance (or returns self if it is the backend).
ExecutionContext	createContext()	Creates an execution context for running operations.
RigidBodyBridge	createRigidBody(RigidBody body)	Creates a backend representation for a RigidBody.
PhysicsWorldBridge	createWorld()	Creates a new physics world (simulation environment).
int	detectSphereCollisions(double[] positions, double[] radii, int n, int[] collisions)
int	detectSphereCollisions(MemorySegment positions, MemorySegment radii, int n, MemorySegment collisions, ValueLayout layout)	Performs collision detection between spheres using MemorySegments.
int	detectSphereCollisions(Real[] positions, Real[] radii, int n, int[] collisions)
HardwareAccelerator	getAcceleratorType()	Returns the type of hardware accelerator used by this backend.
String	getAlgorithmType()	Returns the unique category of the algorithm.
String	getDescription()	Returns a description of the backend.
String	getId()	Returns the unique identifier for this backend (e.g., "javafx", "jmol", "cuda").
String	getName()	Returns the display name for UI presentation.
String	getNativeLibraryName()	Returns the name of the native library this backend depends on.
int	getPriority()	Returns the execution priority (higher is better).
String	getStatusMessage()	Returns a human-readable status message for this backend.
String	getType()	Returns the backend type category (e.g., "plotting", "molecular", "tensor", "math").
boolean	isAvailable()	Checks if the provider is available in the current environment.
boolean	isLoaded()	Returns true if the native library is loaded and operational.
void	parallelExecute(List<Runnable> tasks, int parallelism)
void	resolveCollisions(double[] positions, double[] velocities, double[] masses, int n, int[] collisions, int numCollisions)
void	resolveCollisions(MemorySegment positions, MemorySegment velocities, MemorySegment masses, int n, MemorySegment collisions, int numCollisions, ValueLayout layout)	Resolves collisions using MemorySegments.
void	resolveCollisions(Real[] positions, Real[] velocities, Real[] masses, int n, int[] collisions, int numCollisions)
void	shutdown()	Called when the provider is no longer needed (e.g., application shutdown).

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface AlgorithmProvider

description, getMetadata, score

Methods inherited from interface Backend

getAlgorithmProviders, isExplicitlyDisabled

Methods inherited from interface CPUBackend

supportsComplexNumbers, supportsFloatingPoint, supportsParallelOps

Methods inherited from interface MechanicsBackend

score

Methods inherited from interface NativeCollisionProvider

detectSphereCollisions, resolveCollisions

Constructor Details

ODEBackend

public ODEBackend()

Method Details

getId

public String getId()

Description copied from interface: Backend

Returns the unique identifier for this backend (e.g., "javafx", "jmol", "cuda").

Specified by:

getId in interface Backend

Specified by:

getId in interface ComputeBackend

getName

public String getName()

Description copied from interface: Backend

Returns the display name for UI presentation.

Specified by:

getName in interface AlgorithmProvider

Specified by:

getName in interface Backend

Specified by:

getName in interface SimulationProvider

getDescription

public String getDescription()

Description copied from interface: Backend

Returns a description of the backend.

Specified by:

getDescription in interface Backend

Specified by:

getDescription in interface ComputeBackend

isAvailable

public boolean isAvailable()

Description copied from interface: AlgorithmProvider

Checks if the provider is available in the current environment.

Specified by:

isAvailable in interface AlgorithmProvider

Specified by:

isAvailable in interface Backend

Specified by:

isAvailable in interface MechanicsBackend

getStatusMessage

public String getStatusMessage()

Description copied from interface: Backend

Returns a human-readable status message for this backend. Useful for debugging "Unavailable" states.

Specified by:

getStatusMessage in interface Backend

Returns:

status message (e.g., "Ready", "Native library missing", etc.)

shutdown

public void shutdown()

Description copied from interface: AlgorithmProvider

Called when the provider is no longer needed (e.g., application shutdown). Use this to release local resources or close native segments.

Specified by:

shutdown in interface AlgorithmProvider

Specified by:

shutdown in interface Backend

Specified by:

shutdown in interface MechanicsBackend

isLoaded

public boolean isLoaded()

Description copied from interface: NativeCollisionProvider

Returns true if the native library is loaded and operational.

Specified by:

isLoaded in interface NativeBackend

Specified by:

isLoaded in interface NativeCollisionProvider

Returns:

true if the native library has been successfully loaded

getNativeLibraryName

public String getNativeLibraryName()

Description copied from interface: NativeBackend

Returns the name of the native library this backend depends on.

Specified by:

getNativeLibraryName in interface NativeBackend

Returns:

library name (e.g., "openblas", "cuda", "fftw3")

getAcceleratorType

public HardwareAccelerator getAcceleratorType()

Description copied from interface: ComputeBackend

Returns the type of hardware accelerator used by this backend.

Specified by:

getAcceleratorType in interface ComputeBackend

Specified by:

getAcceleratorType in interface CPUBackend

Returns:

the accelerator type

createWorld

public PhysicsWorldBridge createWorld()

Description copied from interface: MechanicsBackend

Creates a new physics world (simulation environment).

Specified by:

createWorld in interface MechanicsBackend

Returns:

a new PhysicsWorld instance

createRigidBody

public RigidBodyBridge createRigidBody(RigidBody body)

Description copied from interface: MechanicsBackend

Creates a backend representation for a RigidBody.

Specified by:

createRigidBody in interface MechanicsBackend

Parameters:

body - the Episteme RigidBody definition

Returns:

the backend implementation

detectSphereCollisions

public int detectSphereCollisions(double[] positions,
 double[] radii,
 int n,
 int[] collisions)

Specified by:

detectSphereCollisions in interface CollisionProvider

Specified by:

detectSphereCollisions in interface NativeCollisionProvider

resolveCollisions

public void resolveCollisions(double[] positions,
 double[] velocities,
 double[] masses,
 int n,
 int[] collisions,
 int numCollisions)

Specified by:

resolveCollisions in interface CollisionProvider

Specified by:

resolveCollisions in interface NativeCollisionProvider

detectSphereCollisions

public int detectSphereCollisions(Real[] positions,
 Real[] radii,
 int n,
 int[] collisions)

Specified by:

detectSphereCollisions in interface CollisionProvider

resolveCollisions

public void resolveCollisions(Real[] positions,
 Real[] velocities,
 Real[] masses,
 int n,
 int[] collisions,
 int numCollisions)

Specified by:

resolveCollisions in interface CollisionProvider

detectSphereCollisions

public int detectSphereCollisions(MemorySegment positions,
 MemorySegment radii,
 int n,
 MemorySegment collisions,
 ValueLayout layout)

Description copied from interface: NativeCollisionProvider

Performs collision detection between spheres using MemorySegments.

Specified by:

detectSphereCollisions in interface CollisionProvider

Specified by:

detectSphereCollisions in interface NativeCollisionProvider

resolveCollisions

public void resolveCollisions(MemorySegment positions,
 MemorySegment velocities,
 MemorySegment masses,
 int n,
 MemorySegment collisions,
 int numCollisions,
 ValueLayout layout)

Description copied from interface: NativeCollisionProvider

Resolves collisions using MemorySegments.

Specified by:

resolveCollisions in interface CollisionProvider

Specified by:

resolveCollisions in interface NativeCollisionProvider

parallelExecute

public void parallelExecute(List<Runnable> tasks,
 int parallelism)

Specified by:

parallelExecute in interface SimulationProvider

getPriority

public int getPriority()

Description copied from interface: AlgorithmProvider

Returns the execution priority (higher is better).

Specified by:

getPriority in interface AlgorithmProvider

Specified by:

getPriority in interface Backend

Specified by:

getPriority in interface MechanicsBackend

getType

public String getType()

Description copied from interface: Backend

Returns the backend type category (e.g., "plotting", "molecular", "tensor", "math").

Specified by:

getType in interface Backend

Specified by:

getType in interface ComputeBackend

Specified by:

getType in interface CPUBackend

Specified by:

getType in interface MechanicsBackend

getAlgorithmType

public String getAlgorithmType()

Description copied from interface: AlgorithmProvider

Returns the unique category of the algorithm.

Specified by:

getAlgorithmType in interface AlgorithmProvider

Specified by:

getAlgorithmType in interface CollisionProvider

Specified by:

getAlgorithmType in interface MechanicsBackend

createContext

public ExecutionContext createContext()

Description copied from interface: ComputeBackend

Creates an execution context for running operations.

The context should be used within a try-with-resources block to ensure proper cleanup of resources.

Specified by:

createContext in interface ComputeBackend

Returns:

new execution context

createBackend

public Object createBackend()

Description copied from interface: Backend

Creates and returns the backend instance (or returns self if it is the backend).

Specified by:

createBackend in interface Backend

Specified by:

createBackend in interface ComputeBackend

Specified by:

createBackend in interface MechanicsBackend

Returns:

The backend implementation object