ESyS-Particle  2.3.4
CHertzianViscoElasticFrictionInteraction Class Reference

Frictional+ViscoElastic interaction between particles. More...

#include <HertzianViscoElasticFrictionInteraction.h>

Inheritance diagram for CHertzianViscoElasticFrictionInteraction:
Collaboration diagram for CHertzianViscoElasticFrictionInteraction:

Public Types

typedef CHertzianViscoElasticFrictionIGP ParameterType
 
typedef double(CHertzianViscoElasticFrictionInteraction::* ScalarFieldFunction) () const
 
typedef std::pair< bool, double >(CHertzianViscoElasticFrictionInteraction::* CheckedScalarFieldFunction) () const
 
typedef Vec3(CHertzianViscoElasticFrictionInteraction::* VectorFieldFunction) () const
 

Public Member Functions

 CHertzianViscoElasticFrictionInteraction ()
 
 CHertzianViscoElasticFrictionInteraction (CParticle *, CParticle *)
 
 CHertzianViscoElasticFrictionInteraction (CParticle *, CParticle *, const CHertzianViscoElasticFrictionIGP &)
 
virtual ~CHertzianViscoElasticFrictionInteraction ()
 
virtual void calcForces ()
 
virtual bool isPersistent ()
 
void setTimeStepSize (double dt)
 
std::pair< bool, double > getAbsFrictionalForce () const
 
std::pair< bool, double > getAbsFN () const
 
std::pair< bool, double > getAbsMuFN () const
 
std::pair< bool, double > getSlipVelocity () const
 
std::pair< bool, double > getNormalStress () const
 
std::pair< bool, double > getMaxFricStress () const
 
std::pair< bool, double > getAbsFrictionalStress () const
 
double getAbsForceDeficit () const
 
double getPotentialEnergy () const
 
double getSlipping () const
 
double getSticking () const
 
double getDissipatedEnergy () const
 
double Count () const
 
Vec3 getForce () const
 
Vec3 getNormalForce () const
 
virtual Vec3 getPos () const
 
std::pair< bool, double > getMuEff (const Vec3 &, const Vec3 &) const
 
std::pair< bool, double > getMuEffXY () const
 
std::pair< bool, double > getMuEffXZ () const
 
- Public Member Functions inherited from APairInteraction
 APairInteraction ()
 
 APairInteraction (CParticle *, CParticle *)
 
virtual ~APairInteraction ()
 
const CParticlefirst () const
 
const CParticlesecond () const
 
CParticlefirst ()
 
CParticlesecond ()
 
pair< int, int > getPairID () const
 
void setPP (CParticle *, CParticle *)
 
void checkIDs ()
 
virtual bool hasTag (int, int) const
 
virtual Vec3 getPosFirst () const
 
virtual Vec3 getPosSecond () const
 
esys::lsm::quintuple< Vec3, double, Vec3, double, Vec3getRaw2Data () const
 
template<class TmplParticle >
void setPP (const vector< TmplParticle * > &pp)
 
virtual void saveRestartData (std::ostream &)
 
virtual void loadRestartData (std::istream &)
 
- Public Member Functions inherited from AInteraction
 AInteraction ()
 
virtual ~AInteraction ()
 
bool initialized () const
 
virtual void calcHeatTrans ()
 
virtual void calcHeatFrict ()
 
vector< int > getAllID () const
 
int getID ()
 
double Count () const
 

Static Public Member Functions

static ScalarFieldFunction getScalarFieldFunction (const string &)
 
static CheckedScalarFieldFunction getCheckedScalarFieldFunction (const string &)
 
static VectorFieldFunction getVectorFieldFunction (const string &)
 
static string getType ()
 

Protected Attributes

double m_A
 Dissipative constant. More...
 
double m_E
 Young's modulus. More...
 
double m_nu
 Poisson ratio. More...
 
double m_r0
 equilibrium distance More...
 
double m_mu
 coefficient of friction More...
 
double m_ks
 shear stiffness (Cundall) More...
 
double m_dt
 time step More...
 
Vec3 m_Ffric
 current frictional force More...
 
Vec3 m_force_deficit
 difference between fric. force & force necessary for slip More...
 
Vec3 m_cpos
 contact position More...
 
Vec3 m_normal_force
 current normal force More...
 
double m_dn
 caching displacement for E_pot More...
 
bool m_is_slipping
 static/dynamic status of the interaction More...
 
bool m_is_touching
 contact status of the interaction More...
 
