FluidParticleSystemParams Struct Reference

Describes the NxParameterized::Interface for 'FluidParticleSystemParams' : More...

#include <params.h>

List of all members.

Public Attributes
F32	restParticleDistance
	'restParticleDistance' : Rest distance of particles
F32	stiffness
	'stiffness' : The stiffness of the particle interaction related to the pressure
F32	viscosity
	'viscosity' : The viscosity of the fluid defines its viscous behavior

---

Detailed Description

Describes the NxParameterized::Interface for 'FluidParticleSystemParams' :

FluidParticleSystemParams contains 3 fully qualified names
---------------------------------------------
  1 : F32  restParticleDistance  
  2 : F32  stiffness             
  3 : F32  viscosity             

---

Member Data Documentation

F32 FluidParticleSystemParams::restParticleDistance

'restParticleDistance' : Rest distance of particles

The typical particle distance of particles in the rest state (relaxed). Defines the particle resolution of the fluid. This property can't be changed after the particle fluid has been created. Must be positive.

F32 FluidParticleSystemParams::stiffness

'stiffness' : The stiffness of the particle interaction related to the pressure

This factor linearly scales the force which acts on particles which are closer to each other than the rest spacing. Setting this parameter appropriately is crucial for the simulation. The right value depends on many factors such as viscosity and damping. Values which are too high will result in an unstable simulation, whereas too low values will make the fluid appear "springy" (the fluid acts more compressible). Must be positive.

F32 FluidParticleSystemParams::viscosity

'viscosity' : The viscosity of the fluid defines its viscous behavior

Higher values will result in a honey-like behavior. Viscosity is an effect which depends on the relative velocity of neighboring particles; it reduces the magnitude of the relative velocity. Must be positive.

---

The documentation for this struct was generated from the following file:

• params.h