PeriDyno 1.0.0
Loading...
Searching...
No Matches
dyno::ImplicitISPH< TDataType > Class Template Reference

This is an implementation of the Implicit Incompressible SPH (IISPH) solver based on PeriDyno. For details, refer to "Implicit Incompressible SPH" by Ihmsen et al., IEEE TVCG, 2015. The code was written by Shusen Liu, ISCAS, Sep, 2024. More...

#include <ImplicitISPH.h>

Inheritance diagram for dyno::ImplicitISPH< TDataType >:
Collaboration diagram for dyno::ImplicitISPH< TDataType >:

Public Types

typedef TDataType::Real Real
 
typedef TDataType::Coord Coord
 
- Public Types inherited from dyno::ParticleApproximation< TDataType >
typedef TDataType::Real Real
 
- Public Types inherited from dyno::OBase
typedef std::vector< FBase * > FieldVector
 
typedef std::map< FieldID, FBase * > FieldMap
 

Public Member Functions

 ImplicitISPH ()
 
 ~ImplicitISPH () override
 
 DEF_VAR_IN (Real, TimeStep, "Time Step")
 
 DEF_ARRAY_IN (Coord, Position, DeviceType::GPU, "Input particle position")
 Particle positions.
 
 DEF_ARRAY_IN (Coord, Velocity, DeviceType::GPU, "Input particle velocity")
 Particle velocities.
 
 DEF_ARRAYLIST_IN (int, NeighborIds, DeviceType::GPU, "Neighboring particles' ids")
 Neighboring particles' ids.
 
 DEF_ARRAY_OUT (Real, Density, DeviceType::GPU, "Final particle density")
 Final particle densities.
 
 DEF_VAR (int, IterationNumber, 30, "Iteration number of the PBD solver")
 
 DEF_VAR (Real, RestDensity, 1000, "Reference density")
 
 DEF_VAR (Real, Kappa, Real(1), "")
 
 DEF_VAR (Real, RelaxedOmega, Real(0.5f), "")
 
Real takeOneIteration ()
 
void PreIterationCompute ()
 
void updateVelocity ()
 
- Public Member Functions inherited from dyno::ParticleApproximation< TDataType >
 ParticleApproximation ()
 
virtual ~ParticleApproximation ()
 
 DECLARE_ENUM (EKernelType, KT_Smooth=0, KT_Spiky=1)
 
void compute () override
 
 DEF_VAR_IN (Real, SmoothingLength, "Smoothing Length")
 
 DEF_VAR_IN (Real, SamplingDistance, "Particle sampling distance")
 
 DEF_ENUM (EKernelType, KernelType, EKernelType::KT_Spiky, "Rendering mode")
 
- Public Member Functions inherited from dyno::ComputeModule
 ComputeModule ()
 
 ~ComputeModule () override
 
std::string getModuleType () override
 
- Public Member Functions inherited from dyno::Module
 Module (std::string name="default")
 
 ~Module (void) override
 
bool initialize ()
 
void update ()
 
void setName (std::string name)
 
std::string getName () override
 
virtual void setParentNode (Node *node)
 Set the parent node.
 
NodegetParentNode ()
 
SceneGraphgetSceneGraph ()
 
bool isInitialized ()
 
bool attachField (FBase *field, std::string name, std::string desc, bool autoDestroy=true) override
 Attach a field to Base.
 
bool isInputComplete ()
 Check the completeness of input fields.
 
bool isOutputCompete ()
 
 DEF_VAR (bool, ForceUpdate, false, "")
 
void setUpdateAlways (bool b)
 Set the update strategy for the module.
 
- Public Member Functions inherited from dyno::OBase
 OBase ()
 
 ~OBase () override
 
virtual std::string caption ()
 Return the caption.
 
virtual bool captionVisible ()
 Whether to hide the caption in the GUI.
 
virtual std::string description ()
 Return a description for the node or module, override this function to support user-defined description.
 
bool addField (FBase *data)
 Add a field to Base FieldID will be set to the name of Field by default.
 
bool addField (FieldID name, FBase *data)
 Add a field to Base.
 
bool addFieldAlias (FieldID name, FBase *data)
 
bool addFieldAlias (FieldID name, FBase *data, FieldMap &fieldAlias)
 
bool findField (FBase *data)
 Find a field by its pointer.
 
bool findFieldAlias (const FieldID name)
 Find a field by its name.
 
bool findFieldAlias (const FieldID name, FieldMap &fieldAlias)
 Find a field in fieldAlias by its name This function is typically called by other functions.
 
bool removeField (FBase *data)
 Remove a field by its pointer.
 
