Basic 3-D particle system solver. More...

#include <Core/Solver/Particle/ParticleSystemSolver3.hpp>

Inheritance diagram for CubbyFlow::ParticleSystemSolver3:

Classes
class	Builder
	Front-end to create ParticleSystemSolver3 objects step by step. More...

Public Member Functions
	ParticleSystemSolver3 ()
	Constructs an empty solver.

	ParticleSystemSolver3 (double radius, double mass)
	Constructs a solver with particle parameters.

	ParticleSystemSolver3 (const ParticleSystemSolver3 &)=delete
	Deleted copy constructor.

	ParticleSystemSolver3 (ParticleSystemSolver3 &&) noexcept=delete
	Deleted move constructor.

	~ParticleSystemSolver3 () override=default
	Default virtual destructor.

ParticleSystemSolver3 &	operator= (const ParticleSystemSolver3 &)=delete
	Deleted copy assignment operator.

ParticleSystemSolver3 &	operator= (ParticleSystemSolver3 &&) noexcept=delete
	Deleted move assignment operator.

double	GetDragCoefficient () const
	Returns the drag coefficient.

void	SetDragCoefficient (double newDragCoefficient)
	Sets the drag coefficient.

double	GetRestitutionCoefficient () const
	Gets the restitution coefficient.

void	SetRestitutionCoefficient (double newRestitutionCoefficient)
	Sets the restitution coefficient.

const Vector3D &	GetGravity () const
	Returns the gravity.

void	SetGravity (const Vector3D &newGravity)
	Sets the gravity.

const ParticleSystemData3Ptr &	GetParticleSystemData () const
	Returns the particle system data.

const Collider3Ptr &	GetCollider () const
	Returns the collider.

void	SetCollider (const Collider3Ptr &newCollider)
	Sets the collider.

const ParticleEmitter3Ptr &	GetEmitter () const
	Returns the emitter.

void	SetEmitter (const ParticleEmitter3Ptr &newEmitter)
	Sets the emitter.

const VectorField3Ptr &	GetWind () const
	Returns the wind field.

void	SetWind (const VectorField3Ptr &newWind)
	Sets the wind.

Public Member Functions inherited from CubbyFlow::PhysicsAnimation
	PhysicsAnimation ()
	Default constructor.

	PhysicsAnimation (const PhysicsAnimation &)=default
	Default copy constructor.

	PhysicsAnimation (PhysicsAnimation &&) noexcept=default
	Default move constructor.

virtual	~PhysicsAnimation ()=default
	Default virtual destructor.

PhysicsAnimation &	operator= (const PhysicsAnimation &)=default
	Default copy assignment operator.

PhysicsAnimation &	operator= (PhysicsAnimation &&) noexcept=default
	Default move assignment operator.

bool	GetIsUsingFixedSubTimeSteps () const
	Returns true if fixed sub-timestepping is used.

void	SetIsUsingFixedSubTimeSteps (bool isUsing)
	Sets true if fixed sub-timestepping is used.

unsigned int	GetNumberOfFixedSubTimeSteps () const
	Returns the number of fixed sub-timesteps.

void	SetNumberOfFixedSubTimeSteps (unsigned int numberOfSteps)
	Sets the number of fixed sub-timesteps.

void	AdvanceSingleFrame ()
	Advances a single frame.

Frame	GetCurrentFrame () const
	Returns current frame.

void	SetCurrentFrame (const Frame &frame)
	Sets current frame cursor (but do not invoke update()).

double	GetCurrentTimeInSeconds () const
	Returns current time in seconds.

Public Member Functions inherited from CubbyFlow::Animation
	Animation ()=default
	Default constructor.

	Animation (const Animation &)=default
	Default copy constructor.

	Animation (Animation &&) noexcept=default
	Default move constructor.

virtual	~Animation ()=default
	Default virtual destructor.

Animation &	operator= (const Animation &)=default
	Default copy assignment operator.

Animation &	operator= (Animation &&) noexcept=default
	Default move assignment operator.

void	Update (const Frame &frame)
	Updates animation state for given `frame`.

Static Public Member Functions
static Builder	GetBuilder ()
	Returns builder fox ParticleSystemSolver3.

Protected Member Functions
void	OnInitialize () override
	Initializes the simulator.

void	OnAdvanceTimeStep (double timeStepInSeconds) override
	Called to advance a single time-step.

