#include <IrreversibleAdhesiveInteraction.h>

Inheritance diagram for IrreversibleAdhesiveInteraction:

Public Types
typedef IrreversibleAdhesiveSpecies	SpeciesType
	An alias name for IrreversibleAdhesiveSpecies data type. More...

Public Types inherited from ReversibleAdhesiveInteraction
typedef ReversibleAdhesiveSpecies	SpeciesType
	Setting an alias name for ReversibleAdhesiveSpecies. More...

Public Member Functions
	IrreversibleAdhesiveInteraction (BaseInteractable P, BaseInteractable I, Mdouble timeStamp)
	Constructor. More...

	IrreversibleAdhesiveInteraction (const IrreversibleAdhesiveInteraction &p)
	Copy constructor. More...

virtual	~IrreversibleAdhesiveInteraction ()
	Destructor. More...

void	computeAdhesionForce ()
	Computes the Adhesive force. More...

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

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

const IrreversibleAdhesiveSpecies *	getSpecies () const
	A dynamic_cast of BaseSpecies type pointer to a pointer of type IrreversibleAdhesiveSpecies. More...

std::string	getBaseName () const
	Returns the name of the interaction, see Interaction.h. More...

Mdouble	getElasticEnergy () const
	Returns the elastic energy stored in the adhesive spring. More...

Public Member Functions inherited from ReversibleAdhesiveInteraction
	ReversibleAdhesiveInteraction (BaseInteractable P, BaseInteractable I, Mdouble timeStamp)
	Constructor. More...

	ReversibleAdhesiveInteraction (const ReversibleAdhesiveInteraction &p)
	Copy constructor. More...

virtual	~ReversibleAdhesiveInteraction ()
	Destructor. More...

void	computeAdhesionForce ()
	Computes the adhesive forces. More...

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

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

Mdouble	getElasticEnergy () const
	Returns the amount of Elastic energy involved in an interaction. Basically used in case you want to write the elastic energy into an output file. More...

const ReversibleAdhesiveSpecies *	getSpecies () const
	A dynamic_cast of BaseSpecies pointer type to a pointer to an object of type ReversibleAdhesiveSpecies. More...

std::string	getBaseName () const
	Returns the name of the interaction, see Interaction.h. More...

Public Member Functions inherited from BaseInteraction
	BaseInteraction (BaseInteractable P, BaseInteractable I, Mdouble timeStamp)
	A constructor takes the BaseInteractable objects which are interacting (come into contact) and time the interaction starts. More...

	BaseInteraction (const BaseInteraction &p)
	Copy constructor. More...

virtual	~BaseInteraction ()
	The default destructor. More...

virtual void	computeForce ()
	Virtual function that contains the force law between the two objects interacting. More...

void	writeToFStat (std::ostream &os) const
	Writes forces data to the FStat file. More...

virtual std::string	getName () const
	Virtual function which allows interactions to be named. More...

void	setDistance (Mdouble distance)
	Sets the interaction distance between the two interacting objects. More...

void	setNormal (Vec3D normal)
	Sets the normal vector between the two interacting objects. More...

void	setOverlap (Mdouble overlap)
	Set the overlap between the two interacting object. More...

void	setContactPoint (Vec3D contactPoint)
	Set the location of the contact point between the two interacting objects. More...

void	setTimeStamp (Mdouble timeStamp)
	Updates the time step of the interacting. Note, timesteps used to find completed interactions. More...

void	setSpecies (BaseSpecies *species)
	Set the Species of the interaction; note this can either be a Species or MixedSpecies. More...

void	setP (BaseInteractable *P)
	Sets the first object involved in the interaction (normally a particle). More...

void	setI (BaseInteractable *I)
	Sets the second object involved in the interaction (often particle or wall). More...

void	setHandler (InteractionHandler *handler)
	Sets the pointer to the interaction hander which is storing this interaction. More...

InteractionHandler *	getHandler () const
	Gets a point to the interaction handlers to which this interaction belongs. More...

const Vec3D &	getForce () const
	Gets the current force (vector) between the two interacting objects. More...

const Vec3D &	getTorque () const
	Gets the current torque (vector) between the two interacting objects. More...

const Vec3D &	getNormal () const
	Gets the normal vector between the two interacting objects. More...

const Vec3D &	getContactPoint () const
	Gets constant reference to contact point (vector). More...

Mdouble	getOverlap () const
	Returns a Mdouble with the current overlap between the two interacting objects. More...

void	removeFromHandler ()
	Removes this interaction from its interaction hander. More...

void	copySwitchPointer (const BaseInteractable original, BaseInteractable ghost) const
	This copies the interactions of the original particle and replaces the original with the ghost copy. More...