bool removeFieldAlias (const FieldID name)
 Remove a field by its name.
 
bool removeFieldAlias (const FieldID name, FieldMap &fieldAlias)
 
FBasegetField (const FieldID name)
 Return a field by its name.
 
std::vector< FBase * > & getAllFields ()
 
template<typename T>
TgetField (FieldID name)
 
bool isAllFieldsReady ()
 Check the completeness of all required fields.
 
std::vector< FieldIDgetFieldAlias (FBase *data)
 
int getFieldAliasCount (FBase *data)
 
void setBlockCoord (float x, float y)
 
float bx ()
 
float by ()
 
bool findInputField (FBase *field)
 
bool addInputField (FBase *field)
 
bool removeInputField (FBase *field)
 
std::vector< FBase * > & getInputFields ()
 
bool findOutputField (FBase *field)
 
bool addOutputField (FBase *field)
 
bool addToOutput (FBase *field)
 
bool removeOutputField (FBase *field)
 
bool removeFromOutput (FBase *field)
 
std::vector< FBase * > & getOutputFields ()
 
bool findParameter (FBase *field)
 
bool addParameter (FBase *field)
 
bool removeParameter (FBase *field)
 
std::vector< FBase * > & getParameters ()
 
- Public Member Functions inherited from dyno::Object
 Object ()
 
virtual ~Object ()
 
ObjectId objectId ()
 

Protected Member Functions

void compute () override
 
- Protected Member Functions inherited from dyno::Module
virtual bool initializeImpl ()
 
virtual void preprocess ()
 
virtual void postprocess ()
 
virtual bool validateInputs ()
 
virtual bool validateOutputs ()
 
virtual bool requireUpdate ()
 
virtual void updateStarted ()
 Two functions called at the beginning and end of update() used for debug.
 
virtual void updateEnded ()
 

Private Attributes

DArray< RealmSourceTerm
 
DArray< CoordmDii
 
DArray< RealmAii
 
DArray< RealmAnPn
 
DArray< CoordmSumDijPj
 
DArray< RealmPressrue
 
DArray< RealmOldPressrue
 
DArray< Realm_Residual
 
DArray< RealmPredictDensity
 
DArray< RealmDensityAdv
 
Arithmetic< Real > * m_arithmetic
 
std::shared_ptr< SummationDensity< TDataType > > mSummation
 

Additional Inherited Members

- Static Public Member Functions inherited from dyno::Object
static bool registerClass (ClassInfo *ci)
 
static ObjectcreateObject (std::string name)
 
static std::map< std::string, ClassInfo * > * getClassMap ()
 
static ObjectId baseId ()
 Base Id.
 
- Protected Attributes inherited from dyno::ParticleApproximation< TDataType >
Real mScalingFactor = Real(1)
 
- Protected Attributes inherited from dyno::OBase
std::vector< FBase * > fields_input
 
std::vector< FBase * > fields_output
 
std::vector< FBase * > fields_param
 

Detailed Description

template<typename TDataType>
class dyno::ImplicitISPH< TDataType >

This is an implementation of the Implicit Incompressible SPH (IISPH) solver based on PeriDyno. For details, refer to "Implicit Incompressible SPH" by Ihmsen et al., IEEE TVCG, 2015. The code was written by Shusen Liu, ISCAS, Sep, 2024.

Note
Too large a neighborhood radius may lead to instability, due to the use of second-order particle neighborhoods in the Laplacian.

Definition at line 15 of file ImplicitISPH.h.

Member Typedef Documentation

◆ Coord

template<typename TDataType>
typedef TDataType::Coord dyno::ImplicitISPH< TDataType >::Coord

Definition at line 20 of file ImplicitISPH.h.

◆ Real

template<typename TDataType>
typedef TDataType::Real dyno::ImplicitISPH< TDataType >::Real

Definition at line 19 of file ImplicitISPH.h.

Constructor & Destructor Documentation

◆ ImplicitISPH()

template<typename TDataType>
dyno::ImplicitISPH< TDataType >::ImplicitISPH ( )

◆ ~ImplicitISPH()

template<typename TDataType>
dyno::ImplicitISPH< TDataType >::~ImplicitISPH ( )
override

Member Function Documentation

◆ compute()

template<typename TDataType>
void dyno::ImplicitISPH< TDataType >::compute ( )
overrideprotectedvirtual

Implements dyno::ComputeModule.

◆ DEF_ARRAY_IN() [1/2]

template<typename TDataType>
dyno::ImplicitISPH< TDataType >::DEF_ARRAY_IN ( Coord ,
Position ,
DeviceType::GPU ,
"Input particle position"  )

Particle positions.

