HertzianSinterNormalSpecies contains the parameters used to describe a plastic-cohesive normal force (Stefan Ludings plastic-cohesive force model). More...

#include <HertzianSinterNormalSpecies.h>

Inheritance diagram for HertzianSinterNormalSpecies:

Public Types
typedef HertzianSinterInteraction	InteractionType
	The correct Interaction type for this FrictionForceSpecies. More...

Public Member Functions
	HertzianSinterNormalSpecies ()
	The default constructor. More...

	HertzianSinterNormalSpecies (const HertzianSinterNormalSpecies &p)
	The default copy constructor. More...

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

void	read (std::istream &is)
	Reads the species properties from an input stream. More...

void	write (std::ostream &os) const
	Writes the species properties to an output stream. More...

std::string	getBaseName () const
	Used in Species::getName to obtain a unique name for each Species. More...

void	mix (HertzianSinterNormalSpecies const S, HertzianSinterNormalSpecies const T)
	creates default values for mixed species More...

void	setPlasticParameters (Mdouble loadingModulus, Mdouble unloadingModulusMax, Mdouble cohesionModulus, Mdouble penetrationDepthMax)
	Sets all parameters of the linear plastic-viscoelastic normal force at once. More...

Mdouble	getLoadingModulus () const
	Returns the loading stiffness of the linear plastic-viscoelastic normal force. More...

Mdouble	getUnloadingModulusMax () const
	Returns the maximum unloading stiffness of the linear plastic-viscoelastic normal force. More...

Mdouble	getCohesionModulus () const
	Returns the cohesive stiffness of the linear plastic-viscoelastic normal force. More...

Mdouble	getPenetrationDepthMax () const
	Returns the maximum penetration depth of the linear plastic-viscoelastic normal force. More...

void	setLoadingModulus (Mdouble loadingModulus)
	Sets the loading stiffness of the linear plastic-viscoelastic normal force. More...

void	setUnloadingModulusMax (Mdouble unloadingModulusMax)
	Sets the maximum unloading stiffness of the linear plastic-viscoelastic normal force. More...

void	setCohesionModulus (Mdouble cohesionModulus)
	Sets the cohesive stiffness of the linear plastic-viscoelastic normal force. More...

void	setPenetrationDepthMax (Mdouble penetrationDepthMax)
	Sets the maximum penetration depth of the linear plastic-viscoelastic normal force. More...

void	setDissipation (Mdouble dissipation)
	Sets the linear dissipation coefficient of the linear plastic-viscoelastic normal force. More...

Mdouble	getDissipation () const
	Allows the normal dissipation to be accessed. More...

void	setSinterRate (Mdouble sinterRate)
	Sets the linear dissipation coefficient of the linear plastic-viscoelastic normal force. More...

Mdouble	getSinterRate () const
	Allows the normal dissipation to be accessed. More...

Mdouble	computeTimeStep (Mdouble mass)
	Returns the optimal time step to resolve a collision of two particles of a given mass. More...

Public Member Functions inherited from BaseSpecies
	BaseSpecies ()
	The default constructor. More...

	BaseSpecies (const BaseSpecies &p)
	The copy constructor. More...

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

virtual BaseSpecies *	copy () const =0
	Creates a deep copy of the object from which it is called. More...

void	setHandler (SpeciesHandler *handler)
	Sets the pointer to the handler to which this species belongs. More...

SpeciesHandler *	getHandler () const
	Returns the pointer to the handler to which this species belongs. More...

Mdouble	average (Mdouble a, Mdouble b)
	defines the average of two variables by the harmonic mean. More...

virtual void	mixAll (BaseSpecies const S, BaseSpecies const T)=0
	creates default values for mixed species More...

virtual Mdouble	getInteractionDistance () const =0
	returns the largest separation distance at which adhesive short-range forces can occur. More...

virtual bool	getUseAngularDOFs () const =0
	Returns true if torques (i.e. angular degrees of freedom) have to be calculated. More...

virtual BaseInteraction *	getNewInteraction (BaseInteractable P, BaseInteractable I, Mdouble timeStamp) const =0
	returns new Interaction object. 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 std::string	getName () const =0
	A purely virtual function. 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
Mdouble	loadingModulus_
	(normal) spring constant (k_1) More...

Mdouble	unloadingModulusMax_
	the maximum elastic constant (k_2^max) for plastic deformations More...

Mdouble	cohesionModulus_
	the adhesive spring constant (k^c) for plastic deformations More...

Mdouble	penetrationDepthMax_
	the depth (relative to the normalized radius) at which k_2^max is used (phi_f) More...

Mdouble	dissipation_
	linear dissipation coefficient More...

Mdouble	sinterRate_

Detailed Description

HertzianSinterNormalSpecies contains the parameters used to describe a plastic-cohesive normal force (Stefan Ludings plastic-cohesive force model).

