gs.materials.PBD.Liquid#

class genesis.engine.materials.PBD.liquid.Liquid(rho=1000.0, sampler=None, density_relaxation=0.2, viscosity_relaxation=0.01)[source]#

Bases: Base

The liquid material class for PBD.

Parameters:

  • rho (float, optional) – The rest density of the fluid in kg/m^3. Default is 1000.0.

  • sampler (str, optional) – Particle sampler (‘pbs’, ‘regular’, ‘random’). Note that ‘pbs’ is only supported on Linux for now. Defaults to ‘pbs’ on supported platforms, ‘random’ otherwise.

  • density_relaxation (float, optional) – Relaxation factor for solving the density constraint. Controls the strength of positional correction to enforce incompressibility. Higher values lead to faster convergence but can cause instability. Default is 0.2.

  • viscosity_relaxation (float, optional) – Relaxation factor used in the viscosity solver. Influences the smoothing of relative velocities between neighboring particles. Higher values lead to more viscous (syrupy) fluid behavior. Default is 0.01.

property rho#

The rest density of the fluid (kg/m^3).

property sampler#

Particle sampler (‘pbs’, ‘regular’, ‘random’).

property density_relaxation#

Relaxation coefficient for density constraint solving.

property viscosity_relaxation#

Relaxation coefficient for viscosity-based smoothing.