#include <BaseParticle.h>

Inheritance diagram for BaseParticle:

Public Member Functions
	BaseParticle ()
	Basic Particle constructor, creates an Particle at (0,0,0) with radius, mass and inertia equal to 1. More...

	BaseParticle (const BaseParticle &p)
	Particle copy constructor, which accepts as input a reference to a Particle. It creates a copy of this Particle and all it's information. Usually it is better to use the copy() function for polymorfism. More...

virtual	~BaseParticle ()
	Particle destructor, needs to be implemented and checked if it removes tangential spring information. More...

virtual BaseParticle *	copy () const
	Particle copy method. It calls to copy constructor of this Particle, useful for polymorfism. More...

Mdouble	getVolume () const
	Get Particle volume function, which required a reference to the Species vector. It returns the volume of the Particle. More...

void	fixParticle ()
	Fix Particle function. It fixes a Particle by setting its inverse mass and inertia and velocities to zero. More...

bool	isFixed () const
	Is fixed Particle function. It returns whether a Particle is fixed or not, by checking its inverse Mass. More...

void	unfix ()
	Unfix Particle function, which required a reference to the Species vector. It unfixes a Particle by computing the Particles mass and inertia. More...

virtual void	read (std::istream &is)
	Particle read function, which accepts an std::istream as input. More...

virtual MERCURY_DEPRECATED void	oldRead (std::istream &is)
	deprecated version of the read function. More...

virtual void	write (std::ostream &os) const
	Particle print function, which accepts an std::ostream as input. More...

virtual std::string	getName () const
	Returns the name of the object. More...

void	printHGrid (std::ostream &os) const
	Adds particle's HGrid level and cell coordinates to an ostream. More...

unsigned int	getHGridLevel () const
	Returns particle's HGrid level. More...

BaseParticle *	getHGridNextObject () const
	Returns pointer to next object in particle's HGrid level & cell. More...

BaseParticle *	getHGridPrevObject () const
	Returns pointer to previous object in particle's HGrid level & cell. More...

int	getHGridX () const
	Returns particle's HGrid cell X-coordinate. More...

int	getHGridY () const
	Returns particle's HGrid cell Y-coordinate. More...

int	getHGridZ () const
	Returns particle's HGrid cell Z-coordinate. More...

Mdouble	getInertia () const
	Returns the particle's inertia_. More...

Mdouble	getInvInertia () const
	Returns the particle's invInertia_. More...

Mdouble	getInvMass () const
	Returns the particle's invMass_. More...

Mdouble	getKineticEnergy () const
	Calculates the particle's kinetic energy. More...

Mdouble	getMass () const
	Returns the particle's mass_. More...

BaseParticle *	getPeriodicFromParticle () const
	Returns the 'original' particle this one's a periodic copy of. More...

Mdouble	getRadius () const
	Returns the particle's radius_. More...

Mdouble	getInteractionRadius () const
	Returns the particle's interaction radius, which might be different from radius_ (e.g., when dealing with wet particles) More...

Mdouble	getWallInteractionRadius () const
	Returns the interaction radius for interaction with walls. See also BaseParticle::getInteractionRadius(). More...

const Vec3D &	getDisplacement () const
	Returns the particle's displacement relative to the previous time step. More...

const Vec3D &	getPreviousPosition () const
	Returns the particle's position in the previous time step. More...

const Vec3D	getDisplacement2 (Mdouble xmin, Mdouble xmax, Mdouble ymin, Mdouble ymax, Mdouble zmin, Mdouble zmax, Mdouble t) const

void	setInertia (const Mdouble newInertia)
	Sets the particle's inertia_ (and adjusts invInertia_ accordingly) More...

void	setInfiniteInertia ()
	Sets the particle's inertia_ to 'infinite' (1e20) and its invInertia_ to 0. More...

void	setPeriodicFromParticle (BaseParticle *p)
	Assigns the pointer to the 'original' particle this one's a periodic copy of. More...

void	setHGridX (const int x)
	Sets the particle's HGrid cell X-coordinate. More...

void	setHGridY (const int y)
	Sets the particle's HGrid cell Y-coordinate. More...

void	setHGridZ (const int z)
	Sets the particle's HGrid cell Z-coordinate. More...

void	setHGridLevel (const unsigned int level)
	Sets the particle's HGrid level. More...

void	setHGridNextObject (BaseParticle *p)
	Sets the pointer to the next object in the particle's HGrid cell & level. More...

void	setHGridPrevObject (BaseParticle *p)
	Sets the pointer to the previous object in the particle's HGrid cell & level. More...

void	setRadius (const Mdouble radius)
	Sets the particle's radius_ (and adjusts the mass_ accordingly, based on the particle's species) More...

MERCURY_DEPRECATED void	setMass (const Mdouble mass)
	Sets the particle's mass. More...

void	setMassForP3Statistics (const Mdouble mass)
	Sets the particle's mass This function should not be used, but is necessary to extend the CG toolbox to non-spherical particles. More...

void	setDisplacement (const Vec3D &disp)
	Sets the particle's displacement (= difference between current position and that of the previous time step) More...

void	setPreviousPosition (const Vec3D &pos)
	Sets the particle's position in the previous time step. More...

void	movePrevious (const Vec3D &posMove)
	Adds a vector to the particle's previousPosition_. More...

void	accelerate (const Vec3D &vel)
	Increases the particle's velocity_ by the given vector. More...

void	angularAccelerate (const Vec3D &angVel)
	Increases the particle's angularVelocity_ by the given vector. More...

void	addDisplacement (const Vec3D &addDisp)
	Adds a vector to the particle's displacement_. More...

void	setHandler (ParticleHandler *handler)
	Sets the pointer to the particle's ParticleHandler. More...

ParticleHandler *	getHandler () const
	Returns pointer to the particle's ParticleHandler. More...

std::vector< BaseInteraction * >	getInteractionWith (BaseParticle P, Mdouble timeStamp, InteractionHandler interactionHandler)
	Checks if particle is in interaction with given particle P, and if so, returns pointer to the associated BaseInteraction object (else returns 0). More...

void	integrateBeforeForceComputation (double time, double timeStep)
	First step of Velocity Verlet integration. More...

void	integrateAfterForceComputation (double time, double timeStep)
	Second step of Velocity Verlet integration. More...

unsigned int	getParticleDimensions () const
	Returns the particle's dimensions (either 2 or 3). More...

MERCURY_DEPRECATED void	setIndSpecies (unsigned int indSpecies)

void	setSpecies (const ParticleSpecies *species)

virtual unsigned	getNumberOfFieldsVTK () const

virtual std::string	getTypeVTK (unsigned i) const

virtual std::string	getNameVTK (unsigned i) const

virtual std::vector< Mdouble >	getFieldVTK (unsigned i) const

Public Member Functions inherited from BaseInteractable
	BaseInteractable ()
	Default BaseInteractable constructor, it simply creates an empty BaseInteractable. More...

	BaseInteractable (const BaseInteractable &p)
	Copy constructor. It copies the BaseInteractable and all objects it contains. More...

virtual	~BaseInteractable ()
	Destructor, it simply destructs the BaseInteractable and all the objects it contains. More...

unsigned int	getIndSpecies () const
	Returns the index of the Species of this BaseInteractable. More...

const ParticleSpecies *	getSpecies () const
	Returns a pointer to the species of this BaseInteractable. More...