virtual void	AccumulateForces (double timeStepInSeconds)
	Accumulates forces applied to the particles.

virtual void	OnBeginAdvanceTimeStep (double timeStepInSeconds)
	Called when a time-step is about to begin.

virtual void	OnEndAdvanceTimeStep (double timeStepInSeconds)
	Called after a time-step is completed.

void	ResolveCollision ()
	Resolves any collisions occurred by the particles.

void	ResolveCollision (ArrayView1< Vector3D > newPositions, ArrayView1< Vector3D > newVelocities)

void	SetParticleSystemData (const ParticleSystemData3Ptr &newParticles)
	Assign a new particle system data.

Protected Member Functions inherited from CubbyFlow::PhysicsAnimation
virtual unsigned int	GetNumberOfSubTimeSteps (double timeIntervalInSeconds) const
	Returns the required number of sub-timesteps for given time interval.

Detailed Description

Basic 3-D particle system solver.

This class implements basic particle system solver. It includes gravity, air drag, and collision. But it does not compute particle-to-particle interaction. Thus, this solver is suitable for performing simple spray-like simulations with low computational cost. This class can be further extend to add more sophisticated simulations, such as SPH, to handle particle-to-particle intersection.

See also: SPHSolver3

Constructor & Destructor Documentation

◆ ParticleSystemSolver3() [1/4]

CubbyFlow::ParticleSystemSolver3::ParticleSystemSolver3 ( )

Constructs an empty solver.

◆ ParticleSystemSolver3() [2/4]

CubbyFlow::ParticleSystemSolver3::ParticleSystemSolver3	(	double	radius,
		double	mass
	)

Constructs a solver with particle parameters.

◆ ParticleSystemSolver3() [3/4]

CubbyFlow::ParticleSystemSolver3::ParticleSystemSolver3 ( const ParticleSystemSolver3 & )

delete

Deleted copy constructor.

◆ ParticleSystemSolver3() [4/4]

CubbyFlow::ParticleSystemSolver3::ParticleSystemSolver3 ( ParticleSystemSolver3 && )

deletenoexcept

Deleted move constructor.

◆ ~ParticleSystemSolver3()

CubbyFlow::ParticleSystemSolver3::~ParticleSystemSolver3 ( )

overridedefault

Default virtual destructor.

Member Function Documentation

◆ AccumulateForces()

virtual void CubbyFlow::ParticleSystemSolver3::AccumulateForces ( double timeStepInSeconds )

protectedvirtual

Accumulates forces applied to the particles.

Reimplemented in CubbyFlow::SPHSolver3.

◆ GetBuilder()

static Builder CubbyFlow::ParticleSystemSolver3::GetBuilder ( )

static

Returns builder fox ParticleSystemSolver3.

◆ GetCollider()

const Collider3Ptr & CubbyFlow::ParticleSystemSolver3::GetCollider ( ) const

Returns the collider.

◆ GetDragCoefficient()

double CubbyFlow::ParticleSystemSolver3::GetDragCoefficient ( ) const

Returns the drag coefficient.

◆ GetEmitter()

const ParticleEmitter3Ptr & CubbyFlow::ParticleSystemSolver3::GetEmitter ( ) const

Returns the emitter.

◆ GetGravity()

const Vector3D & CubbyFlow::ParticleSystemSolver3::GetGravity ( ) const

Returns the gravity.

◆ GetParticleSystemData()

const ParticleSystemData3Ptr & CubbyFlow::ParticleSystemSolver3::GetParticleSystemData ( ) const

Returns the particle system data.

This function returns the particle system data. The data is created when this solver is constructed and also owned by the solver.

Returns: The particle system data.

◆ GetRestitutionCoefficient()

double CubbyFlow::ParticleSystemSolver3::GetRestitutionCoefficient ( ) const

Gets the restitution coefficient.

◆ GetWind()

const VectorField3Ptr & CubbyFlow::ParticleSystemSolver3::GetWind ( ) const

Returns the wind field.

◆ OnAdvanceTimeStep()

void CubbyFlow::ParticleSystemSolver3::OnAdvanceTimeStep ( double timeStepInSeconds )

overrideprotectedvirtual

Called to advance a single time-step.

Implements CubbyFlow::PhysicsAnimation.

◆ OnBeginAdvanceTimeStep()

virtual void CubbyFlow::ParticleSystemSolver3::OnBeginAdvanceTimeStep ( double timeStepInSeconds )

protectedvirtual

