MercuryDPM  Beta
EmptyFrictionInteraction Class Reference

In case one wants to have a frictionless interaction between the interactables (particles or walls), the following class can be used. See Interaction.h, where one can set the FrictionalForceInteraction to EmptyFrictionInteraction. More...

#include <EmptyFrictionInteraction.h>

Inheritance diagram for EmptyFrictionInteraction:

## Public Types

typedef EmptyFrictionSpecies SpeciesType
An alias name for EmptyFrictionSpecies. More...

## Public Member Functions

EmptyFrictionInteraction (BaseInteractable *P, BaseInteractable *I, Mdouble timeStamp)
Constructor. More...

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

virtual ~EmptyFrictionInteraction ()
Destructor. More...

void computeFrictionForce ()
Computes nothing, it is an empty function. More...

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

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

Mdouble getElasticEnergy () const
Returns zero as it is an frictionless interaction. More...

const EmptyFrictionSpeciesgetSpecies () const
Returns a const pointer of type EmptyFrictionSpecies*. More...

std::string getBaseName () const
Returns interaction name/type. More...

void integrate (Mdouble timeStep)
Does nothing as there is no force. More...

Mdouble getTangentialOverlap () const
Returns zero overlap. More...

const Vec3D getTangentialForce () const
Returns zero tangential force. 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...

InteractionHandlergetHandler () const
Gets a point to the interaction handlers to which this interaction belongs. More...

const Vec3DgetForce () const
Gets the current force (vector) between the two interacting objects. More...

const Vec3DgetTorque () const
Gets the current torque (vector) between the two interacting objects. More...

const Vec3DgetNormal () const
Gets the normal vector between the two interacting objects. More...

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

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

BaseInteractablegetI ()

const BaseInteractablegetP () const

const BaseInteractablegetI () 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...

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

const Vec3DgetRelativeVelocity () 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 BaseInteractioncopy () 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...

Protected Member Functions inherited from BaseInteraction
Returns a Mdouble to the effective radius of the interaction. (Not corrected for the overlap) More...

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

add an force increment to the total force. More...

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

In case one wants to have a frictionless interaction between the interactables (particles or walls), the following class can be used. See Interaction.h, where one can set the FrictionalForceInteraction to EmptyFrictionInteraction.

All the member functions are just dummy methods which basically do nothing but define a interface.

Definition at line 41 of file EmptyFrictionInteraction.h.

## Member Typedef Documentation

An alias name for EmptyFrictionSpecies.

Definition at line 47 of file EmptyFrictionInteraction.h.

## Constructor & Destructor Documentation

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

Constructor.

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

Definition at line 38 of file EmptyFrictionInteraction.cc.

39  : BaseInteraction(P, I, timeStamp)
40 {
41 #ifdef DEBUG_CONSTRUCTOR
42  std::cout<<"EmptyFrictionInteraction::EmptyFrictionInteraction() finished"<<std::endl;
43 #endif
44 }
BaseInteraction(BaseInteractable *P, BaseInteractable *I, Mdouble timeStamp)
A constructor takes the BaseInteractable objects which are interacting (come into contact) and time t...
 EmptyFrictionInteraction::EmptyFrictionInteraction ( const EmptyFrictionInteraction & p )

Copy constructor.

Parameters
 [in] p

Definition at line 48 of file EmptyFrictionInteraction.cc.

49  : BaseInteraction(p)
50 {
51 #ifdef DEBUG_CONSTRUCTOR
52  std::cout<<"EmptyFrictionInteraction::EmptyFrictionInteraction(const EmptyFrictionInteraction &p finished"<<std::endl;
53 #endif
54 }
BaseInteraction(BaseInteractable *P, BaseInteractable *I, Mdouble timeStamp)
A constructor takes the BaseInteractable objects which are interacting (come into contact) and time t...
 EmptyFrictionInteraction::~EmptyFrictionInteraction ( )
virtual

Destructor.

Definition at line 58 of file EmptyFrictionInteraction.cc.

59 {
60 #ifdef DEBUG_DESTRUCTOR
61  std::cout<<"EmptyFrictionInteraction::~EmptyFrictionInteraction() finished"<<std::endl;
62 #endif
63 }

## Member Function Documentation

 void EmptyFrictionInteraction::computeFrictionForce ( )

Computes nothing, it is an empty function.

Definition at line 77 of file EmptyFrictionInteraction.cc.

78 {}
 std::string EmptyFrictionInteraction::getBaseName ( ) const

Returns interaction name/type.

Returns
std::string

Definition at line 115 of file EmptyFrictionInteraction.cc.

116 {
117  return "";
118 }
 Mdouble EmptyFrictionInteraction::getElasticEnergy ( ) const
virtual

Returns zero as it is an frictionless interaction.

Returns
Mdouble

Reimplemented from BaseInteraction.

Definition at line 87 of file EmptyFrictionInteraction.cc.

88 {
89  return 0.0;
90 }
 const EmptyFrictionSpecies * EmptyFrictionInteraction::getSpecies ( ) const

Returns a const pointer of type EmptyFrictionSpecies*.

Returns
const EmptyFrictionSpecies*

Definition at line 108 of file EmptyFrictionInteraction.cc.

References BaseInteraction::getBaseSpecies().

109 {
110  return dynamic_cast<const EmptyFrictionSpecies *>(getBaseSpecies());
111 }
EmptyFrictionSpecies is used to create a force law without frictional forces.
const BaseSpecies * getBaseSpecies() const
Return a constant point to BaseSpecies of the interaction.
 const Vec3D EmptyFrictionInteraction::getTangentialForce ( ) const
virtual

Returns zero tangential force.

Returns
const Vec3D

Reimplemented from BaseInteraction.

Definition at line 101 of file EmptyFrictionInteraction.cc.

102 {
103  return Vec3D(0.0,0.0,0.0);
104 }
Implementation of a 3D vector (by Vitaliy).
Definition: Vector.h:45
 Mdouble EmptyFrictionInteraction::getTangentialOverlap ( ) const
virtual

Returns zero overlap.

Returns
Mdouble

Reimplemented from BaseInteraction.

Definition at line 94 of file EmptyFrictionInteraction.cc.

95 {
96  return 0.0;
97 }
 void EmptyFrictionInteraction::integrate ( Mdouble timeStep UNUSED )
virtual

Does nothing as there is no force.

Parameters
 [in] timeStep

Reimplemented from BaseInteraction.

Definition at line 82 of file EmptyFrictionInteraction.cc.

83 {}
 void EmptyFrictionInteraction::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 72 of file EmptyFrictionInteraction.cc.

73 {}
 void EmptyFrictionInteraction::write ( std::ostream & os ) const
virtual

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

Parameters
 [in,out] os

Reimplemented from BaseInteraction.

Definition at line 67 of file EmptyFrictionInteraction.cc.

68 {}

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