void	setSpecies (const ParticleSpecies *species)
	Sets the species of this BaseInteractable. More...

const Vec3D &	getForce () const
	Returns the force on this BaseInteractable. More...

const Vec3D &	getTorque () const
	Returns the torque on this BaseInteractable. More...

void	setForce (const Vec3D &force)
	Sets the force on this BaseInteractable. More...

void	setTorque (const Vec3D &torque)
	Sets the torque on this BaseInteractable. More...

void	addForce (const Vec3D &addForce)
	Adds an amount to the force on this BaseInteractable. More...

void	addTorque (const Vec3D &addTorque)
	Adds an amount to the torque on this BaseInteractable. More...

const Vec3D &	getPosition () const
	Returns the position of this BaseInteractable. More...

const Vec3D &	getOrientation () const
	Returns the orientation of this BaseInteractable. More...

void	setPosition (const Vec3D &position)
	Sets the position of this BaseInteractable. More...

void	setOrientation (const Vec3D &orientation)
	Sets the orientation of this BaseInteractable. More...

virtual void	move (const Vec3D &move)
	Moves this BaseInteractable by adding an amount to the position. More...

void	rotate (const Vec3D &rotate)
	Rotates this BaseInteractable. More...

const std::list < BaseInteraction * > &	getInteractions () const
	Returns a reference to the list of interactions in this BaseInteractable. More...

void	addInteraction (BaseInteraction *I)
	Adds an interaction to this BaseInteractable. More...

bool	removeInteraction (BaseInteraction *I)
	Removes an interaction from this BaseInteractable. More...

void	copyInteractionsForPeriodicParticles (const BaseInteractable &p)
	Copies interactions to this BaseInteractable whenever a periodic copy made. More...

void	setVelocity (const Vec3D &velocity)
	set the velocity of the BaseInteractable. More...

void	setAngularVelocity (const Vec3D &angularVelocity)
	set the angular velocity of the BaseInteractble. More...

void	addVelocity (const Vec3D &velocity)
	adds an increment to the velocity. More...

void	addAngularVelocity (const Vec3D &angularVelocity)
	add an increment to the angular velocity. More...

virtual const Vec3D &	getVelocity () const
	Returns the velocity of this interactable. More...

virtual const Vec3D &	getAngularVelocity () const
	Returns the angular velocity of this interactable. More...

void	setPrescribedPosition (const std::function< Vec3D(double)> &prescribedPosition)
	Allows the position of an infinite mass interactable to be prescribed. More...

void	applyPrescribedPosition (double time)
	Computes the position from the user defined prescribed position function. More...

void	setPrescribedVelocity (const std::function< Vec3D(double)> &prescribedVelocity)
	Allows the velocity of an infinite mass interactable to be prescribed. More...

void	applyPrescribedVelocity (double time)
	Computes the velocity from the user defined prescribed velocity function. More...

void	setPrescribedOrientation (const std::function< Vec3D(double)> &prescribedOrientation)
	Allows the orientation of the infinite mass interactbale to be prescribed. More...

void	applyPrescribedOrientation (double time)
	Computes the orientation from the user defined prescribed orientation function. More...

void	setPrescribedAngularVelocity (const std::function< Vec3D(double)> &prescribedAngularVelocity)
	Allows the angular velocity of the infinite mass interactable to be prescribed. More...

void	applyPrescribedAngularVelocity (double time)
	Computes the angular velocity from the user defined prescribed angular velocity. More...

virtual const Vec3D	getVelocityAtContact (const Vec3D &contact) const
	Returns the velocity at the contact point, use by many force laws. More...

void	integrateBeforeForceComputation (double time, double timeStep)
	This is part of integrate routine for objects with infinite mass. More...

void	integrateAfterForceComputation (double time, double timeStep)
	This is part of the integration routine for objects with infinite mass. More...

Public Member Functions inherited from BaseObject
	BaseObject ()
	Default constructor. More...

	BaseObject (const BaseObject &p)
	Copy constructor, copies all the objects BaseObject contains. More...

virtual	~BaseObject ()
	virtual destructor More...

virtual void	moveInHandler (const unsigned int index)
	Except that it is virtual, it does the same thing as setIndex() does. More...

void	setIndex (const unsigned int index)
	Allows one to assign an index to an object in the handler/container. More...

void	setId (const unsigned int id)
	Assigns a unique identifier to each object in the handler (container) which remains constant even after the object is deleted from the container/handler. More...

unsigned int	getIndex () const
	Returns the index of the object in the handler. More...

unsigned int	getId () const
	Returns the unique identifier of any particular object. More...

Private Attributes
ParticleHandler *	handler_
	Pointer to the particle's ParticleHandler container. More...

int	HGridX_
	Hgrid attributes. More...

int	HGridY_

int	HGridZ_

unsigned int	HGridLevel_
	Cell position in the grid. More...

BaseParticle *	HGridNextObject_
	Grid level for the object. More...

BaseParticle *	HGridPrevObject_
	Pointer to the next Particle in the same HGrid cell. More...

Mdouble	mass_
	Pointer to the previous Particle in the same HGrid cell. More...

Mdouble	invMass_
	Particle mass_. More...

Mdouble	inertia_
	Inverse Particle mass (for computation optimization) More...

Mdouble	invInertia_
	Particle inertia_. More...

Mdouble	radius_
	Inverse Particle inverse inertia (for computation optimization) More...

BaseParticle *	periodicFromParticle_
	Particle radius_. More...

Vec3D	displacement_
	Pointer to originating Particle. More...

Vec3D	previousPosition_
	Displacement (only used in StatisticsVector, StatisticsPoint) More...

Friends
class	ParticleSpecies
	Particle's position at previous time step. More...

Detailed Description

Definition at line 49 of file BaseParticle.h.

Constructor & Destructor Documentation

BaseParticle::BaseParticle ( )

Basic Particle constructor, creates an Particle at (0,0,0) with radius, mass and inertia equal to 1.

default constructor, creates an Particle at (0,0,0) with radius, mass and inertia equal to 1

Definition at line 38 of file BaseParticle.cc.

References DEBUG, displacement_, handler_, HGridLevel_, HGridNextObject_, HGridPrevObject_, HGridX_, HGridY_, HGridZ_, inertia_, invInertia_, invMass_, logger, mass_, periodicFromParticle_, radius_, and Vec3D::setZero().

Referenced by copy().

 {
     handler_ = nullptr;
     displacement_.setZero();
     radius_ = 1.0;
     mass_ = invMass_ = 1.0;
     inertia_ = invInertia_ = 1.0;
     HGridNextObject_ = nullptr;
 
     periodicFromParticle_ = nullptr;
 #ifdef CONTACT_LIST_HGRID
     firstPossibleContact = nullptr;
 #endif
     HGridNextObject_ = nullptr;
     HGridPrevObject_ = nullptr;
     HGridLevel_ = 99999;
     HGridX_ = 99999;
     HGridY_ = 99999;
     HGridZ_ = 99999;
 
     logger(DEBUG, "BaseParticle::BaseParticle() finished");
 }

BaseParticle::BaseParticle ( const BaseParticle & p )

Particle copy constructor, which accepts as input a reference to a Particle. It creates a copy of this Particle and all it's information. Usually it is better to use the copy() function for polymorfism.