void	gatherContactStatistics ()

BaseInteractable *	getP ()
	Returns a pointer to first object involved in the interaction (normally a particle). More...

BaseInteractable *	getI ()

const BaseInteractable *	getP () const

const BaseInteractable *	getI () const
	Returns a constant pointer to the second object involved in the interaction. More...

Mdouble	getTimeStamp () const
	Returns an Mdouble which is the time stamp of the interaction. More...

virtual void	integrate (Mdouble timeStep)
	integrates variables of the interaction which need to be integrate e.g. the tangential overlap. More...

virtual Mdouble	getTangentialOverlap () const
	get the length of the current tangential overlap More...

Mdouble	getDistance () const
	Returns an Mdouble which is the norm (length) of distance vector. More...

const Vec3D &	getRelativeVelocity () const
	Returns a constant reference to a vector of relative velocity. More...

Mdouble	getNormalRelativeVelocity () const
	Returns a double which is the norm (length) of the relative velocity vector. More...

Mdouble	getAbsoluteNormalForce () const
	Returns the absolute value of the norm (length) of the Normal force vector. More...

virtual BaseInteraction *	copy () const =0
	Makes a copy of the interaction and returns a pointer to the copy. More...

virtual void	rotateHistory (Matrix3D &rotationMatrix)
	When periodic particles are used, some interactions need certain history properties rotated (e.g. tangential springs). This is the function for that. 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
bool	wasInContact_
	A history parameter to store if the particles were in contact or not. Useful to compute adhesive forces. More...

Additional Inherited Members
Protected Member Functions inherited from BaseInteraction
virtual const Vec3D	getTangentialForce () const

Mdouble	getEffectiveRadius () const
	Returns a Mdouble to the effective radius of the interaction. (Not corrected for the overlap) More...

Mdouble	getEffectiveCorrectedRadius ()
	Returns a Mdouble to the effective radius corrected for the overlaps of the particles. More...

void	addForce (Vec3D force)
	add an force increment to the total force. More...

void	addTorque (Vec3D torque)

void	setForce (Vec3D force)
	set total force (this is used by the normal force, tangential forces are added use addForce) More...

void	setTorque (Vec3D torque)
	set the total force (this is used by the normal force, tangential torques are added use addTorque) More...

void	setRelativeVelocity (Vec3D relativeVelocity)
	set the relative velocity of the current of the interactions. More...

void	setNormalRelativeVelocity (Mdouble normalRelativeVelocit)
	set the normal component of the relative velocity. More...

void	setAbsoluteNormalForce (Mdouble absoluteNormalForce)
	the absolute values of the norm (length) of the normal force More...

const BaseSpecies *	getBaseSpecies () const
	Return a constant point to BaseSpecies of the interaction. More...

virtual void	reverseHistory ()
	When periodic particles some interaction need certain history properties reversing. This is the function for that. More...

Detailed Description

Definition at line 39 of file IrreversibleAdhesiveInteraction.h.

Member Typedef Documentation

typedef IrreversibleAdhesiveSpecies IrreversibleAdhesiveInteraction::SpeciesType

An alias name for IrreversibleAdhesiveSpecies data type.

Definition at line 45 of file IrreversibleAdhesiveInteraction.h.

Constructor & Destructor Documentation

IrreversibleAdhesiveInteraction::IrreversibleAdhesiveInteraction	(	BaseInteractable *	P,
		BaseInteractable *	I,
		Mdouble	timeStamp
	)

Constructor.

Parameters

[in]	P
[in]	I
[in]	timeStamp

Definition at line 39 of file IrreversibleAdhesiveInteraction.cc.

References wasInContact_.

     : BaseInteraction(P, I, timeStamp),  ReversibleAdhesiveInteraction(P, I, timeStamp)
 {
     wasInContact_=false;
 #ifdef DEBUG_CONSTRUCTOR
     std::cout<<"IrreversibleAdhesiveInteraction::IrreversibleAdhesiveInteraction() finished"<<std::endl;
 #endif
 }

IrreversibleAdhesiveInteraction::IrreversibleAdhesiveInteraction ( const IrreversibleAdhesiveInteraction & p )

Copy constructor.

Parameters

[in] p

Todo:: tw check if the parameters are valid when inserting the species into the handler

Definition at line 51 of file IrreversibleAdhesiveInteraction.cc.

References wasInContact_.

     : BaseInteraction(p),  ReversibleAdhesiveInteraction(p)
 {
     wasInContact_=p.wasInContact_;
 #ifdef DEBUG_CONSTRUCTOR
     std::cout<<"IrreversibleAdhesiveInteraction::IrreversibleAdhesiveInteraction(const IrreversibleAdhesiveInteraction &p finished"<<std::endl;
 #endif
 }