See SinterNormalInteraction::computeForce for a description of the force law.

Definition at line 36 of file HertzianSinterNormalSpecies.h.

Member Typedef Documentation

typedef HertzianSinterInteraction HertzianSinterNormalSpecies::InteractionType

The correct Interaction type for this FrictionForceSpecies.

Definition at line 40 of file HertzianSinterNormalSpecies.h.

Constructor & Destructor Documentation

HertzianSinterNormalSpecies::HertzianSinterNormalSpecies ( )

The default constructor.

Definition at line 35 of file HertzianSinterNormalSpecies.cc.

References cohesionModulus_, dissipation_, loadingModulus_, penetrationDepthMax_, sinterRate_, and unloadingModulusMax_.

 {
     loadingModulus_ = 0.0;
     unloadingModulusMax_ = 0.0;
     cohesionModulus_ = 0.0;
     penetrationDepthMax_ = 0.0;
     dissipation_ = 0.0;
     sinterRate_ = 0.0;
 #ifdef DEBUG_CONSTRUCTOR
     std::cout<<"HertzianSinterNormalSpecies::HertzianSinterNormalSpecies() finished"<<std::endl;
 #endif
 }

HertzianSinterNormalSpecies::HertzianSinterNormalSpecies ( const HertzianSinterNormalSpecies & p )

The default copy constructor.

Parameters

[in] the species that is copied

Definition at line 51 of file HertzianSinterNormalSpecies.cc.

References cohesionModulus_, dissipation_, loadingModulus_, penetrationDepthMax_, sinterRate_, and unloadingModulusMax_.

 {
     loadingModulus_ = p.loadingModulus_;
     unloadingModulusMax_ = p.unloadingModulusMax_;
     cohesionModulus_ = p.cohesionModulus_;
     penetrationDepthMax_ = p.penetrationDepthMax_;
     dissipation_ = p.dissipation_;
     sinterRate_ = p.sinterRate_;
 #ifdef DEBUG_CONSTRUCTOR
     std::cout<<"HertzianSinterNormalSpecies::HertzianSinterNormalSpecies(const HertzianSinterNormalSpecies &p) finished"<<std::endl;
 #endif
 }

HertzianSinterNormalSpecies::~HertzianSinterNormalSpecies ( )

virtual

The default destructor.

Definition at line 64 of file HertzianSinterNormalSpecies.cc.

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

Member Function Documentation

Mdouble HertzianSinterNormalSpecies::computeTimeStep ( Mdouble mass )

Returns the optimal time step to resolve a collision of two particles of a given mass.

Calculates collision time for stiffest spring constant, divides by 50

Parameters

[in] the optimal time step is computed to resolve a collision of two particles of this mass.

Definition at line 208 of file HertzianSinterNormalSpecies.cc.

References assert, ParticleSpecies::getDensity(), getPenetrationDepthMax(), getUnloadingModulusMax(), and constants::pi.

 {
 //    if (stiffnessMax / (.5 * mass) < mathsFunc::square(dissipation_ /mass)) {
 //        std::cerr << "Dissipation too high; max. allowed " << sqrt(2.0 * stiffnessMax * mass) << std::endl;
 //        return 0.02 * constants::pi / std::sqrt(2.0*stiffnessMax / mass);
 //    } else {
     std::cerr << "Warning: Dissipation is not taken into account when computing the time step"  << std::endl;
     ParticleSpecies* p=dynamic_cast<ParticleSpecies*>(this);
     assert(p);
     Mdouble radius = cbrt(mass*3./(4.*constants::pi*p->getDensity()));
     return 0.02 * constants::pi / std::sqrt(2.0*getUnloadingModulusMax()*getPenetrationDepthMax()*radius / mass);
 }

std::string HertzianSinterNormalSpecies::getBaseName ( ) const

Used in Species::getName to obtain a unique name for each Species.

Returns: a string containing the name of the species (minus the word "Species")

Definition at line 101 of file HertzianSinterNormalSpecies.cc.

 {
     return "HertzianSinter";
 }

Mdouble HertzianSinterNormalSpecies::getCohesionModulus ( ) const

Returns the cohesive stiffness of the linear plastic-viscoelastic normal force.

Returns: the cohesive stiffness of the linear plastic-viscoelastic normal force.

Definition at line 159 of file HertzianSinterNormalSpecies.cc.

References cohesionModulus_.

Referenced by HertzianSinterInteraction::computeSinterForce(), and mix().

 {
     return cohesionModulus_;
 }

Mdouble HertzianSinterNormalSpecies::getDissipation ( ) const

Allows the normal dissipation to be accessed.

Returns: the linear dissipation coefficient

Definition at line 258 of file HertzianSinterNormalSpecies.cc.

References dissipation_.