Constructor that copies most of the properties of the given particle. Please note that not everything is copied, for example the position in the HGrid is not determined yet by the end of this constructor. It also does not copy the interactions and the pointer to the handler that handles this particle. Use with care.

Parameters

[in,out] p Reference to the BaseParticle this one should become a copy of.

Definition at line 69 of file BaseParticle.cc.

References DEBUG, displacement_, getInertia(), getInvInertia(), getInvMass(), getMass(), handler_, HGridLevel_, HGridNextObject_, HGridPrevObject_, HGridX_, HGridY_, HGridZ_, inertia_, invInertia_, invMass_, logger, mass_, periodicFromParticle_, and radius_.

 : BaseInteractable(p)
 {
     handler_ = nullptr;
     displacement_ = p.displacement_;
     radius_ = p.radius_;
     mass_ = p.getMass();
     invMass_ = p.getInvMass();
     inertia_ = p.getInertia();
     invInertia_ = p.getInvInertia();
 
     HGridNextObject_ = nullptr;
     HGridPrevObject_ = nullptr;
     HGridX_ = 99999;
     HGridY_ = 99999;
     HGridZ_ = 99999;
     HGridLevel_ = p.HGridLevel_;
 
     periodicFromParticle_ = p.periodicFromParticle_;
 #ifdef CONTACT_LIST_HGRID
     firstPossibleContact = nullptr;
 #endif
     logger(DEBUG, "BaseParticle::BaseParticle(BaseParticle &p) finished");
 }

BaseParticle::~BaseParticle ( )

virtual

Particle destructor, needs to be implemented and checked if it removes tangential spring information.

Destructor. It asks the ParticleHandler to check if this was the smallest or largest particle and adjust itself accordingly.

Definition at line 98 of file BaseParticle.cc.

References ParticleHandler::checkExtremaOnDelete(), DEBUG, getHandler(), BaseObject::getId(), and logger.

 {
     if (getHandler() != nullptr)
     {
         getHandler()->checkExtremaOnDelete(this);
     }
     logger(DEBUG, "BaseParticle::~BaseParticle() of particle % finished.", getId());
 }

Member Function Documentation

void BaseParticle::accelerate ( const Vec3D & vel )

Increases the particle's velocity_ by the given vector.

increases the the particle's velocity_ (BaseInteractable member) by adding the given vector.

Parameters

[in] vel vector to be added to the velocity_

Definition at line 662 of file BaseParticle.cc.

References BaseInteractable::addVelocity().

Referenced by integrateAfterForceComputation(), integrateBeforeForceComputation(), and AngledPeriodicBoundary::shiftPosition().

 {
     addVelocity(vel);
 }

void BaseParticle::addDisplacement ( const Vec3D & addDisp )

Adds a vector to the particle's displacement_.

Lets you add a vector to the particle's displacement_ vector.

Parameters

[in] addDisp vector to be added.

Definition at line 681 of file BaseParticle.cc.

References displacement_.

 {
     displacement_ += addDisp;
 }

void BaseParticle::angularAccelerate ( const Vec3D & angVel )

Increases the particle's angularVelocity_ by the given vector.

increases the particle's angularVelocity_ (BaseInteractable member) by adding the given vector.

Parameters

[in] angVel vector to be added to the angularVelocity_

Definition at line 672 of file BaseParticle.cc.

References BaseInteractable::addAngularVelocity().

Referenced by integrateAfterForceComputation(), integrateBeforeForceComputation(), and AngledPeriodicBoundary::shiftPosition().

 {
     addAngularVelocity(angVel);
 }

BaseParticle * BaseParticle::copy ( ) const

virtual

Particle copy method. It calls to copy constructor of this Particle, useful for polymorfism.

Copy method. Uses copy constructor to create a copy on the heap. Useful for polymorphism.

Returns: pointer to the particle's copy

Reimplemented in LiquidFilmParticle, and ThermalParticle.

Definition at line 112 of file BaseParticle.cc.

References BaseParticle().

Referenced by CircularPeriodicBoundary::checkBoundaryAfterParticleMoved(), LeesEdwardsBoundary::createHorizontalPeriodicParticles(), ShearBoxBoundary::createHorizontalPeriodicParticles(), CircularPeriodicBoundary::createPeriodicParticles(), MaserBoundary::createPeriodicParticles(), AngledPeriodicBoundary::createPeriodicParticles(), PeriodicBoundary::createPeriodicParticles(), ShearBoxBoundary::createVerticalPeriodicParticles(), LeesEdwardsBoundary::createVerticalPeriodicParticles(), ChuteInsertionBoundary::generateParticle(), CubeInsertionBoundary::generateParticle(), HopperInsertionBoundary::generateParticle(), InsertionBoundary::InsertionBoundary(), InsertionBoundary::set(), and InsertionBoundary::setParticleToCopy().

 {
     return new BaseParticle(*this);
 }

void BaseParticle::fixParticle ( )

Fix Particle function. It fixes a Particle by setting its inverse mass and inertia and velocities to zero.

Fixes a BaseParticle by setting its inverse mass and inertia and velocities to zero.

Definition at line 146 of file BaseParticle.cc.

References inertia_, invInertia_, invMass_, mass_, BaseInteractable::setAngularVelocity(), and BaseInteractable::setVelocity().

Referenced by DPMBase::setFixedParticles().

 {
     mass_ = 1e20;
     invMass_ = 0.0;
     inertia_ = 1e20;
     invInertia_ = 0.0;
     setVelocity(Vec3D(0.0, 0.0, 0.0));
     setAngularVelocity(Vec3D(0.0, 0.0, 0.0));
 }

const Vec3D & BaseParticle::getDisplacement ( ) const

Returns the particle's displacement relative to the previous time step.

Returns the particle's displacement_, which is the difference between the current particle's position and its position in the previous time step.

Returns: (reference to) the particle displacement vector

Definition at line 421 of file BaseParticle.cc.

References displacement_.

Referenced by CircularPeriodicBoundary::checkBoundaryAfterParticleMoved(), and integrateBeforeForceComputation().

 {
     return displacement_;
 }

const Vec3D BaseParticle::getDisplacement2	(	Mdouble	xmin,
		Mdouble	xmax,
		Mdouble	ymin,
		Mdouble	ymax,
		Mdouble	zmin,
		Mdouble	zmax,
		Mdouble	t
	)		const

Todo:: see .cc file.

Todo:: Rewrite, redefine (TW). Is only used in StatisticsVector.hcc, consider moving to that class.

Definition at line 439 of file BaseParticle.cc.

References BaseInteractable::getPosition(), getPreviousPosition(), Vec3D::X, Vec3D::Y, and Vec3D::Z.

 {
     Vec3D disp = getPosition() - getPreviousPosition();
     if (xmax > xmin && fabs(disp.X) > .5 * (xmax - xmin))
     {
         if (disp.X > 0)
             disp.X -= xmax - xmin;
         else
             disp.X += xmax - xmin;
     }
     if (ymax > ymin && fabs(disp.Y) > .5 * (ymax - ymin))
     {
         if (disp.Y > 0)
             disp.Y -= ymax - ymin;
         else
             disp.Y += ymax - ymin;
     }
     if (zmax > zmin && fabs(disp.Z) > .5 * (zmax - zmin))
     {
         if (disp.Z > 0)
             disp.Z -= zmax - zmin;
         else
             disp.Z += zmax - zmin;
     }
     disp /= t;
     return disp;
 }