◆ DEF_ARRAY_IN() [2/2]

template<typename TDataType>
dyno::ImplicitISPH< TDataType >::DEF_ARRAY_IN ( Coord ,
Velocity ,
DeviceType::GPU ,
"Input particle velocity"  )

Particle velocities.

◆ DEF_ARRAY_OUT()

template<typename TDataType>
dyno::ImplicitISPH< TDataType >::DEF_ARRAY_OUT ( Real ,
Density ,
DeviceType::GPU ,
"Final particle density"  )

Final particle densities.

◆ DEF_ARRAYLIST_IN()

template<typename TDataType>
dyno::ImplicitISPH< TDataType >::DEF_ARRAYLIST_IN ( int ,
NeighborIds ,
DeviceType::GPU ,
"Neighboring particles' ids"  )

Neighboring particles' ids.

◆ DEF_VAR() [1/4]

template<typename TDataType>
dyno::ImplicitISPH< TDataType >::DEF_VAR ( int ,
IterationNumber ,
30 ,
"Iteration number of the PBD solver"  )

◆ DEF_VAR() [2/4]

template<typename TDataType>
dyno::ImplicitISPH< TDataType >::DEF_VAR ( Real ,
Kappa ,
Real(1) ,
""  )

◆ DEF_VAR() [3/4]

template<typename TDataType>
dyno::ImplicitISPH< TDataType >::DEF_VAR ( Real ,
RelaxedOmega ,
Real(0.5f) ,
""  )

◆ DEF_VAR() [4/4]

template<typename TDataType>
dyno::ImplicitISPH< TDataType >::DEF_VAR ( Real ,
RestDensity ,
1000 ,
"Reference density"  )

◆ DEF_VAR_IN()

template<typename TDataType>
dyno::ImplicitISPH< TDataType >::DEF_VAR_IN ( Real ,
TimeStep ,
"Time Step"  )

◆ PreIterationCompute()

template<typename TDataType>
void dyno::ImplicitISPH< TDataType >::PreIterationCompute ( )

◆ takeOneIteration()

template<typename TDataType>
Real dyno::ImplicitISPH< TDataType >::takeOneIteration ( )

◆ updateVelocity()

template<typename TDataType>
void dyno::ImplicitISPH< TDataType >::updateVelocity ( )

Member Data Documentation

◆ m_arithmetic

template<typename TDataType>
Arithmetic<Real>* dyno::ImplicitISPH< TDataType >::m_arithmetic
private

Definition at line 91 of file ImplicitISPH.h.

◆ m_Residual

template<typename TDataType>
DArray<Real> dyno::ImplicitISPH< TDataType >::m_Residual
private

Definition at line 84 of file ImplicitISPH.h.

◆ mAii

template<typename TDataType>
DArray<Real> dyno::ImplicitISPH< TDataType >::mAii
private

Definition at line 74 of file ImplicitISPH.h.

◆ mAnPn

template<typename TDataType>
DArray<Real> dyno::ImplicitISPH< TDataType >::mAnPn
private

Definition at line 76 of file ImplicitISPH.h.

◆ mDensityAdv

template<typename TDataType>
DArray<Real> dyno::ImplicitISPH< TDataType >::mDensityAdv
private

Definition at line 88 of file ImplicitISPH.h.

◆ mDii

template<typename TDataType>
DArray<Coord> dyno::ImplicitISPH< TDataType >::mDii
private

Definition at line 72 of file ImplicitISPH.h.

◆ mOldPressrue

template<typename TDataType>
DArray<Real> dyno::ImplicitISPH< TDataType >::mOldPressrue
private

Definition at line 82 of file ImplicitISPH.h.

◆ mPredictDensity

template<typename TDataType>
DArray<Real> dyno::ImplicitISPH< TDataType >::mPredictDensity
private

Definition at line 86 of file ImplicitISPH.h.

◆ mPressrue

template<typename TDataType>
DArray<Real> dyno::ImplicitISPH< TDataType >::mPressrue
private

Definition at line 80 of file ImplicitISPH.h.

◆ mSourceTerm

template<typename TDataType>
DArray<Real> dyno::ImplicitISPH< TDataType >::mSourceTerm
private

Definition at line 70 of file ImplicitISPH.h.

◆ mSumDijPj

template<typename TDataType>
DArray<Coord> dyno::ImplicitISPH< TDataType >::mSumDijPj
private

Definition at line 78 of file ImplicitISPH.h.

◆ mSummation

template<typename TDataType>
std::shared_ptr<SummationDensity<TDataType> > dyno::ImplicitISPH< TDataType >::mSummation
private

Definition at line 95 of file ImplicitISPH.h.


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