double m_E_diss
 dissipated energy More...
 
- Protected Attributes inherited from APairInteraction
CParticlem_p1
 
CParticlem_p2
 
- Protected Attributes inherited from AInteraction
vector< int > m_id
 id's of the particles involved More...
 
int m_iid
 interaction id More...
 
bool m_init
 

Friends

class TML_PackedMessageInterface
 
std::ostream & operator<< (std::ostream &, const CHertzianViscoElasticFrictionInteraction &)
 

Detailed Description

Frictional+ViscoElastic interaction between particles.

Author
Laura Heredia & Pablo Richeri
Date
2009-12-26 20:00:00 (sat, 26 dec 2009)

Member Typedef Documentation

◆ CheckedScalarFieldFunction

typedef std::pair<bool,double>(CHertzianViscoElasticFrictionInteraction::* CHertzianViscoElasticFrictionInteraction::CheckedScalarFieldFunction) () const

◆ ParameterType

◆ ScalarFieldFunction

typedef double(CHertzianViscoElasticFrictionInteraction::* CHertzianViscoElasticFrictionInteraction::ScalarFieldFunction) () const

◆ VectorFieldFunction

typedef Vec3(CHertzianViscoElasticFrictionInteraction::* CHertzianViscoElasticFrictionInteraction::VectorFieldFunction) () const

Constructor & Destructor Documentation

◆ CHertzianViscoElasticFrictionInteraction() [1/3]

CHertzianViscoElasticFrictionInteraction::CHertzianViscoElasticFrictionInteraction ( )

◆ CHertzianViscoElasticFrictionInteraction() [2/3]

CHertzianViscoElasticFrictionInteraction::CHertzianViscoElasticFrictionInteraction ( CParticle p1,
CParticle p2 
)

constructor for CHertzianViscoElasticFrictionInteraction without friction and viscoelastic parameters, only calls the constructor of APairInteraction with the 2 particle pointers

◆ CHertzianViscoElasticFrictionInteraction() [3/3]

◆ ~CHertzianViscoElasticFrictionInteraction()

CHertzianViscoElasticFrictionInteraction::~CHertzianViscoElasticFrictionInteraction ( )
virtual

Member Function Documentation

◆ calcForces()

void CHertzianViscoElasticFrictionInteraction::calcForces ( )
virtual

◆ Count()

double CHertzianViscoElasticFrictionInteraction::Count ( ) const

return 1 if particles are in contact, 0 otherwise

References m_is_touching.

Referenced by getScalarFieldFunction().

Here is the caller graph for this function:

◆ getAbsFN()

pair< bool, double > CHertzianViscoElasticFrictionInteraction::getAbsFN ( ) const

get current normal force

References m_is_touching, m_normal_force, and Vec3::norm().

Referenced by getCheckedScalarFieldFunction().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getAbsForceDeficit()

double CHertzianViscoElasticFrictionInteraction::getAbsForceDeficit ( ) const

get the force needed to overcome friction and make the interaction slip

References m_force_deficit, and Vec3::norm().

Here is the call graph for this function:

◆ getAbsFrictionalForce()

pair< bool, double > CHertzianViscoElasticFrictionInteraction::getAbsFrictionalForce ( ) const

get current frictional/stopping force

References CBasicParticle::getPos(), CBasicParticle::getRad(), m_Ffric, APairInteraction::m_p1, APairInteraction::m_p2, and Vec3::norm().

Referenced by getCheckedScalarFieldFunction().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getAbsFrictionalStress()

pair< bool, double > CHertzianViscoElasticFrictionInteraction::getAbsFrictionalStress ( ) const

get current frictional/stopping stress (f_fric/r^2)

References CBasicParticle::getPos(), CBasicParticle::getRad(), m_Ffric, APairInteraction::m_p1, APairInteraction::m_p2, and Vec3::norm().

Referenced by getCheckedScalarFieldFunction().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getAbsMuFN()

pair< bool, double > CHertzianViscoElasticFrictionInteraction::getAbsMuFN ( ) const

get max. frictional force, i.e. coeff. of friction * normal force

References CBasicParticle::getPos(), CBasicParticle::getRad(), CParticle::getVel(), m_A, m_E, m_nu, APairInteraction::m_p1, APairInteraction::m_p2, Vec3::norm(), Vec3::unit(), Vec3::X(), Vec3::Y(), and Vec3::Z().

Referenced by getCheckedScalarFieldFunction().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getCheckedScalarFieldFunction()