Called when a time-step is about to begin.

Reimplemented in CubbyFlow::PCISPHSolver3, and CubbyFlow::SPHSolver3.

◆ OnEndAdvanceTimeStep()

virtual void CubbyFlow::ParticleSystemSolver3::OnEndAdvanceTimeStep ( double timeStepInSeconds )

protectedvirtual

Called after a time-step is completed.

Reimplemented in CubbyFlow::SPHSolver3.

◆ OnInitialize()

void CubbyFlow::ParticleSystemSolver3::OnInitialize ( )

overrideprotectedvirtual

Initializes the simulator.

Reimplemented from CubbyFlow::PhysicsAnimation.

◆ operator=() [1/2]

ParticleSystemSolver3 & CubbyFlow::ParticleSystemSolver3::operator= ( const ParticleSystemSolver3 & )

delete

Deleted copy assignment operator.

◆ operator=() [2/2]

ParticleSystemSolver3 & CubbyFlow::ParticleSystemSolver3::operator= ( ParticleSystemSolver3 && )

deletenoexcept

Deleted move assignment operator.

◆ ResolveCollision() [1/2]

void CubbyFlow::ParticleSystemSolver3::ResolveCollision ( )

protected

Resolves any collisions occurred by the particles.

◆ ResolveCollision() [2/2]

void CubbyFlow::ParticleSystemSolver3::ResolveCollision	(	ArrayView1< Vector3D >	newPositions,
		ArrayView1< Vector3D >	newVelocities
	)

protected

Resolves any collisions occurred by the particles where the particle state is given by the position and velocity arrays.

◆ SetCollider()

void CubbyFlow::ParticleSystemSolver3::SetCollider ( const Collider3Ptr & newCollider )

Sets the collider.

◆ SetDragCoefficient()

void CubbyFlow::ParticleSystemSolver3::SetDragCoefficient ( double newDragCoefficient )

Sets the drag coefficient.

The drag coefficient controls the amount of air-drag. The coefficient should be a positive number and 0 means no drag force.

Parameters

[in] newDragCoefficient The new drag coefficient.

◆ SetEmitter()

void CubbyFlow::ParticleSystemSolver3::SetEmitter ( const ParticleEmitter3Ptr & newEmitter )

Sets the emitter.

◆ SetGravity()

void CubbyFlow::ParticleSystemSolver3::SetGravity ( const Vector3D & newGravity )

Sets the gravity.

◆ SetParticleSystemData()

void CubbyFlow::ParticleSystemSolver3::SetParticleSystemData ( const ParticleSystemData3Ptr & newParticles )

protected

Assign a new particle system data.

◆ SetRestitutionCoefficient()

void CubbyFlow::ParticleSystemSolver3::SetRestitutionCoefficient ( double newRestitutionCoefficient )

Sets the restitution coefficient.

The restitution coefficient controls the bounciness of a particle when it hits a collider surface. The range of the coefficient should be 0 to 1 – 0 means no bounce back and 1 means perfect reflection.

Parameters

[in] newRestitutionCoefficient The new restitution coefficient.

◆ SetWind()

void CubbyFlow::ParticleSystemSolver3::SetWind ( const VectorField3Ptr & newWind )

Sets the wind.

Wind can be applied to the particle system by setting a vector field to the solver.

Parameters

[in] newWind The new wind.

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

Core/Solver/Particle/ParticleSystemSolver3.hpp

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ParticleSystemSolver3() [1/4]

◆ ParticleSystemSolver3() [2/4]

◆ ParticleSystemSolver3() [3/4]

◆ ParticleSystemSolver3() [4/4]

◆ ~ParticleSystemSolver3()

Member Function Documentation

◆ AccumulateForces()

◆ GetBuilder()

◆ GetCollider()

◆ GetDragCoefficient()

◆ GetEmitter()

◆ GetGravity()

◆ GetParticleSystemData()

◆ GetRestitutionCoefficient()

◆ GetWind()

◆ OnAdvanceTimeStep()

◆ OnBeginAdvanceTimeStep()

◆ OnEndAdvanceTimeStep()

◆ OnInitialize()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ ResolveCollision() [1/2]

◆ ResolveCollision() [2/2]

◆ SetCollider()

◆ SetDragCoefficient()

◆ SetEmitter()

◆ SetGravity()

◆ SetParticleSystemData()

◆ SetRestitutionCoefficient()

◆ SetWind()