⚙️ Simulation Parameters¶
Application-wide simulation parameters. Accessed via frontend.App.get_default_param() and overridden per session with session.param.set(key, value) / session.param.get(key) (see frontend.ParamManager). Keys use hyphens, not underscores.
disable-contact¶
Key |
|
Default |
|
Label |
Disable Contact |
Description |
When enabled, the simulation will not perform any contact detection. |
keep-states¶
Key |
|
Default |
|
Label |
Keep States |
Description |
Number of simulation states to keep in the output directory. |
keep-verts¶
Key |
|
Default |
|
Label |
Keep Vertices |
Description |
Number of vertex data files to keep in the output directory. 0 means no limit (unlimited). Minimum is 1 to ensure visualization. |
dt¶
Key |
|
Default |
|
Label |
Step Size |
Description |
Step size for the simulation. Small step size increases accuracy, large step size increases speed but may cause solver divergence. |
inactive-momentum¶
Key |
|
Default |
|
Label |
Inactive Momentum |
Description |
Enable inactive momentum mode for the simulation. Adjusts step size and disables inertia. |
playback¶
Key |
|
Default |
|
Label |
Playback Speed |
Description |
Playback speed. 1.0 is normal, >1.0 is faster, <1.0 is slower. |
min-newton-steps¶
Key |
|
Default |
|
Label |
Lower Bound of Newton Steps |
Description |
Minimal Newton’s steps to advance a step. Recommended 32 if static friction is present. |
target-toi¶
Key |
|
Default |
|
Label |
Target Accumulated Time of Impact (TOI) |
Description |
Accumulated TOI threshold for Newton’s loop termination. |
air-friction¶
Key |
|
Default |
|
Label |
Air Tangental Friction |
Description |
Ratio of tangential friction to normal friction for air drag/lift. |
line-search-max-t¶
Key |
|
Default |
|
Label |
Extended Line Search Maximum Time |
Description |
Factor to extend TOI for CCD to avoid possible solver divergence. |
constraint-ghat¶
Key |
|
Default |
|
Label |
Gap Distance for Boundary Conditions |
Description |
Gap distance to activate boundary condition barriers. |
constraint-tol¶
Key |
|
Default |
|
Label |
Moving Constraint Minimum Gap Tolerance |
Description |
This factor is multiplied to the constraint gap to determine the CCD tolerance for moving constraints. |
fps¶
Key |
|
Default |
|
Label |
Frame Per Second for Video Frames |
Description |
Frame rate for output video. |
cg-max-iter¶
Key |
|
Default |
|
Label |
Maximum Number of PCG Iterations |
Description |
PCG solver is regarded as diverged if this is exceeded. |
cg-tol¶
Key |
|
Default |
|
Label |
Relative Tolerance for PCG |
Description |
Relative tolerance for PCG solver termination. |
ccd-eps¶
Key |
|
Default |
|
Label |
ACCD Epsilon |
Description |
Small thickness tolerance for ACCD gap distance checks. |
ccd-reduction¶
Key |
|
Default |
|
Label |
CCD Reduction Factor |
Description |
Factor multiplied to the initial gap to set the CCD threshold. |
ccd-max-iter¶
Key |
|
Default |
|
Label |
Maximum CCD Iterations |
Description |
Maximum number of iterations for ACCD. |
max-dx¶
Key |
|
Default |
|
Label |
Maximum Search Direction |
Description |
Maximum allowable search direction magnitude during optimization. |
eiganalysis-eps¶
Key |
|
Default |
|
Label |
Epsilon for Eigenvalue Analysis |
Description |
Epsilon for stable eigenvalue analysis when singular values are close. |
friction-eps¶
Key |
|
Default |
|
Label |
Epsilon for Friction |
Description |
Small value to avoid division by zero in quadratic friction model. |
csrmat-max-nnz¶
Key |
|
Default |
|
Label |
Maximal Matrix Entries for Contact Matrix Entries on the GPU |
Description |
Pre-allocated contact matrix entries for GPU. Too large may cause OOM, too small may cause failure. |
frames¶
Key |
|
Default |
|
Label |
Maximal Frame Count to Simulate |
Description |
Maximal number of frames to simulate. |
auto-save¶
Key |
|
Default |
|
Label |
Auto Save Interval |
Description |
Interval (in frames) for auto-saving simulation state. 0 disables auto-save. |
barrier¶
Key |
|
Default |
|
Label |
Barrier Model for Contact |
Description |
Contact barrier potential model. Choices: cubic, quad, log. |
friction-mode¶
Key |
|
Default |
|
Label |
Friction Combination Mode |
Description |
How to combine the friction coefficients of two contacting elements. Choices: min, max, mean. Default min preserves the prior behavior (the more slippery side wins). |
stitch-stiffness¶
Key |
|
Default |
|
Label |
Stiffness Factor for Stitches |
Description |
Stiffness factor for the stitches. |
air-density¶
Key |
|
Default |
|
Label |
Air Density |
Description |
Air density for drag and lift force computation. |
isotropic-air-friction¶
Key |
|
Default |
|
Label |
Air Dragging Coefficient |
Description |
Per-vertex air dragging coefficient. |
gravity¶
Key |
|
Default |
|
Label |
Gravity Vector |
Description |
Gravity acceleration vector (solver Y-up). |
wind¶
Key |
|
Default |
|
Label |
Wind Force |
Description |
Wind force vector (XYZ). |
include-face-mass¶
Key |
|
Default |
|
Label |
Flag to Include Shell Mass for Volume Solids |
Description |
Include shell mass for surface elements of volume solids. |
fix-xz¶
Key |
|
Default |
|
Label |
Whether to fix xz positions |
Description |
Fix xz positions for falling objects if y > this value. 0.0 disables. Use an extremely small value if nearly a zero is needed. |
fake-crash-frame¶
Key |
|
Default |
|
Label |
Fake Crash Frame |
Description |
Frame number to intentionally crash simulation for testing. -1 disables. |