gs.materials.PBD.Liquid#

class genesis.engine.materials.PBD.liquid.Liquid(*, use_visual_raycasting: bool = False, rho: float = 1000.0, sampler: Literal['pbs', 'random', 'regular'] = 'pbs', density_relaxation: float = 0.2, viscosity_relaxation: float = 0.01)[source]#

Bases: Base[PBDParticleEntity]

The liquid material class for PBD.

Parameters:

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

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

  • density_relaxation (float, optional) – Relaxation factor for solving the density constraint. Default is 0.2.

  • viscosity_relaxation (float, optional) – Relaxation factor used in the viscosity solver. Default is 0.01.

rho: float#
sampler: Literal['pbs', 'random', 'regular']#
density_relaxation: float#
viscosity_relaxation: float#
model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'strict': True, 'validate_default': True}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].