Referenced by HertzianSinterInteraction::computeSinterForce(), and mix().

 {
     return dissipation_;
 }

Mdouble HertzianSinterNormalSpecies::getLoadingModulus ( ) const

Returns the loading stiffness of the linear plastic-viscoelastic normal force.

Returns: the loading stiffness of the linear plastic-viscoelastic normal force.

Definition at line 143 of file HertzianSinterNormalSpecies.cc.

References loadingModulus_.

Referenced by HertzianSinterInteraction::computeSinterForce(), HertzianSinterInteraction::getElasticEnergy(), HertzianSinterInteraction::getUnloadingModulus(), and mix().

 {
     return loadingModulus_;
 }

Mdouble HertzianSinterNormalSpecies::getPenetrationDepthMax ( ) const

Returns the maximum penetration depth of the linear plastic-viscoelastic normal force.

Returns: the maximum penetration depth of the linear plastic-viscoelastic normal force.

Definition at line 167 of file HertzianSinterNormalSpecies.cc.

References penetrationDepthMax_.

Referenced by HertzianSinterInteraction::computeSinterForce(), computeTimeStep(), HertzianSinterInteraction::getUnloadingModulus(), and mix().

 {
     return penetrationDepthMax_;
 }

Mdouble HertzianSinterNormalSpecies::getSinterRate ( ) const

Allows the normal dissipation to be accessed.

Returns: the linear dissipation coefficient

Definition at line 266 of file HertzianSinterNormalSpecies.cc.

References sinterRate_.

Referenced by HertzianSinterInteraction::computeSinterForce(), and mix().

 {
     return sinterRate_;
 }

Mdouble HertzianSinterNormalSpecies::getUnloadingModulusMax ( ) const

Returns the maximum unloading stiffness of the linear plastic-viscoelastic normal force.

Returns: the maximum unloading stiffness of the linear plastic-viscoelastic normal force.

Definition at line 151 of file HertzianSinterNormalSpecies.cc.

References unloadingModulusMax_.

Referenced by HertzianSinterInteraction::computeSinterForce(), computeTimeStep(), HertzianSinterInteraction::getUnloadingModulus(), and mix().

 {
     return unloadingModulusMax_;
 }

void HertzianSinterNormalSpecies::mix	(	HertzianSinterNormalSpecies *const	S,
		HertzianSinterNormalSpecies *const	T
	)

creates default values for mixed species

For all parameters we assume that the harmonic mean of the parameters of the original two species is a sensible default.

Parameters

[in] S,T the two species whose properties are mixed to create the new species

Definition at line 111 of file HertzianSinterNormalSpecies.cc.

References BaseSpecies::average(), cohesionModulus_, dissipation_, getCohesionModulus(), getDissipation(), getLoadingModulus(), getPenetrationDepthMax(), getSinterRate(), getUnloadingModulusMax(), loadingModulus_, penetrationDepthMax_, sinterRate_, and unloadingModulusMax_.

 {
     loadingModulus_ = average(S->getLoadingModulus(), T->getLoadingModulus());
     unloadingModulusMax_ = average(S->getUnloadingModulusMax(), T->getUnloadingModulusMax());
     cohesionModulus_ = average(S->getCohesionModulus(), T->getCohesionModulus());
     penetrationDepthMax_ = average(S->getPenetrationDepthMax(), T->getPenetrationDepthMax());
     dissipation_ = average(S->getDissipation(), T->getDissipation());
     sinterRate_ = average(S->getSinterRate(), T->getSinterRate());
 }

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

virtual

Reads the species properties from an input stream.

Parameters

[in] input stream (typically the restart file)

Implements BaseObject.

Definition at line 87 of file HertzianSinterNormalSpecies.cc.

References cohesionModulus_, dissipation_, loadingModulus_, penetrationDepthMax_, sinterRate_, and unloadingModulusMax_.

 {
     std::string dummy;
     is >> dummy >> loadingModulus_;
     is >> dummy >> unloadingModulusMax_;
     is >> dummy >> cohesionModulus_;
     is >> dummy >> penetrationDepthMax_;
     is >> dummy >> dissipation_;
     is >> dummy >> sinterRate_;
 }

void HertzianSinterNormalSpecies::setCohesionModulus ( Mdouble cohesionModulus )

Sets the cohesive stiffness of the linear plastic-viscoelastic normal force.

Parameters

[in] cohesionModulus the cohesive stiffness of the linear plastic-viscoelastic normal force.

Definition at line 191 of file HertzianSinterNormalSpecies.cc.

References cohesionModulus_.

Referenced by setPlasticParameters().

 {
     cohesionModulus_ = cohesionModulus;
 }

void HertzianSinterNormalSpecies::setDissipation ( Mdouble dissipation )

