iMSTK
Interactive Medical Simulation Toolkit
Public Member Functions | List of all members
imstk::PbdConstantDensityConstraint Class Reference

Implements the constant density constraint to simulate fluids. This constraint is global and applied to all vertices passed in during projection. More...

#include <imstkPbdConstantDensityConstraint.h>

Inheritance diagram for imstk::PbdConstantDensityConstraint:
Inheritance graph
[legend]
Collaboration diagram for imstk::PbdConstantDensityConstraint:
Collaboration graph
[legend]

Public Member Functions

void initConstraint (const int numParticles, const int bodyHandle, const double particleRadius, const double density)
 Constant Density Constraint Initialization. More...
 
void projectConstraint (PbdState &bodies, const double dt, const SolverType &type) override
 Solves the constant density constraint.
 
bool computeValueAndGradient (PbdState &imstkNotUsed(bodies), double &imstkNotUsed(c), std::vector< Vec3d > &imstkNotUsed(dcdx)) override
 
void setDensity (const double density)
 Set/Get rest density.
 
double getDensity () const
 
- Public Member Functions inherited from imstk::PbdConstraint
virtual const std::string getTypeName () const =0
 
virtual bool computeValueAndGradient (PbdState &bodies, double &c, std::vector< Vec3d > &dcdx)=0
 Compute value and gradient of the constraint. More...
 
std::vector< PbdParticleId > & getParticles ()
 Get the vertex indices of the constraint.
 
bool getCorrectVelocity () const
 Get/Set whether velocity should be corrected for this constraint.
 
void setCorrectVelocity (const bool correctVelocity)
 
const Vec3d & getGradient (const int i) const
 Get gradient given the particle index in constraint.
 
double getForce (const double dt) const
 Get the force magnitude, valid after solving lambda Only valid with xpbd.
 
double getConstraintC () const
 Get constraint value C (how much the constraint is violated)
 
double getLambda () const
 Get constraint value C (how much the constraint is violated)
 
void zeroOutLambda ()
 Zero's out the lagrange multplier before integration only used for xpbd, must be called before solving.
 
virtual void correctVelocity (PbdState &bodies, const double dt)
 Correct velocities according to friction and restitution Corrects according to the gradient direction.
 
double computeGeneralizedInvMass (const PbdState &bodies, const size_t particleIndex) const
 Compute generalized inverse mass of the particle. Note perf sensitive function. It has been intentionally inlined. More...
 
double computeGeneralizedInvMass (const PbdState &bodies, const size_t particleIndex, const Vec3d &r) const
 Compute generalized inverse mass of the particle. More...
 
double getRestitution () const
 Get/Set restitution.
 
void setRestitution (const double restitution)
 
double getFriction () const
 Get/Set friction.
 
void setFriction (const double friction)
 
double getStiffness () const
 Get/Set the stiffness.
 
void setStiffness (const double stiffness)
 
double getCompliance () const
 Get/Set the compliance This function is also provided in case users need 0 compliance.
 
void setCompliance (const double compliance)
 

Additional Inherited Members

- Public Types inherited from imstk::PbdConstraint
enum  SolverType { xPBD = 0, PBD }
 Type of solvers.
 
- Protected Member Functions inherited from imstk::PbdConstraint
 PbdConstraint (const size_t numParticles)
 
- Protected Attributes inherited from imstk::PbdConstraint
std::vector< PbdParticleIdm_particles
 body, particle index
 
std::vector< Vec3d > m_dcdx
 Normalized constraint gradients (per particle)
 
double m_stiffness = 1.0
 used in PBD, [0, 1]
 
double m_compliance = 1e-7
 used in xPBD, inverse of Stiffness
 
double m_lambda = 0.0
 Lagrange multiplier.
 
double m_C = 0.0
 Constraint Value.
 
double m_friction = 0.0
 
double m_restitution = 0.0
 
bool m_correctVelocity = false
 

Detailed Description

Implements the constant density constraint to simulate fluids. This constraint is global and applied to all vertices passed in during projection.

Definition at line 21 of file imstkPbdConstantDensityConstraint.h.

Member Function Documentation

◆ initConstraint()

void imstk::PbdConstantDensityConstraint::initConstraint ( const int  numParticles,
const int  bodyHandle,
const double  particleRadius,
const double  density 
)

Constant Density Constraint Initialization.

Parameters
Bodiescontaining all the particles
thebody index to simulate as a fluid
stiffness

Definition at line 20 of file imstkPbdConstantDensityConstraint.cpp.


The documentation for this class was generated from the following files: