API reference#

jaxdem#

jaxdem.collider

Interface for defining colliders.

jaxdem.domain

Interface for defining domains.

jaxdem.factory

The factory defines and instantiates specific simulation components.

jaxdem.forceRouter

Interface for combining force laws and for defining the species forces matrix.

jaxdem.forces

Interface for defining force laws and their corresponding potential energy.

jaxdem.integrator

Interface for defining time integrators.

jaxdem.material

Interface for defining materials and the MaterialTable.

jaxdem.materialMatchmaker

Tooling for mixing materials of the same type.

jaxdem.rl

jaxdem.rl.environment

Interface for defining reinforcement learning environments.

jaxdem.state

Defines the simulation State.

jaxdem.system

Defines the simulation configuration and the tooling for driving the simulation.

jaxdem.utils

Utility functions used to set up simulations and analyze the output.

jaxdem.writer

Interface for defining data writers.