std::vector< Mdouble > BaseParticle::getFieldVTK ( unsigned i ) const

virtual

Reimplemented in LiquidFilmParticle.

Definition at line 864 of file BaseParticle.cc.

                                                              {
     return std::vector<Mdouble>();
 }

ParticleHandler * BaseParticle::getHandler ( ) const

Returns pointer to the particle's ParticleHandler.

Returns the particle's ParticleHandler

Returns: pointer to the particle's ParticleHandler; null if handler not yet specified

Definition at line 701 of file BaseParticle.cc.

References handler_.

Referenced by getParticleDimensions(), integrateAfterForceComputation(), integrateBeforeForceComputation(), setHandler(), setRadius(), and ~BaseParticle().

 {
     return handler_;
 }

unsigned int BaseParticle::getHGridLevel ( ) const

Returns particle's HGrid level.

Returns the particle's HGridLevel_

Returns: the HGridLevel_

Definition at line 266 of file BaseParticle.cc.

References HGridLevel_.

Referenced by Mercury2D::hGridFindContactsWithinTargetCell(), Mercury3D::hGridFindContactsWithinTargetCell(), Mercury2D::hGridFindContactsWithTargetCell(), Mercury3D::hGridFindContactsWithTargetCell(), Mercury3D::hGridFindOneSidedContacts(), Mercury2D::hGridFindOneSidedContacts(), Mercury3D::hGridHasContactsInTargetCell(), Mercury2D::hGridRemoveParticle(), Mercury3D::hGridRemoveParticle(), MercuryBase::hGridUpdateMove(), Mercury3D::hGridUpdateParticle(), and Mercury2D::hGridUpdateParticle().

 {
     return HGridLevel_;
 }

BaseParticle * BaseParticle::getHGridNextObject ( ) const

Returns pointer to next object in particle's HGrid level & cell.

Returns the next object in the particle's HGrid cell

Returns: pointer to the next object in the particle's HGrid cell

Definition at line 275 of file BaseParticle.cc.

References HGridNextObject_.

Referenced by Mercury2D::hGridFindContactsWithinTargetCell(), Mercury3D::hGridFindContactsWithinTargetCell(), Mercury2D::hGridFindContactsWithTargetCell(), Mercury3D::hGridFindContactsWithTargetCell(), Mercury3D::hGridHasContactsInTargetCell(), Mercury2D::hGridRemoveParticle(), and Mercury3D::hGridRemoveParticle().

 {
     return HGridNextObject_;
 }

BaseParticle * BaseParticle::getHGridPrevObject ( ) const

Returns pointer to previous object in particle's HGrid level & cell.

Returns the previous object in the particle's HGrid cell

Returns: pointer to the previous object in the particle's HGrid cell

Definition at line 285 of file BaseParticle.cc.

References HGridPrevObject_.

Referenced by Mercury2D::hGridRemoveParticle(), and Mercury3D::hGridRemoveParticle().

 {
     return HGridPrevObject_;
 }

int BaseParticle::getHGridX ( ) const

Returns particle's HGrid cell X-coordinate.

Get the particle's HGrid cell's X-coordinate

Returns: the particle's HGrid cell's X-coordinate

Definition at line 305 of file BaseParticle.cc.

References HGridX_.

Referenced by Mercury2D::hGridFindContactsWithinTargetCell(), Mercury3D::hGridFindContactsWithinTargetCell(), Mercury2D::hGridFindContactsWithTargetCell(), Mercury3D::hGridFindContactsWithTargetCell(), Mercury3D::hGridFindOneSidedContacts(), Mercury2D::hGridFindOneSidedContacts(), Mercury3D::hGridHasContactsInTargetCell(), Mercury3D::hGridRemoveParticle(), Mercury2D::hGridRemoveParticle(), Mercury3D::hGridUpdateParticle(), and Mercury2D::hGridUpdateParticle().

 {
     return HGridX_;
 }

int BaseParticle::getHGridY ( ) const

Returns particle's HGrid cell Y-coordinate.

Get the particle's HGrid cell's Y-coordinate

Returns: the particle's HGrid cell's Y-coordinate

Definition at line 314 of file BaseParticle.cc.

References HGridY_.

Referenced by Mercury2D::hGridFindContactsWithinTargetCell(), Mercury3D::hGridFindContactsWithinTargetCell(), Mercury2D::hGridFindContactsWithTargetCell(), Mercury3D::hGridFindContactsWithTargetCell(), Mercury3D::hGridFindOneSidedContacts(), Mercury2D::hGridFindOneSidedContacts(), Mercury3D::hGridHasContactsInTargetCell(), Mercury3D::hGridRemoveParticle(), Mercury2D::hGridRemoveParticle(), Mercury3D::hGridUpdateParticle(), and Mercury2D::hGridUpdateParticle().

 {
     return HGridY_;
 }

int BaseParticle::getHGridZ ( ) const

Returns particle's HGrid cell Z-coordinate.

Get the particle's HGrid cell's Z-coordinate

Returns: the particle's HGrid cell's Z-coordinate

Definition at line 323 of file BaseParticle.cc.

References HGridZ_.

Referenced by Mercury3D::hGridFindContactsWithinTargetCell(), Mercury3D::hGridFindContactsWithTargetCell(), Mercury3D::hGridFindOneSidedContacts(), Mercury3D::hGridHasContactsInTargetCell(), Mercury3D::hGridRemoveParticle(), and Mercury3D::hGridUpdateParticle().

 {
     return HGridZ_;
 }

Mdouble BaseParticle::getInertia ( ) const

Returns the particle's inertia_.

Returns the particle's inertia_

Returns: the particle's inertia_

Definition at line 332 of file BaseParticle.cc.

References inertia_.

Referenced by BaseParticle().

 {
     return inertia_;
 }

Mdouble BaseParticle::getInteractionRadius ( ) const

Returns the particle's interaction radius, which might be different from radius_ (e.g., when dealing with wet particles)

