An implementation of the energy-based surface model proposed by He et al.[2024]. Refer to "Robust Simulation of Sparsely Sampled Thin Features in SPH-Based Free Surface Flows", ACM TOG 2014, for more details. More...

#include <SurfaceEnergyForce.h>

Inheritance diagram for dyno::SurfaceEnergyForce< TDataType >:

[legend]

Collaboration diagram for dyno::SurfaceEnergyForce< TDataType >:

[legend]

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
	SurfaceEnergyForce ()

	~SurfaceEnergyForce () override

	DEF_VAR (Real, Kappa, Real(1), "Surface tension coefficient")

	DEF_VAR (Real, RestDensity, Real(1000), "Rest density")

	DEF_VAR_IN (Real, TimeStep, "Time step size!")

	DEF_ARRAY_IN (Coord, Position, DeviceType::GPU, "")

	DEF_ARRAY_IN (Coord, Velocity, DeviceType::GPU, "")

	DEF_ARRAYLIST_IN (int, NeighborIds, DeviceType::GPU, "Neighboring particles' ids")
	Neighboring particles.

void	compute () override

Public Member Functions inherited from dyno::ParticleApproximation< TDataType >
	ParticleApproximation ()

virtual	~ParticleApproximation ()

	DECLARE_ENUM (EKernelType, KT_Smooth=0, KT_Spiky=1)

	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.

Node *	getParentNode ()

SceneGraph *	getSceneGraph ()

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)

FBase *	getField (const FieldID name)
	Return a field by its name.

std::vector< FBase * > &	getAllFields ()

template<typename T>
T *	getField (FieldID name)

bool	isAllFieldsReady ()
	Check the completeness of all required fields.

std::vector< FieldID >	getFieldAlias (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 ()

Private Attributes
DArray< Real >	mFreeSurfaceEnergy

Additional Inherited Members
Static Public Member Functions inherited from dyno::Object
static bool	registerClass (ClassInfo *ci)

static Object *	createObject (std::string name)

static std::map< std::string, ClassInfo * > *	getClassMap ()

static ObjectId	baseId ()
	Base Id.

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 ()

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::SurfaceEnergyForce< TDataType >

An implementation of the energy-based surface model proposed by He et al.[2024]. Refer to "Robust Simulation of Sparsely Sampled Thin Features in SPH-Based Free Surface Flows", ACM TOG 2014, for more details.

Definition at line 26 of file SurfaceEnergyForce.h.

Member Typedef Documentation

◆ Coord

template<typename TDataType>

typedef TDataType::Coord dyno::SurfaceEnergyForce< TDataType >::Coord

Definition at line 31 of file SurfaceEnergyForce.h.

◆ Real

template<typename TDataType>

typedef TDataType::Real dyno::SurfaceEnergyForce< TDataType >::Real

Definition at line 30 of file SurfaceEnergyForce.h.

Constructor & Destructor Documentation

◆ SurfaceEnergyForce()

template<typename TDataType>

dyno::SurfaceEnergyForce< TDataType >::SurfaceEnergyForce ( )

◆ ~SurfaceEnergyForce()

template<typename TDataType>

dyno::SurfaceEnergyForce< TDataType >::~SurfaceEnergyForce ( )

override

Member Function Documentation

◆ compute()

template<typename TDataType>

void dyno::SurfaceEnergyForce< TDataType >::compute ( )

overridevirtual

Reimplemented from dyno::ParticleApproximation< TDataType >.

◆ DEF_ARRAY_IN() [1/2]

template<typename TDataType>

dyno::SurfaceEnergyForce< TDataType >::DEF_ARRAY_IN	(	Coord	,
		Position	,
		DeviceType::GPU	,
		""	)

◆ DEF_ARRAY_IN() [2/2]

template<typename TDataType>

dyno::SurfaceEnergyForce< TDataType >::DEF_ARRAY_IN	(	Coord	,
		Velocity	,
		DeviceType::GPU	,
		""	)

◆ DEF_ARRAYLIST_IN()

template<typename TDataType>

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

Neighboring particles.

◆ DEF_VAR() [1/2]

template<typename TDataType>

dyno::SurfaceEnergyForce< TDataType >::DEF_VAR	(	Real	,
		Kappa	,
		Real(1)	,
		"Surface tension coefficient"	)

◆ DEF_VAR() [2/2]

template<typename TDataType>

dyno::SurfaceEnergyForce< TDataType >::DEF_VAR	(	Real	,
		RestDensity	,
		Real(1000)	,
		"Rest density"	)

◆ DEF_VAR_IN()

template<typename TDataType>

dyno::SurfaceEnergyForce< TDataType >::DEF_VAR_IN	(	Real	,
		TimeStep	,
		"Time step size!"	)

Member Data Documentation

◆ mFreeSurfaceEnergy

template<typename TDataType>

DArray<Real> dyno::SurfaceEnergyForce< TDataType >::mFreeSurfaceEnergy

private

Definition at line 57 of file SurfaceEnergyForce.h.

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

D:/Peridyno/peridyno/src/Dynamics/Cuda/ParticleSystem/Module/SurfaceEnergyForce.h

Public Types

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Coord

◆ Real

Constructor & Destructor Documentation

◆ SurfaceEnergyForce()

◆ ~SurfaceEnergyForce()

Member Function Documentation

◆ compute()

◆ DEF_ARRAY_IN() [1/2]

◆ DEF_ARRAY_IN() [2/2]

◆ DEF_ARRAYLIST_IN()

◆ DEF_VAR() [1/2]

◆ DEF_VAR() [2/2]

◆ DEF_VAR_IN()

Member Data Documentation

◆ mFreeSurfaceEnergy