ParhamiMcMeekingSinterSpecies contains the parameters used to describe a linear reversible short-range force. More...

#include <ParhamiMcMeekingSinterSpecies.h>

Inheritance diagram for ParhamiMcMeekingSinterSpecies:

Public Types
typedef ParhamiMcMeekingSinterInteraction	InteractionType
	The correct Interaction type for this AdhesiveForceSpecies. More...

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

	ParhamiMcMeekingSinterSpecies (const ParhamiMcMeekingSinterSpecies &s)
	The default constructor. More...

virtual	~ParhamiMcMeekingSinterSpecies ()
	The default constructor. 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 (ParhamiMcMeekingSinterSpecies const S, ParhamiMcMeekingSinterSpecies const T)
	creates default values for mixed species More...

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

void	set (Mdouble alpha, Mdouble beta, Mdouble atomicVolume, Mdouble surfaceEnergy, Mdouble thicknessDiffusion, Mdouble activationEnergy, Mdouble temperature, Mdouble pseudoSlidingFrictionCoefficient)

Mdouble	getViscosityCoefficient () const

Mdouble	getAdhesionCoefficient () const

Mdouble	getSlidingFrictionCoefficient () const

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 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	alpha_
	viscous force is adhesionCoefficient_temperaturecontactRadius^4*normalRelativeVelocity More...

Mdouble	beta_

Mdouble	atomicVolume_

Mdouble	surfaceEnergy_

Mdouble	thicknessDiffusion_

Mdouble	activationEnergy_

Mdouble	temperature_

Mdouble	pseudoSlidingFrictionCoefficient_

Mdouble	viscosityCoefficient_
	viscous force is viscosityCoefficient_contactRadius^4normalRelativeVelocity More...

Mdouble	adhesionCoefficient_
	adhesion force is adhesionCoefficient_*radius More...

Mdouble	slidingFrictionCoefficient_
	tangential force is slidingFrictionCoefficient_contactRadius^2radius*tangentialRelativeVelocity More...

Detailed Description

ParhamiMcMeekingSinterSpecies contains the parameters used to describe a linear reversible short-range force.

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

Definition at line 36 of file ParhamiMcMeekingSinterSpecies.h.

Member Typedef Documentation

typedef ParhamiMcMeekingSinterInteraction ParhamiMcMeekingSinterSpecies::InteractionType

The correct Interaction type for this AdhesiveForceSpecies.

Definition at line 40 of file ParhamiMcMeekingSinterSpecies.h.

Constructor & Destructor Documentation

ParhamiMcMeekingSinterSpecies::ParhamiMcMeekingSinterSpecies ( )

The default constructor.

Todo:: : implement initial/read/write values

Definition at line 30 of file ParhamiMcMeekingSinterSpecies.cc.

 {
 //    adhesionForceMax_ = 0;
 //    adhesionStiffness_ = 0;
 #ifdef DEBUG_CONSTRUCTOR
     std::cout<<"ParhamiMcMeekingSinterSpecies::ParhamiMcMeekingSinterSpecies() finished"<<std::endl;
 #endif
 }

ParhamiMcMeekingSinterSpecies::ParhamiMcMeekingSinterSpecies ( const ParhamiMcMeekingSinterSpecies & s )

The default constructor.

Parameters

[in] s the species that is copied

Definition at line 42 of file ParhamiMcMeekingSinterSpecies.cc.

References activationEnergy_, adhesionCoefficient_, alpha_, atomicVolume_, beta_, pseudoSlidingFrictionCoefficient_, slidingFrictionCoefficient_, surfaceEnergy_, temperature_, thicknessDiffusion_, and viscosityCoefficient_.

 {
     alpha_= s.alpha_;
     beta_ = s.beta_;
     atomicVolume_ = s.atomicVolume_; /*Omega*/
     surfaceEnergy_ = s.surfaceEnergy_; /*gamma_s*/
     thicknessDiffusion_ = s.thicknessDiffusion_; /*deltaB*D0B*/
     activationEnergy_ = s.activationEnergy_; /*QB*/
     temperature_ = s.temperature_; /*T*/
     pseudoSlidingFrictionCoefficient_ = s.pseudoSlidingFrictionCoefficient_; /*etaPart*/
     viscosityCoefficient_ = s.viscosityCoefficient_;
     adhesionCoefficient_ = s.adhesionCoefficient_;
     slidingFrictionCoefficient_ = s.slidingFrictionCoefficient_;
 #ifdef DEBUG_CONSTRUCTOR
     std::cout<<"ParhamiMcMeekingSinterSpecies::ParhamiMcMeekingSinterSpecies(const ParhamiMcMeekingSinterSpecies &p) finished"<<std::endl;
 #endif
 }

ParhamiMcMeekingSinterSpecies::~ParhamiMcMeekingSinterSpecies ( )

virtual

The default constructor.

Definition at line 60 of file ParhamiMcMeekingSinterSpecies.cc.

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

Member Function Documentation

Mdouble ParhamiMcMeekingSinterSpecies::getAdhesionCoefficient ( ) const

inline

Definition at line 92 of file ParhamiMcMeekingSinterSpecies.h.

References adhesionCoefficient_.

Referenced by ParhamiMcMeekingSinterInteraction::computeAdhesionForce().

92 {return adhesionCoefficient_;}

ParhamiMcMeekingSinterSpecies::adhesionCoefficient_

Mdouble adhesionCoefficient_

adhesion force is adhesionCoefficient_*radius

Definition: ParhamiMcMeekingSinterSpecies.h:111

std::string ParhamiMcMeekingSinterSpecies::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 89 of file ParhamiMcMeekingSinterSpecies.cc.

 {
     return "ParhamiMcMeekingSinter";
 }

Mdouble ParhamiMcMeekingSinterSpecies::getInteractionDistance ( ) const

virtual

returns the largest separation distance at which adhesive short-range forces can occur.

Returns: the maximum separation distance below which adhesive forces can occur (needed for contact detection)

Implements BaseSpecies.

Definition at line 106 of file ParhamiMcMeekingSinterSpecies.cc.

 {
     return 0.0;
 }

Mdouble ParhamiMcMeekingSinterSpecies::getSlidingFrictionCoefficient ( ) const

inline

Definition at line 93 of file ParhamiMcMeekingSinterSpecies.h.

References slidingFrictionCoefficient_.

Referenced by ParhamiMcMeekingSinterInteraction::computeAdhesionForce().

93 {return slidingFrictionCoefficient_;}

ParhamiMcMeekingSinterSpecies::slidingFrictionCoefficient_

Mdouble slidingFrictionCoefficient_

tangential force is slidingFrictionCoefficient_*contactRadius^2*radius*tangentialRelativeVelocity ...

Definition: ParhamiMcMeekingSinterSpecies.h:114

Mdouble ParhamiMcMeekingSinterSpecies::getViscosityCoefficient ( ) const

inline

Definition at line 91 of file ParhamiMcMeekingSinterSpecies.h.

References viscosityCoefficient_.

Referenced by ParhamiMcMeekingSinterInteraction::computeAdhesionForce().

91 {return viscosityCoefficient_;}

ParhamiMcMeekingSinterSpecies::viscosityCoefficient_

Mdouble viscosityCoefficient_

viscous force is viscosityCoefficient_*contactRadius^4*normalRelativeVelocity

Definition: ParhamiMcMeekingSinterSpecies.h:108