IrreversibleAdhesiveInteraction::~IrreversibleAdhesiveInteraction ( )

virtual

Destructor.

Definition at line 63 of file IrreversibleAdhesiveInteraction.cc.

 {
 #ifdef DEBUG_DESTRUCTOR
     std::cout<<"IrreversibleAdhesiveInteraction::~IrreversibleAdhesiveInteraction() finished"<<std::endl;
 #endif
 }

Member Function Documentation

void IrreversibleAdhesiveInteraction::computeAdhesionForce ( )

Computes the Adhesive force.

Uses the most basic adhesion contact model.

Definition at line 87 of file IrreversibleAdhesiveInteraction.cc.

References BaseInteraction::addForce(), ReversibleAdhesiveSpecies::getAdhesionForceMax(), ReversibleAdhesiveSpecies::getAdhesionStiffness(), BaseInteraction::getNormal(), BaseInteraction::getOverlap(), getSpecies(), and wasInContact_.

 {
     const IrreversibleAdhesiveSpecies* species = getSpecies();
     if (getOverlap()>=0)
     {
         wasInContact_=true;
         addForce(getNormal() * (-species->getAdhesionForceMax()));
     }
     else if (wasInContact_)
     {
         addForce(getNormal() * (-species->getAdhesionStiffness() *getOverlap() - species->getAdhesionForceMax()));
     }
 }

std::string IrreversibleAdhesiveInteraction::getBaseName ( ) const

Returns the name of the interaction, see Interaction.h.

Returns: std::string

Definition at line 110 of file IrreversibleAdhesiveInteraction.cc.

 {
     return "IrreversibleAdhesive";
 }

Mdouble IrreversibleAdhesiveInteraction::getElasticEnergy ( ) const

virtual

Returns the elastic energy stored in the adhesive spring.

Elastic (=potential) energy is defined as the energy gained by separating two interactables. As it costs energy to separate adhesive interactables, the elastic energy is negative.

Returns: the elastic energy stored in the adhesive spring.

Reimplemented from BaseInteraction.

Definition at line 120 of file IrreversibleAdhesiveInteraction.cc.

References ReversibleAdhesiveSpecies::getAdhesionForceMax(), ReversibleAdhesiveSpecies::getAdhesionStiffness(), BaseInteraction::getOverlap(), getSpecies(), mathsFunc::square(), and wasInContact_.

 {
     if (!wasInContact_)
         return 0.0;
     else if (getOverlap() <= 0)
         return -0.5 * getSpecies()->getAdhesionStiffness() * mathsFunc::square(getOverlap() + getSpecies()->getInteractionDistance());
     else
         return -getSpecies()->getAdhesionForceMax() * getOverlap()
         - 0.5 * getSpecies()->getAdhesionStiffness() * mathsFunc::square(getSpecies()->getInteractionDistance());
 }

const IrreversibleAdhesiveSpecies * IrreversibleAdhesiveInteraction::getSpecies ( ) const

A dynamic_cast of BaseSpecies type pointer to a pointer of type IrreversibleAdhesiveSpecies.

Returns: const pointer of IrreversibleAdhesiveSpecies*

Definition at line 103 of file IrreversibleAdhesiveInteraction.cc.

References BaseInteraction::getBaseSpecies().

Referenced by computeAdhesionForce(), and getElasticEnergy().

 {
     return dynamic_cast<const IrreversibleAdhesiveSpecies *>(getBaseSpecies());
 }

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

virtual

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

Parameters

[in,out] is

Reimplemented from BaseInteraction.

Definition at line 79 of file IrreversibleAdhesiveInteraction.cc.

References wasInContact_.

 {
     std::string dummy;
     is >> dummy >> wasInContact_;
 }

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

virtual

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

Parameters

[in,out] os

Reimplemented from BaseInteraction.

Definition at line 72 of file IrreversibleAdhesiveInteraction.cc.

References wasInContact_.

 {
     os << " wasInContact " << wasInContact_;
 }

Member Data Documentation

bool IrreversibleAdhesiveInteraction::wasInContact_

private

A history parameter to store if the particles were in contact or not. Useful to compute adhesive forces.

Definition at line 93 of file IrreversibleAdhesiveInteraction.h.

Referenced by computeAdhesionForce(), getElasticEnergy(), IrreversibleAdhesiveInteraction(), read(), and write().

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

Interactions/AdhesiveForceInteractions/IrreversibleAdhesiveInteraction.h
Interactions/AdhesiveForceInteractions/IrreversibleAdhesiveInteraction.cc

Public Types

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation