EmptyFrictionSpecies Class Reference

EmptyFrictionSpecies is used to create a force law without frictional forces. More...

#include <EmptyFrictionSpecies.h>

Inheritance diagram for EmptyFrictionSpecies:

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

Public Member Functions
	EmptyFrictionSpecies ()
	The default constructor. More...
	EmptyFrictionSpecies (const EmptyFrictionSpecies &s UNUSED)
	The default copy constructor. More...
virtual	~EmptyFrictionSpecies ()
	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...
bool	getUseAngularDOFs () const
	Returns true if torques have to be calculated. More...
void	mix (EmptyFrictionSpecies *const S, EmptyFrictionSpecies *const T)
	creates default values for mixed species 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 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...

Detailed Description

EmptyFrictionSpecies is used to create a force law without frictional forces.

Definition at line 37 of file EmptyFrictionSpecies.h.

Member Typedef Documentation

typedef EmptyFrictionInteraction EmptyFrictionSpecies::InteractionType

The correct Interaction type for this FrictionForceSpecies.

Definition at line 41 of file EmptyFrictionSpecies.h.

Constructor & Destructor Documentation

EmptyFrictionSpecies::EmptyFrictionSpecies

(

)

The default constructor.

Definition at line 28 of file EmptyFrictionSpecies.cc.

{
#ifdef DEBUG_CONSTRUCTOR
    std::cout<<"EmptySpecies::EmptySpecies() finished"<<std::endl;
#endif
}

EmptyFrictionSpecies::EmptyFrictionSpecies

(

const EmptyFrictionSpecies &s

UNUSED

)

The default copy constructor.

Parameters

[in]

the

species that is copied

Definition at line 38 of file EmptyFrictionSpecies.cc.

{
#ifdef DEBUG_CONSTRUCTOR
    std::cout<<"EmptySpecies::EmptySpecies(const EmptySpecies &p) finished"<<std::endl;
#endif
}

EmptyFrictionSpecies::~EmptyFrictionSpecies ( )

virtual

The default destructor.

Definition at line 45 of file EmptyFrictionSpecies.cc.

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

Member Function Documentation

std::string EmptyFrictionSpecies::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 69 of file EmptyFrictionSpecies.cc.

{
    return "";
}

bool EmptyFrictionSpecies::getUseAngularDOFs ( ) const

virtual

Returns true if torques have to be calculated.

Returns true for any FrictionForceSpecies except EmptyFrictionSpecies, because for spherical particles, torques are only caused by tangential forces. See SpeciesHandler::useAngularDOFs for more details

Returns

false

Implements BaseSpecies.

Definition at line 87 of file EmptyFrictionSpecies.cc.

{
    return false;
}

void EmptyFrictionSpecies::mix	(	EmptyFrictionSpecies *const S	UNUSED,
		EmptyFrictionSpecies *const T	UNUSED
	)

creates default values for mixed species

Parameters

[in]

S,T

the two species whose properties are mixed to create the new species

Definition at line 77 of file EmptyFrictionSpecies.cc.

{
}

void EmptyFrictionSpecies::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 62 of file EmptyFrictionSpecies.cc.

{
}

void EmptyFrictionSpecies::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 55 of file EmptyFrictionSpecies.cc.

{
}

---

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

• Species/FrictionForceSpecies/EmptyFrictionSpecies.h
• Species/FrictionForceSpecies/EmptyFrictionSpecies.cc