Calculates the interaction radius of the particle (when it comes to interaction with other particles), including the effect of a possible additional 'interaction distance' besides the 'normal' radius. The interaction radius differs from the radius_, for example, when dealing with wet particles (i.e. particles with an additional liquid layer, which is dealt with in the particle's species).

Returns: the particle's interaction radius for particle-particle interaction

Definition at line 401 of file BaseParticle.cc.

References BaseSpecies::getInteractionDistance(), BaseInteractable::getSpecies(), and radius_.

 {
     return radius_ + getSpecies()->getInteractionDistance() * 0.5;
 }

std::vector< BaseInteraction * > BaseParticle::getInteractionWith	(	BaseParticle *	P,
		Mdouble	timeStamp,
		InteractionHandler *	interactionHandler
	)

virtual

Checks if particle is in interaction with given particle P, and if so, returns pointer to the associated BaseInteraction object (else returns 0).

Creates/updates a BaseInteraction object, treating the interaction between this particle and a given one, in case there is an overlap between the two.

Parameters

[in]	P	particle to check the interaction with
[in]	timeStamp	time stamp to be assigned to the interaction object (i.e., the current time)
[in,out]	interactionHandler	BaseInteraction container from where the interaction is retrieved, and to which it is assigned (if it is a new interaction).

Returns: the pointer to the interaction object (if the particles overlap), or 0 (if they don't overlap).

Todo:

We should consider setting the contact point to

Author: weinhartt

Implements BaseInteractable.

Definition at line 717 of file BaseParticle.cc.

References InteractionHandler::getInteraction(), getInteractionRadius(), Vec3D::getLengthSquared(), BaseInteraction::getNormal(), BaseInteraction::getOverlap(), BaseInteractable::getPosition(), getRadius(), BaseInteraction::setContactPoint(), BaseInteraction::setDistance(), BaseInteraction::setNormal(), and BaseInteraction::setOverlap().

Referenced by DPMBase::computeInternalForces(), and FileReader::read().

 {
     //get the normal (from P away from the contact)
     Vec3D branchVector = P->getPosition() - getPosition();
     //Get the square of the distance between particle i and particle j
     Mdouble distanceSquared = Vec3D::getLengthSquared(branchVector);
     Mdouble sumOfInteractionRadii = P->getInteractionRadius() + getInteractionRadius();
     std::vector<BaseInteraction*> interactions;
     if (distanceSquared < (sumOfInteractionRadii * sumOfInteractionRadii))
     {
         BaseInteraction* C = interactionHandler->getInteraction(P, this, timeStamp);
         Mdouble distance = std::sqrt(distanceSquared);
         C->setNormal(branchVector / distance);
         C->setOverlap(P->getRadius() + getRadius() - distance);
         C->setDistance(distance);
         C->setContactPoint(P->getPosition() - (P->getRadius() - 0.5 * C->getOverlap()) * C->getNormal());
         //Mdouble ratio=P->getRadius()/(getRadius()+P->getRadius());
         //C->setContactPoint(P->getPosition() - (P->getRadius() - ratio * C->getOverlap()) * C->getNormal());
         interactions.push_back(C);
     }
     return interactions;
 }

Mdouble BaseParticle::getInvInertia ( ) const

Returns the particle's invInertia_.

Returns the particle's inverse inertia_

Returns: the particles invInertia_

Definition at line 341 of file BaseParticle.cc.

References invInertia_.

Referenced by BaseParticle(), integrateAfterForceComputation(), and integrateBeforeForceComputation().

 {
     return invInertia_;
 }

Mdouble BaseParticle::getInvMass ( ) const

Returns the particle's invMass_.

Returns the particle's inverse mass_

Returns: the particle's invMass_

Definition at line 350 of file BaseParticle.cc.

References invMass_.

Referenced by BaseParticle(), ThermalInteraction< NormalForceInteraction >::computeNormalForce(), integrateAfterForceComputation(), and integrateBeforeForceComputation().

 {
     return invMass_;
 }

Mdouble BaseParticle::getKineticEnergy ( ) const

Calculates the particle's kinetic energy.

Calculates the particle's kinetic energy

Returns: the particle's kinetic energy

Definition at line 359 of file BaseParticle.cc.

References Vec3D::getLengthSquared(), BaseInteractable::getVelocity(), and mass_.

 {
     return 0.5 * mass_ * getVelocity().getLengthSquared();
 }

Mdouble BaseParticle::getMass ( ) const

Returns the particle's mass_.

Returns the mass_ of the particle

Returns: the mass_ of the particle

Definition at line 368 of file BaseParticle.cc.

References mass_.

Referenced by BaseParticle(), DPMBase::computeExternalForces(), ParticleSpecies::computeMass(), and BaseInteraction::getEffectiveMass().

 {
     return mass_;
 }

std::string BaseParticle::getName ( ) const

virtual

Returns the name of the object.

Returns the name of the object; in this case 'BaseParticle'.

Returns: The object name.

Implements BaseObject.

Reimplemented in LiquidFilmParticle, and ThermalParticle.

Definition at line 194 of file BaseParticle.cc.

Referenced by InsertionBoundary::write().

 {
     return "BaseParticle";
 }

std::string BaseParticle::getNameVTK ( unsigned i ) const

virtual

Reimplemented in LiquidFilmParticle.

Definition at line 860 of file BaseParticle.cc.

Referenced by ParticleHandler::writeVTK().

                                                    {
     return "";
 }

unsigned BaseParticle::getNumberOfFieldsVTK ( ) const

virtual

Reimplemented in LiquidFilmParticle.

Definition at line 852 of file BaseParticle.cc.

Referenced by ParticleHandler::writeVTK().

                                                   {
     return 0;
 }

unsigned int BaseParticle::getParticleDimensions ( ) const

Returns the particle's dimensions (either 2 or 3).

Returns the amount of dimensions of the particle (2 or 3, basically)

Returns: the number of dimension of the particle

Definition at line 801 of file BaseParticle.cc.

References BaseHandler< T >::getDPMBase(), getHandler(), and DPMBase::getParticleDimensions().

Referenced by ParticleSpecies::computeMass(), and getVolume().

 {
     return getHandler()->getDPMBase()->getParticleDimensions();
 }

BaseParticle * BaseParticle::getPeriodicFromParticle ( ) const

Returns the 'original' particle this one's a periodic copy of.

Returns a pointer to the 'original' particle if the current one is a 'periodic copy' used for a periodic boundary implementation.

Returns: pointer to original particle

Definition at line 378 of file BaseParticle.cc.

References periodicFromParticle_.

Referenced by DPMBase::computeForcesDueToWalls(), DPMBase::computeInternalForces(), LeesEdwardsBoundary::createHorizontalPeriodicParticles(), ShearBoxBoundary::createHorizontalPeriodicParticles(), CircularPeriodicBoundary::createPeriodicParticles(), MaserBoundary::createPeriodicParticles(), AngledPeriodicBoundary::createPeriodicParticles(), PeriodicBoundary::createPeriodicParticles(), ShearBoxBoundary::createVerticalPeriodicParticles(), LeesEdwardsBoundary::createVerticalPeriodicParticles(), LiquidMigrationWilletInteraction::form(), BaseInteraction::gatherContactStatistics(), DPMBase::removeDuplicatePeriodicParticles(), InteractionHandler::removeObjectKeepingPeriodics(), and BaseInteraction::writeToFStat().

 {
     return periodicFromParticle_;
 }

const Vec3D & BaseParticle::getPreviousPosition ( ) const

Returns the particle's position in the previous time step.

Returns: (reference to) the previous position of the particle

Definition at line 430 of file BaseParticle.cc.

References previousPosition_.

Referenced by getDisplacement2().

 {
     return previousPosition_;
 }

Mdouble BaseParticle::getRadius ( ) const

Returns the particle's radius_.

Returns the particle's radius

Returns: particle's radius

Definition at line 387 of file BaseParticle.cc.

References radius_.

Referenced by ParticleSpecies::computeMass(), Chute::createBottom(), BaseInteraction::gatherContactStatistics(), ChuteInsertionBoundary::generateParticle(), HopperInsertionBoundary::generateParticle(), CylindricalWall::getDistanceAndNormal(), InfiniteWallWithHole::getDistanceAndNormal(), BaseInteraction::getEffectiveCorrectedRadius(), BaseInteraction::getEffectiveRadius(), TriangulatedWall::getInteractionWith(), BaseWall::getInteractionWith(), getInteractionWith(), FileReader::read(), ChuteBottom::setupInitialConditions(), DPMBase::writeFstatHeader(), and BaseInteraction::writeToFStat().

 {
     return radius_;
 }

std::string BaseParticle::getTypeVTK ( unsigned i ) const

virtual

Reimplemented in LiquidFilmParticle.

Definition at line 856 of file BaseParticle.cc.

Referenced by ParticleHandler::writeVTK().

                                                    {
     return "";
 }

Mdouble BaseParticle::getVolume ( ) const

Get Particle volume function, which required a reference to the Species vector. It returns the volume of the Particle.

Returns the volume of the BaseParticle, which is calculated using its number of dimensions and radius.

Returns: The actual volume of this BaseParticle.

Definition at line 122 of file BaseParticle.cc.

References ERROR, getParticleDimensions(), handler_, logger, constants::pi, and radius_.

 {
     if (handler_ == nullptr)
     {
         logger(ERROR, "[BaseParticle::getVolume] no particle handler specified");
         return 0;
     }
     switch (getParticleDimensions())
     {
     case 3:
         return (4.0 / 3.0 * constants::pi * radius_ * radius_ * radius_);
     case 2:
         return (constants::pi * radius_ * radius_);
     case 1:
         return (2.0 * radius_);
     default:
         logger(ERROR, "[BaseParticle::getVolume] dimension of the particle is not set");
         return 0;
     }
 }

Mdouble BaseParticle::getWallInteractionRadius ( ) const

Returns the interaction radius for interaction with walls. See also BaseParticle::getInteractionRadius().

The interaction radius of the particle (when it comes to interaction with walls). See also BaseParticle::getInteractionRadius().

Returns: the particle's interaction radius for particle-wall interaction

Definition at line 411 of file BaseParticle.cc.

References BaseSpecies::getInteractionDistance(), BaseInteractable::getSpecies(), and radius_.

Referenced by Screw::getDistanceAndNormal(), TriangulatedWall::Face::getDistanceAndNormal(), Coil::getDistanceAndNormal(), RestrictedWall::getDistanceAndNormal(), SphericalWall::getDistanceAndNormal(), AxisymmetricIntersectionOfWalls::getDistanceAndNormal(), and InfiniteWall::getDistanceAndNormal().

 {
     return radius_ + getSpecies()->getInteractionDistance();
 }

void BaseParticle::integrateAfterForceComputation	(	double	time,
		double	timeStep
	)

Second step of Velocity Verlet integration.

Second step of Velocity Verlet integration (see also http://en.wikipedia.org/wiki/Verlet_integration#Velocity_Verlet).

Parameters

[in]	time	current time
[in]	timeStep	current time step

Definition at line 781 of file BaseParticle.cc.

References accelerate(), angularAccelerate(), BaseInteractable::getForce(), getHandler(), getInvInertia(), getInvMass(), BaseInteractable::getTorque(), and BaseInteractable::integrateAfterForceComputation().

 {
     if (getInvMass() == 0.0)
     {
         BaseInteractable::integrateAfterForceComputation(time, timeStep);
     }
     else
     {
         accelerate(getForce() * getInvMass() * 0.5 * timeStep);
         if (getHandler()->getDPMBase()->getRotation())
         {
             angularAccelerate(getTorque() * getInvInertia() * 0.5 * timeStep);
         }
     }
 }

void BaseParticle::integrateBeforeForceComputation	(	double	time,
		double	timeStep
	)

First step of Velocity Verlet integration.

Todo:: TW: add sum sum fi Wi (the stress gradient) to the statistics

First step of Velocity Verlet integration (see also http://en.wikipedia.org/wiki/Verlet_integration#Velocity_Verlet).

Parameters

[in]	time	current time
[in]	timeStep	current time step

Todo:

If the position is described by the used, one should also call BaseInteractabld::integrateBeforeForceComputation. To check if it works correctly, remove the p0.fixParticle() line from the DrivenParticleUnitTest

Author: irana

Definition at line 751 of file BaseParticle.cc.

References accelerate(), angularAccelerate(), BaseInteractable::getAngularVelocity(), getDisplacement(), BaseHandler< T >::getDPMBase(), BaseInteractable::getForce(), getHandler(), getInvInertia(), getInvMass(), BaseInteractable::getTorque(), BaseInteractable::getVelocity(), DPMBase::hGridUpdateMove(), BaseInteractable::integrateBeforeForceComputation(), BaseInteractable::move(), BaseInteractable::rotate(), and setDisplacement().

 {
     if (getInvMass() == 0.0)
     {
         BaseInteractable::integrateBeforeForceComputation(time, timeStep);
     }
     else
     {
         accelerate(getForce() * getInvMass() * 0.5 * timeStep);
         setDisplacement(getVelocity() * timeStep);
         move(getDisplacement());
         getHandler()->getDPMBase()->hGridUpdateMove(this, getDisplacement().getLength());
         if (getHandler()->getDPMBase()->getRotation())
         {
             angularAccelerate(getTorque() * getInvInertia() * 0.5 * timeStep);
             rotate(getAngularVelocity() * timeStep);
         }
     }
 }

bool BaseParticle::isFixed ( ) const

Is fixed Particle function. It returns whether a Particle is fixed or not, by checking its inverse Mass.

Checks whether a BaseParticle is fixed or not, by checking its inverse Mass.

Returns: TRUE if particle is fixed, i.e. if the inverse mass (invMass_) is 0.

Definition at line 160 of file BaseParticle.cc.

References invMass_.

Referenced by DPMBase::computeExternalForces(), DPMBase::computeInternalForces(), ParticleSpecies::computeMass(), BaseInteraction::gatherContactStatistics(), and BaseInteraction::writeToFStat().

 {
     return (invMass_ == 0.0);
 }

void BaseParticle::movePrevious ( const Vec3D & posMove )

Adds a vector to the particle's previousPosition_.

Lets you add a vector to the particle's previousPosition_ vector.

Parameters

[in] posMove the vector to be added to the current previousPosition_ vector.

Definition at line 652 of file BaseParticle.cc.

References previousPosition_.

 {
     previousPosition_ += posMove;
 }

void BaseParticle::oldRead ( std::istream & is )

virtual

deprecated version of the read function.

Deprecated:: Should NOT BE USED by any new users! Is expected to be obsolete by Mercury 2.0. Please use BaseParticle::read() instead.

This is the previously used version of the read function. Now just kept for legacy purposes.

Deprecated:: Should be gone in Mercury 2.0. Use BaseParticle::read() instead.

Todo:: {fix this function} IFCD: what is broken about it?

Definition at line 227 of file BaseParticle.cc.

References inertia_, invInertia_, invMass_, mass_, setIndSpecies(), BaseInteractable::setOrientation(), and BaseInteractable::setPosition().

Referenced by ParticleHandler::readObject().

 {
 
     unsigned int indSpecies;
     Vec3D orientation;
     Vec3D position;
     is >> invMass_ >> invInertia_ >> indSpecies;
     setPosition(position);
     setOrientation(orientation);
     setIndSpecies(indSpecies);
     if (invMass_ != 0.0)
         mass_ = 1.0 / invMass_;
     else
         mass_ = 1e20;
     if (invInertia_ != 0.0)
         inertia_ = 1.0 / invInertia_;
     else
         inertia_ = 1e20;
 }

void BaseParticle::printHGrid ( std::ostream & os ) const

Adds particle's HGrid level and cell coordinates to an ostream.

Adds the particle's HGridLevel_ and HGRid x/y/z positions to an std::ostream.

Parameters

[in,out] os the ostream which has the mentioned properties added.

Definition at line 253 of file BaseParticle.cc.

References HGridLevel_, HGridX_, HGridY_, and HGridZ_.

 {
     os << "Particle( HGRID_Level:" << HGridLevel_
         << ", HGRID_x:" << HGridX_
         << ", HGRID_y:" << HGridY_
         << ", HGRID_z:" << HGridZ_
         << ")";
 }

void BaseParticle::read ( std::istream & is )

virtual

Particle read function, which accepts an std::istream as input.

Particle read function. Has an std::istream as argument, from which it extracts the radius_, invMass_ and invInertia_, respectively. From these the mass_ and inertia_ are deduced. An additional set of properties is read through the call to the parent's method BaseInteractable::read().

Parameters

[in,out] is input stream with particle properties.

Implements BaseInteractable.

Reimplemented in LiquidFilmParticle, and ThermalParticle.

Definition at line 207 of file BaseParticle.cc.

References inertia_, invInertia_, invMass_, mass_, radius_, and BaseInteractable::read().

Referenced by LiquidFilmParticle::read(), and ThermalParticle::read().

 {
     BaseInteractable::read(is);
     std::string dummy;
     is >> dummy >> radius_ >> dummy >> invMass_ >> dummy >> invInertia_;
     if (invMass_ != 0.0)
         mass_ = 1.0 / invMass_;
     else
         mass_ = 1e20;
     if (invInertia_ != 0.0)
         inertia_ = 1.0 / invInertia_;
     else
         inertia_ = 1e20;
 }

void BaseParticle::setDisplacement ( const Vec3D & disp )

Sets the particle's displacement (= difference between current position and that of the previous time step)

This is used to set the particle displacement_

Parameters

[in] disp the displacement vector

Definition at line 633 of file BaseParticle.cc.

References displacement_.

Referenced by CircularPeriodicBoundary::checkBoundaryAfterParticleMoved(), and integrateBeforeForceComputation().

 {
     displacement_ = disp;
 }

void BaseParticle::setHandler ( ParticleHandler * handler )

Sets the pointer to the particle's ParticleHandler.

Assigns the particle to a ParticleHandler, and assigns a species to it based on the particles indSpecies_ (BaseInteractable data member).

Parameters

[in] handler pointer to the ParticleHandler

Definition at line 691 of file BaseParticle.cc.

References getHandler(), BaseInteractable::getIndSpecies(), BaseHandler< T >::getObject(), handler_, and setSpecies().

Referenced by ParticleHandler::addObject(), Chute::createBottom(), ParticleHandler::readObject(), setSpecies(), and ChuteBottom::setupInitialConditions().

 {
     handler_ = handler;
     setSpecies(getHandler()->getDPMBase()->speciesHandler.getObject(getIndSpecies()));
 }

void BaseParticle::setHGridLevel ( const unsigned int level )

Sets the particle's HGrid level.

Sets the particle's HGridLevel_

Parameters

[in] level the particle's HGridLevel_

Definition at line 536 of file BaseParticle.cc.

References HGridLevel_.

Referenced by HGrid::insertParticleToHgrid().

 {
     HGridLevel_ = level;
 }

void BaseParticle::setHGridNextObject ( BaseParticle * p )

Sets the pointer to the next object in the particle's HGrid cell & level.

Sets the pointer to the next object in the particle's HGrid cell

Parameters

[in] p pointer to the next object

Definition at line 545 of file BaseParticle.cc.

References HGridNextObject_.

Referenced by Mercury2D::hGridRemoveParticle(), Mercury3D::hGridRemoveParticle(), Mercury3D::hGridUpdateParticle(), and Mercury2D::hGridUpdateParticle().

 {
     HGridNextObject_ = p;
 }

void BaseParticle::setHGridPrevObject ( BaseParticle * p )

Sets the pointer to the previous object in the particle's HGrid cell & level.

Sets the pointer to the previous object in the particle's HGrid cell

Parameters

[in] p pointer to the previous object

Definition at line 554 of file BaseParticle.cc.

References HGridPrevObject_.

Referenced by Mercury2D::hGridRemoveParticle(), Mercury3D::hGridRemoveParticle(), Mercury3D::hGridUpdateParticle(), and Mercury2D::hGridUpdateParticle().

 {
     HGridPrevObject_ = p;
 }

void BaseParticle::setHGridX ( const int x )

Sets the particle's HGrid cell X-coordinate.

Set the x-index of the particle's HGrid cell position

Parameters

[in] x x-index of particle's HGrid cell

Definition at line 509 of file BaseParticle.cc.

References HGridX_.

Referenced by Mercury2D::hGridUpdateParticle(), and Mercury3D::hGridUpdateParticle().

 {
     HGridX_ = x;
 }

void BaseParticle::setHGridY ( const int y )

Sets the particle's HGrid cell Y-coordinate.

Set the y-index of the particle's HGrid cell position

Parameters

[in] y y-index of particle's HGrid cell

Definition at line 518 of file BaseParticle.cc.

References HGridY_.

Referenced by Mercury2D::hGridUpdateParticle(), and Mercury3D::hGridUpdateParticle().

 {
     HGridY_ = y;
 }

void BaseParticle::setHGridZ ( const int z )

Sets the particle's HGrid cell Z-coordinate.

Set the z-index of the particle's HGrid cell position

Parameters

[in] z z-index of particle's HGrid cell

Definition at line 527 of file BaseParticle.cc.

References HGridZ_.

Referenced by Mercury3D::hGridUpdateParticle().

 {
     HGridZ_ = z;
 }

void BaseParticle::setIndSpecies ( unsigned int indSpecies )

virtual

Deprecated:: Please use setSpecies(const ParticleSpecies*) instead.

Set the particle's species and species' index. Logs a warning if no ParticleHandler is assigned.

Parameters

[in] indSpecies The index of the species in the SpeciesHandler.

Todo:: TW do we have to update the species stored in the interactions here?

Reimplemented from BaseInteractable.

Definition at line 811 of file BaseParticle.cc.

References ERROR, BaseHandler< T >::getDPMBase(), BaseObject::getId(), BaseHandler< T >::getObject(), handler_, logger, BaseInteractable::setIndSpecies(), setSpecies(), and DPMBase::speciesHandler.

Referenced by oldRead().

 {
     if (handler_ != nullptr)
     {
         setSpecies(handler_->getDPMBase()->speciesHandler.getObject(indSpecies));
     }
     else
     {
         BaseInteractable::setIndSpecies(indSpecies);
         logger(ERROR, "setIndSpecies called on a particle with no particle handler.\n"
                "Therefore I can't request the given species from the species handler.\n"
                " PartID = %", getId());
     }
 }

void BaseParticle::setInertia ( const Mdouble newInertia )

Sets the particle's inertia_ (and adjusts invInertia_ accordingly)

Sets the particle's inertia_ and invInertia_.

Parameters

[in] newInertia the new inertia_ to be set.

Definition at line 471 of file BaseParticle.cc.

References ERROR, inertia_, invInertia_, and logger.

 {
     if (newInertia >= 0)
     {
         inertia_ = newInertia;
         invInertia_ = 1.0 / newInertia;
     }
     else
     {
         logger(ERROR, "Error in set_inertia (%)", newInertia);
     }
 }

void BaseParticle::setInfiniteInertia ( )

Sets the particle's inertia_ to 'infinite' (1e20) and its invInertia_ to 0.

Sets the inertia_ to 1e20 and the invInertia_ (which is actually used in the calculations) to 0.

Definition at line 488 of file BaseParticle.cc.

References inertia_, and invInertia_.

 {
     inertia_ = 1e20;
     invInertia_ = 0;
 } //> i.e. no rotations

void BaseParticle::setMass ( const Mdouble mass )

Sets the particle's mass.

Deprecated:: Please do not set the mass yourself, but use ParticleSpecies->computeMass instead. That makes sure

Sets the mass_ of the particle

Parameters

[in] mass the new particle's mass

Definition at line 590 of file BaseParticle.cc.

References ERROR, invMass_, logger, mass_, and WARN.

 {
     logger(WARN, "WARNING: Do not use particle->setMass, instead use "
            "particleSpecies->computeMass, since this function can cause "
            "inconsistencies between the mass, density and radius of this particle!");
     if (mass >= 0.0)
     {
         if (invMass_ != 0.0) //InvMass=0 is a flag for a fixed particle
         {
             mass_ = mass;
             invMass_ = 1.0 / mass;
         }
     }
     else
     {
         logger(ERROR, "Error in BaseParticle::setMass, the given mass to be set must be positive.");
     }
 }

void BaseParticle::setMassForP3Statistics ( const Mdouble mass )

Sets the particle's mass This function should not be used, but is necessary to extend the CG toolbox to non-spherical particles.

Sets the mass_ of the particle

Parameters

[in] mass the new particle's mass

Definition at line 613 of file BaseParticle.cc.

References ERROR, invMass_, logger, and mass_.

 {
     if(mass >= 0.0)
     {
         if(invMass_ != 0.0) //InvMass=0 is a flag for a fixed particle
         {
             mass_ = mass;
             invMass_ = 1.0 / mass;
         }
     }
     else
     {
         logger(ERROR, "Error in BaseParticle::setMass, the given mass to be set must be positive.");
     }
 } 

void BaseParticle::setPeriodicFromParticle ( BaseParticle * p )

Assigns the pointer to the 'original' particle this one's a periodic copy of.

Lets you set which particle this one is actually a periodic copy of (used in periodic boundary condition implementations).

Parameters

[in] p pointer to the 'original' particle this one is a periodic copy of.

Definition at line 500 of file BaseParticle.cc.

References periodicFromParticle_.

Referenced by LeesEdwardsBoundary::createHorizontalPeriodicParticles(), ShearBoxBoundary::createHorizontalPeriodicParticles(), CircularPeriodicBoundary::createPeriodicParticles(), MaserBoundary::createPeriodicParticles(), AngledPeriodicBoundary::createPeriodicParticles(), PeriodicBoundary::createPeriodicParticles(), LeesEdwardsBoundary::createVerticalPeriodicParticles(), and ShearBoxBoundary::createVerticalPeriodicParticles().

 {
     periodicFromParticle_ = p;
 }

void BaseParticle::setPreviousPosition ( const Vec3D & pos )

Sets the particle's position in the previous time step.

This is used to set the particle's previous position

Parameters

[in] pos the particle's previous position vector.

Definition at line 642 of file BaseParticle.cc.

References previousPosition_.

 {
     previousPosition_ = pos;
 }

void BaseParticle::setRadius ( const Mdouble radius )

Sets the particle's radius_ (and adjusts the mass_ accordingly, based on the particle's species)

Sets the radius of the particle, and from that computes the new mass (using its species) and checks whether it now is either the smallest or biggest particle in its ParticleHandler.

Parameters

[in] radius the new radius

Definition at line 576 of file BaseParticle.cc.

References ParticleHandler::checkExtrema(), ParticleSpecies::computeMass(), getHandler(), BaseInteractable::getSpecies(), and radius_.

Referenced by Chute::createBottom(), ChuteInsertionBoundary::generateParticle(), CubeInsertionBoundary::generateParticle(), HopperInsertionBoundary::generateParticle(), helpers::loadingTest(), helpers::normalAndTangentialLoadingTest(), helpers::objectivenessTest(), FileReader::read(), and ChuteBottom::setupInitialConditions().

 {
     radius_ = radius;
     if (getHandler())
     {
         getSpecies()->computeMass(this);
         getHandler()->checkExtrema(this);
     }
 }

void BaseParticle::setSpecies ( const ParticleSpecies * species )

In addition to the functionality of BaseInteractable::setSpecies, this function sets the pointer to the particleHandler, which is needed to retrieve species information.

Todo:: TW: this function should also check if the particle is the correct particle for the species type

Sets the particle's species. If this particle does not have a handler yet, this function also assigns the ParticleHandler in the same DPMBase as the SpeciesHandler of the given species as its handler.

Parameters

[in] species pointer to the ParticleSpecies object, to be set as the particle's species.

Todo:: TW should we chaeck here if we have the right kind of species for the right kind of particle?

Definition at line 834 of file BaseParticle.cc.

References BaseHandler< T >::getDPMBase(), BaseSpecies::getHandler(), handler_, DPMBase::particleHandler, setHandler(), and BaseInteractable::setSpecies().

Referenced by MaserBoundary::addParticleToMaser(), MaserBoundary::checkBoundaryAfterParticleMoved(), Chute::createBottom(), helpers::loadingTest(), ChuteBottom::makeRoughBottom(), helpers::normalAndTangentialLoadingTest(), helpers::objectivenessTest(), FileReader::read(), DPMBase::readNextDataFile(), ParticleHandler::readObject(), setHandler(), setIndSpecies(), ChuteBottom::setupInitialConditions(), Chute::setupInitialConditions(), and ChuteWithHopper::setupInitialConditions().

 {
     BaseInteractable::setSpecies(species);
     //set pointer to the ParticleHandler handler_, which is needed to retrieve 
     //species information
     //\todo maybe these if statements should throw warnings
     if (handler_ == nullptr)
     {
         SpeciesHandler* sH = species->getHandler();
         DPMBase* dB = sH->getDPMBase();
         if (dB != nullptr)
         {
             setHandler(&dB->particleHandler);
         }
     }
 }

void BaseParticle::unfix ( )

Unfix Particle function, which required a reference to the Species vector. It unfixes a Particle by computing the Particles mass and inertia.

Unfixes the particle by computing the Particles mass and inertia, using the species and radius.

Definition at line 170 of file BaseParticle.cc.

References ParticleSpecies::computeMass(), BaseInteractable::getSpecies(), and invMass_.

Referenced by DPMBase::readNextDataFile().

 {
     invMass_ = 1.0;
     getSpecies()->computeMass(this);
 }

void BaseParticle::write ( std::ostream & os ) const

virtual

Particle print function, which accepts an std::ostream as input.

BaseParticle print method, which accepts an os std::ostream as input. It prints human readable BaseParticle information to the std::ostream.

Parameters

[in,out] os stream to which the info is written

Implements BaseInteractable.

Reimplemented in LiquidFilmParticle, and ThermalParticle.

Definition at line 182 of file BaseParticle.cc.

References invInertia_, invMass_, radius_, and BaseInteractable::write().

Referenced by LiquidFilmParticle::write(), and ThermalParticle::write().

 {
     BaseInteractable::write(os);
     os << " radius " << radius_
         << " invMass " << invMass_
         << " invInertia " << invInertia_;
 }