CHertzianViscoElasticFrictionInteraction::CheckedScalarFieldFunction CHertzianViscoElasticFrictionInteraction::getCheckedScalarFieldFunction ( const string &  name)
static

Get the particle member function which returns a checked scalar field of a given name.

Parameters
namethe name of the field

References getAbsFN(), getAbsFrictionalForce(), getAbsFrictionalStress(), getAbsMuFN(), getMaxFricStress(), getMuEffXY(), getMuEffXZ(), getNormalStress(), getSlipVelocity(), and NULL.

Here is the call graph for this function:

◆ getDissipatedEnergy()

double CHertzianViscoElasticFrictionInteraction::getDissipatedEnergy ( ) const

return the amount of energy dissipated during the last time step

References m_E_diss.

Referenced by getScalarFieldFunction().

Here is the caller graph for this function:

◆ getForce()

Vec3 CHertzianViscoElasticFrictionInteraction::getForce ( ) const

get net force on particle1 imposed by this interaction. Returns Vec3::ZERO if particles are not in contact.

References m_Ffric, m_is_touching, and m_normal_force.

Referenced by getVectorFieldFunction().

Here is the caller graph for this function:

◆ getMaxFricStress()

pair< bool, double > CHertzianViscoElasticFrictionInteraction::getMaxFricStress ( ) const

get max. frictional stress, i.e. coeff. of friction * normal stress

References CBasicParticle::getPos(), CBasicParticle::getRad(), CParticle::getVel(), m_A, m_E, m_nu, APairInteraction::m_p1, APairInteraction::m_p2, Vec3::norm(), Vec3::unit(), Vec3::X(), Vec3::Y(), and Vec3::Z().

Referenced by getCheckedScalarFieldFunction().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getMuEff()

pair< bool, double > CHertzianViscoElasticFrictionInteraction::getMuEff ( const Vec3 dir,
const Vec3 norm 
) const

Calculate effective coefficient of friction for this interaction for a given direction of the applied shear force. If the effective coefficient of friction is infinite, -1 is returned.

Parameters
dirthe direction of the applied shear force
Returns
the effective coefficient of friction if it is finite, -1 otherwise and -2 for no contact

References CBasicParticle::getPos(), CBasicParticle::getRad(), CParticle::getVel(), m_mu, APairInteraction::m_p1, APairInteraction::m_p2, Vec3::norm(), and Vec3::unit().

Referenced by getMuEffXY(), and getMuEffXZ().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getMuEffXY()

std::pair<bool,double> CHertzianViscoElasticFrictionInteraction::getMuEffXY ( ) const
inline

References getMuEff().

Referenced by getCheckedScalarFieldFunction().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getMuEffXZ()

std::pair<bool,double> CHertzianViscoElasticFrictionInteraction::getMuEffXZ ( ) const
inline

References getMuEff().

Referenced by getCheckedScalarFieldFunction().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getNormalForce()

Vec3 CHertzianViscoElasticFrictionInteraction::getNormalForce ( ) const

If the particles are in contact, get normal force, if not in contact return (0,0,0)

References m_is_touching, and m_normal_force.

Referenced by getVectorFieldFunction().

Here is the caller graph for this function:

◆ getNormalStress()

pair< bool, double > CHertzianViscoElasticFrictionInteraction::getNormalStress ( ) const

get current normal stress

References CBasicParticle::getRad(), m_is_touching, m_normal_force, APairInteraction::m_p1, APairInteraction::m_p2, and Vec3::norm().

Referenced by getCheckedScalarFieldFunction().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getPos()

virtual Vec3 CHertzianViscoElasticFrictionInteraction::getPos ( ) const
inlinevirtual

Implements APairInteraction.

References m_cpos.

◆ getPotentialEnergy()

double CHertzianViscoElasticFrictionInteraction::getPotentialEnergy ( ) const

get the potential energy stored in the interaction

References m_E, and m_normal_force.

Referenced by getScalarFieldFunction().

Here is the caller graph for this function:

◆ getScalarFieldFunction()

CHertzianViscoElasticFrictionInteraction::ScalarFieldFunction CHertzianViscoElasticFrictionInteraction::getScalarFieldFunction ( const string &  name)
static

Get the particle member function which returns a scalar field of a given name.

Parameters
namethe name of the field

References Count(), getDissipatedEnergy(), getPotentialEnergy(), getSlipping(), getSticking(), and NULL.