void ParhamiMcMeekingSinterSpecies::mix	(	ParhamiMcMeekingSinterSpecies *const	S,
		ParhamiMcMeekingSinterSpecies *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 99 of file ParhamiMcMeekingSinterSpecies.cc.

 {
 //    adhesionForceMax_ = average(S->getAdhesionForceMax(), T->getAdhesionForceMax());
 //    adhesionStiffness_ = average(S->getAdhesionStiffness(), T->getAdhesionStiffness());
 }

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

virtual

Reads the species properties from an input stream.

Parameters

[in] is input stream (typically the restart file)

Implements BaseObject.

Definition at line 79 of file ParhamiMcMeekingSinterSpecies.cc.

 {
 //    std::string dummy;
 //    is >> dummy >> adhesionForceMax_;
 //    is >> dummy >> adhesionStiffness_;
 }

void ParhamiMcMeekingSinterSpecies::set	(	Mdouble	alpha,
		Mdouble	beta,
		Mdouble	atomicVolume,
		Mdouble	surfaceEnergy,
		Mdouble	thicknessDiffusion,
		Mdouble	activationEnergy,
		Mdouble	temperature,
		Mdouble	pseudoSlidingFrictionCoefficient
	)

inline

Definition at line 69 of file ParhamiMcMeekingSinterSpecies.h.

References activationEnergy_, adhesionCoefficient_, alpha_, atomicVolume_, beta_, mathsFunc::exp(), constants::pi, pseudoSlidingFrictionCoefficient_, slidingFrictionCoefficient_, surfaceEnergy_, temperature_, thicknessDiffusion_, and viscosityCoefficient_.

                                                          {
         alpha_ = alpha;
         beta_ = beta;
         atomicVolume_ = atomicVolume;
         surfaceEnergy_ = surfaceEnergy;
         thicknessDiffusion_ = thicknessDiffusion;
         activationEnergy_ = activationEnergy;
         temperature_ = temperature;
         pseudoSlidingFrictionCoefficient_ = pseudoSlidingFrictionCoefficient;
 
         Mdouble boltzmannConstant /*k_B*/ = 1.38064852e-23;
         Mdouble gasConstant /*R_g*/ = 8.314459848;
         Mdouble thicknessDiffusionVacancy /*DB*/ = thicknessDiffusion_*exp(-activationEnergy_/gasConstant/temperature_);
         std::cout << thicknessDiffusionVacancy << "|" << thicknessDiffusion_ << std::endl;
         Mdouble diffusionParameter /*DeltaB*/ = atomicVolume_/boltzmannConstant/temperature_*thicknessDiffusionVacancy;
         viscosityCoefficient_ = constants::pi/(2.0*beta*diffusionParameter);
         adhesionCoefficient_ = alpha_/beta_*constants::pi*surfaceEnergy_;
         slidingFrictionCoefficient_ = pseudoSlidingFrictionCoefficient_ * constants::pi / (2.0*beta*diffusionParameter);
     }

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

virtual

Writes the species properties to an output stream.

Parameters

[out] os output stream (typically the restart file)

Implements BaseObject.

Definition at line 70 of file ParhamiMcMeekingSinterSpecies.cc.

 {
 //    os << " adhesionForceMax " << adhesionForceMax_;
 //    os << " adhesionStiffness " << adhesionStiffness_;
 }

Member Data Documentation

Mdouble ParhamiMcMeekingSinterSpecies::activationEnergy_

private

Definition at line 103 of file ParhamiMcMeekingSinterSpecies.h.

Referenced by ParhamiMcMeekingSinterSpecies(), and set().

Mdouble ParhamiMcMeekingSinterSpecies::adhesionCoefficient_

private

adhesion force is adhesionCoefficient_*radius

Definition at line 111 of file ParhamiMcMeekingSinterSpecies.h.

Referenced by getAdhesionCoefficient(), ParhamiMcMeekingSinterSpecies(), and set().

Mdouble ParhamiMcMeekingSinterSpecies::alpha_

private

viscous force is adhesionCoefficient_*temperature*contactRadius^4*normalRelativeVelocity

Definition at line 98 of file ParhamiMcMeekingSinterSpecies.h.

Referenced by ParhamiMcMeekingSinterSpecies(), and set().

Mdouble ParhamiMcMeekingSinterSpecies::atomicVolume_

private

Definition at line 100 of file ParhamiMcMeekingSinterSpecies.h.

Referenced by ParhamiMcMeekingSinterSpecies(), and set().

Mdouble ParhamiMcMeekingSinterSpecies::beta_

private

Definition at line 99 of file ParhamiMcMeekingSinterSpecies.h.

Referenced by ParhamiMcMeekingSinterSpecies(), and set().

Mdouble ParhamiMcMeekingSinterSpecies::pseudoSlidingFrictionCoefficient_

private

Definition at line 105 of file ParhamiMcMeekingSinterSpecies.h.

Referenced by ParhamiMcMeekingSinterSpecies(), and set().

Mdouble ParhamiMcMeekingSinterSpecies::slidingFrictionCoefficient_

private

tangential force is slidingFrictionCoefficient_*contactRadius^2*radius*tangentialRelativeVelocity

Definition at line 114 of file ParhamiMcMeekingSinterSpecies.h.

Referenced by getSlidingFrictionCoefficient(), ParhamiMcMeekingSinterSpecies(), and set().

Mdouble ParhamiMcMeekingSinterSpecies::surfaceEnergy_

private

Definition at line 101 of file ParhamiMcMeekingSinterSpecies.h.

Referenced by ParhamiMcMeekingSinterSpecies(), and set().

Mdouble ParhamiMcMeekingSinterSpecies::temperature_

private

Definition at line 104 of file ParhamiMcMeekingSinterSpecies.h.

Referenced by ParhamiMcMeekingSinterSpecies(), and set().

Mdouble ParhamiMcMeekingSinterSpecies::thicknessDiffusion_

private

Definition at line 102 of file ParhamiMcMeekingSinterSpecies.h.

Referenced by ParhamiMcMeekingSinterSpecies(), and set().

Mdouble ParhamiMcMeekingSinterSpecies::viscosityCoefficient_

private

viscous force is viscosityCoefficient_*contactRadius^4*normalRelativeVelocity

Definition at line 108 of file ParhamiMcMeekingSinterSpecies.h.

Referenced by getViscosityCoefficient(), ParhamiMcMeekingSinterSpecies(), and set().

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

Species/AdhesiveForceSpecies/ParhamiMcMeekingSinterSpecies.h
Species/AdhesiveForceSpecies/ParhamiMcMeekingSinterSpecies.cc

Public Types

Public Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation