EmptyAdhesiveSpecies Class Reference

EmptyAdhesiveSpecies is used to create a force law without a short-range adhesive force. More...

#include <EmptyAdhesiveSpecies.h>

Inheritance diagram for EmptyAdhesiveSpecies:

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

Public Member Functions
	EmptyAdhesiveSpecies ()
	The default constructor. More...
	EmptyAdhesiveSpecies (const EmptyAdhesiveSpecies &s)
	The default copy constructor. More...
virtual	~EmptyAdhesiveSpecies ()
	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 (EmptyAdhesiveSpecies *const S, EmptyAdhesiveSpecies *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 (0.0 for the default EmptyAdhesiveSpecies). 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 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)=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

EmptyAdhesiveSpecies is used to create a force law without a short-range adhesive force.

Definition at line 35 of file EmptyAdhesiveSpecies.h.

Member Typedef Documentation

typedef EmptyAdhesiveInteraction EmptyAdhesiveSpecies::InteractionType

The correct Interaction type for this AdhesiveForceSpecies.

Definition at line 39 of file EmptyAdhesiveSpecies.h.

Constructor & Destructor Documentation

EmptyAdhesiveSpecies::EmptyAdhesiveSpecies

(

)

The default constructor.

Definition at line 29 of file EmptyAdhesiveSpecies.cc.

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

EmptyAdhesiveSpecies::EmptyAdhesiveSpecies

(

const EmptyAdhesiveSpecies &

s

)

The default copy constructor.

EmptyAdhesiveSpecies::~EmptyAdhesiveSpecies ( )

virtual

The default destructor.

Definition at line 46 of file EmptyAdhesiveSpecies.cc.

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

Member Function Documentation

std::string EmptyAdhesiveSpecies::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 70 of file EmptyAdhesiveSpecies.cc.

{
    return "";
}

Mdouble EmptyAdhesiveSpecies::getInteractionDistance ( ) const

virtual

returns the largest separation distance at which adhesive short-range forces can occur (0.0 for the default EmptyAdhesiveSpecies).

Returns

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

Implements BaseSpecies.

Definition at line 83 of file EmptyAdhesiveSpecies.cc.

{
    return 0.0;
}

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

{
}

void EmptyAdhesiveSpecies::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 63 of file EmptyAdhesiveSpecies.cc.

{
}

void EmptyAdhesiveSpecies::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 56 of file EmptyAdhesiveSpecies.cc.

{
}

---

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

• Species/AdhesiveForceSpecies/EmptyAdhesiveSpecies.h
• Species/AdhesiveForceSpecies/EmptyAdhesiveSpecies.cc