jaxdem.utils

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

Modules

angles	Utility functions to compute angles between vectors.
clumps	Mass properties of unions of disks and spheres with maximum overlap density.
contacts	Contact forces, stress, coordination, friction, and rattler analysis.
dispersity	Utility functions to assign radius dispersity.
dynamical_matrix	Energy Hessians in sphere and rigid-clump coordinates.
dynamics_routines	Protocols that interleave integration with periodic state/system rescaling.
environment	Utility functions to handle environments and LIDAR sensor.
geometric_asperity_creation	Legacy utility functions for creating Geometric Asperity particle states in 2D and 3D.
grid_state(*, n_per_axis, spacing[, radius, ...])	Create a state where particles sit on a rectangular lattice.
h5	HDF5 save/load utilities using the shared JaxDEM schema.
jamming	Search for equilibrated packings using energy or pressure criteria.
linalg	Utility functions to help with linear algebra.
load_legacy	Adapter for loading HDF5 data saved with the pre-merge-2-27-26 branch.
meshes	Asperity mesh generators for geometric-asperity (GA) particles.
neighbor_list_sizing	Measure neighbor candidates and estimate capacity from relaxed bounding spheres.
packing_utils	Utility functions for calculating and changing the packing fraction.
particle_creation	Utility functions for creating states of GA particles (rigid/DP).
post_processing	Packing summaries, contact networks, and energy spectra.
quaternion	Quaternion math utilities.
random_sphere_configuration	Generate random, energy-minimized sphere configurations in 2D or 3D.
random_state(*, N, dim[, box_size, ...])	Generate N non-overlap-checked particles uniformly in an axis-aligned box.
randomize_orientations(state, key)	Randomize orientations for clumps (particles with repeated state.clump_id), leaving spheres unchanged.
rollout_schedules	Utilities to generate step indices for trajectory logging.
serialization	Import-path encoding and restoration of checkpoint callables.
serialization_schema	Shared file-level serialization schema for Orbax and HDF5 payloads.
surface_properties	Monte-Carlo-style sampling of the surface of a clump particle with a tracer clump.
thermal	Utility functions to compute thermodynamic quantities.