Here is the call graph for this function:

◆ getSlipping()

double CHertzianViscoElasticFrictionInteraction::getSlipping ( ) const

Get the static/dynamic status of the interaction. Returns 1 for a contact in dynamic friction, 0 for static or no contact

References m_is_slipping.

Referenced by getScalarFieldFunction().

Here is the caller graph for this function:

◆ getSlipVelocity()

pair< bool, double > CHertzianViscoElasticFrictionInteraction::getSlipVelocity ( ) const

get "force deficit", i.e. the force needed to make the contact dynamic

get the slipping velocity, i.e. the absolute value of the tangential part of the relatve particle velocity

References CBasicParticle::getPos(), CBasicParticle::getRad(), CParticle::getVel(), APairInteraction::m_p1, APairInteraction::m_p2, Vec3::norm(), and Vec3::unit().

Referenced by getCheckedScalarFieldFunction().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getSticking()

double CHertzianViscoElasticFrictionInteraction::getSticking ( ) const

Get "sticking" contacts, i.e. return 1 if the contact is touching but not slipping, 0 otherwise

References m_is_slipping, and m_is_touching.

Referenced by getScalarFieldFunction().

Here is the caller graph for this function:

◆ getType()

static string CHertzianViscoElasticFrictionInteraction::getType ( )
inlinestatic

◆ getVectorFieldFunction()

CHertzianViscoElasticFrictionInteraction::VectorFieldFunction CHertzianViscoElasticFrictionInteraction::getVectorFieldFunction ( const string &  name)
static

Get the particle member function which returns a vector field of a given name.

Parameters
namethe name of the field

References getForce(), getNormalForce(), and NULL.

Here is the call graph for this function:

◆ isPersistent()

bool CHertzianViscoElasticFrictionInteraction::isPersistent ( )
virtual

References CBasicParticle::getPos(), CBasicParticle::getRad(), APairInteraction::m_p1, and APairInteraction::m_p2.

Here is the call graph for this function:

◆ setTimeStepSize()

void CHertzianViscoElasticFrictionInteraction::setTimeStepSize ( double  dt)

References m_dt.

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<< ( std::ostream &  ,
const CHertzianViscoElasticFrictionInteraction  
)
friend

◆ TML_PackedMessageInterface

friend class TML_PackedMessageInterface
friend

Member Data Documentation

◆ m_A

double CHertzianViscoElasticFrictionInteraction::m_A
protected

◆ m_cpos

Vec3 CHertzianViscoElasticFrictionInteraction::m_cpos
protected

contact position

Referenced by calcForces(), and getPos().

◆ m_dn

double CHertzianViscoElasticFrictionInteraction::m_dn
protected

caching displacement for E_pot

Referenced by calcForces(), TML_PackedMessageInterface::pack(), and TML_PackedMessageInterface::unpack().

◆ m_dt

double CHertzianViscoElasticFrictionInteraction::m_dt
protected

◆ m_E

double CHertzianViscoElasticFrictionInteraction::m_E
protected

◆ m_E_diss

double CHertzianViscoElasticFrictionInteraction::m_E_diss
protected

dissipated energy

Referenced by calcForces(), and getDissipatedEnergy().

◆ m_Ffric

Vec3 CHertzianViscoElasticFrictionInteraction::m_Ffric
protected

◆ m_force_deficit

Vec3 CHertzianViscoElasticFrictionInteraction::m_force_deficit
protected

difference between fric. force & force necessary for slip

Referenced by calcForces(), and getAbsForceDeficit().

◆ m_is_slipping

bool CHertzianViscoElasticFrictionInteraction::m_is_slipping
protected

static/dynamic status of the interaction

Referenced by calcForces(), getSlipping(), and getSticking().

◆ m_is_touching

bool CHertzianViscoElasticFrictionInteraction::m_is_touching
protected

contact status of the interaction

Referenced by calcForces(), Count(), getAbsFN(), getForce(), getNormalForce(), getNormalStress(), and getSticking().

◆ m_ks

double CHertzianViscoElasticFrictionInteraction::m_ks
protected

◆ m_mu

double CHertzianViscoElasticFrictionInteraction::m_mu
protected

◆ m_normal_force

Vec3 CHertzianViscoElasticFrictionInteraction::m_normal_force
protected

◆ m_nu

double CHertzianViscoElasticFrictionInteraction::m_nu
protected

◆ m_r0

double CHertzianViscoElasticFrictionInteraction::m_r0
protected

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