Sets the linear dissipation coefficient of the linear plastic-viscoelastic normal force.

should be non-negative

Parameters

[in] the linear dissipation coefficient of the linear plastic-viscoelastic normal force.

Definition at line 225 of file HertzianSinterNormalSpecies.cc.

References dissipation_.

 {
     if (dissipation >= 0)
     {
         dissipation_ = dissipation;
     }
     else
     {
         std::cerr << "Error in setDissipation(" << dissipation << ")" << std::endl;
         exit(-1);
     }
 }

void HertzianSinterNormalSpecies::setLoadingModulus ( Mdouble loadingModulus )

Sets the loading stiffness of the linear plastic-viscoelastic normal force.

Parameters

[in] loadingModulus the loading stiffness of the linear plastic-viscoelastic normal force.

Definition at line 175 of file HertzianSinterNormalSpecies.cc.

References loadingModulus_.

Referenced by setPlasticParameters().

 {
     loadingModulus_ = loadingModulus;
 }

void HertzianSinterNormalSpecies::setPenetrationDepthMax ( Mdouble penetrationDepthMax )

Sets the maximum penetration depth of the linear plastic-viscoelastic normal force.

Parameters

[in] penetrationDepthMax the maximum penetration depth of the linear plastic-viscoelastic normal force.

Definition at line 199 of file HertzianSinterNormalSpecies.cc.

References penetrationDepthMax_.

Referenced by setPlasticParameters().

 {
     penetrationDepthMax_ = penetrationDepthMax;
 }

void HertzianSinterNormalSpecies::setPlasticParameters	(	Mdouble	loadingModulus,
		Mdouble	unloadingModulusMax,
		Mdouble	cohesionModulus,
		Mdouble	penetrationDepthMax
	)

Sets all parameters of the linear plastic-viscoelastic normal force at once.

Parameters

[in]	loadingModulus	the loading stiffness of the linear plastic-viscoelastic normal force.
[in]	unloadingModulusMax	the maximum unloading stiffness of the linear plastic-viscoelastic normal force.
[in]	cohesionModulus	the cohesive stiffness of the linear plastic-viscoelastic normal force.
[in]	penetrationDepthMax	the maximum penetration depth of the linear plastic-viscoelastic normal force.

Definition at line 127 of file HertzianSinterNormalSpecies.cc.

References setCohesionModulus(), setLoadingModulus(), setPenetrationDepthMax(), and setUnloadingModulusMax().

 {
     if (loadingModulus <= 0 || unloadingModulusMax <= 1.000001*(loadingModulus+cohesionModulus) || cohesionModulus < 0 || penetrationDepthMax < 0)
     {
         std::cerr << "Error: arguments of setPlasticParameters do not make sense" << std::endl;
         exit(-1);
     }
     setLoadingModulus(loadingModulus);
     setUnloadingModulusMax(unloadingModulusMax);
     setCohesionModulus(cohesionModulus);
     setPenetrationDepthMax(penetrationDepthMax);
 }

void HertzianSinterNormalSpecies::setSinterRate ( Mdouble sinterRate )

Sets the linear dissipation coefficient of the linear plastic-viscoelastic normal force.

should be non-negative

Parameters

[in] the linear dissipation coefficient of the linear plastic-viscoelastic normal force.

Definition at line 242 of file HertzianSinterNormalSpecies.cc.

References sinterRate_.

 {
     if (sinterRate >= 0)
     {
         sinterRate_ = sinterRate;
     }
     else
     {
         std::cerr << "Error in setSinterRate(" << sinterRate << ")" << std::endl;
         exit(-1);
     }
 }

void HertzianSinterNormalSpecies::setUnloadingModulusMax ( Mdouble unloadingModulusMax )

Sets the maximum unloading stiffness of the linear plastic-viscoelastic normal force.

Parameters

[in] unloadingModulusMax the maximum unloading stiffness of the linear plastic-viscoelastic normal force.

Definition at line 183 of file HertzianSinterNormalSpecies.cc.

References unloadingModulusMax_.

Referenced by setPlasticParameters().

 {
     unloadingModulusMax_ = unloadingModulusMax;
 }

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

virtual

Writes the species properties to an output stream.

Parameters

[out] output stream (typically the restart file)

Implements BaseObject.

Definition at line 74 of file HertzianSinterNormalSpecies.cc.

References cohesionModulus_, dissipation_, loadingModulus_, penetrationDepthMax_, sinterRate_, and unloadingModulusMax_.

 {
     os  << " loadingModulus " << loadingModulus_;
     os  << " maxUnloadingModulus " << unloadingModulusMax_;
     os  << " cohesionModulus " << cohesionModulus_;
     os  << " maxPenetration " << penetrationDepthMax_;
     os  << " dissipation " << dissipation_;
     os  << " sinterRate " << sinterRate_;
 }