MercuryDPM  Alpha
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
IrreversibleAdhesiveSpecies Class Reference

IrreversibleAdhesiveSpecies contains the parameters used to describe a linear irreversible short-range force. More...

#include <IrreversibleAdhesiveSpecies.h>

+ Inheritance diagram for IrreversibleAdhesiveSpecies:

Public Types

typedef
IrreversibleAdhesiveInteraction 
InteractionType
 The correct Interaction type for this AdhesiveForceSpecies. More...
 
- Public Types inherited from ReversibleAdhesiveSpecies
typedef
ReversibleAdhesiveInteraction 
InteractionType
 The correct Interaction type for this AdhesiveForceSpecies. More...
 

Public Member Functions

 IrreversibleAdhesiveSpecies ()
 The default constructor. More...
 
 IrreversibleAdhesiveSpecies (const IrreversibleAdhesiveSpecies &s)
 The default copy constructor. More...
 
virtual ~IrreversibleAdhesiveSpecies ()
 The default destructor. More...
 
std::string getBaseName () const
 Used in Species::getName to obtain a unique name for each Species. More...
 
- Public Member Functions inherited from ReversibleAdhesiveSpecies
 ReversibleAdhesiveSpecies ()
 The default constructor. More...
 
 ReversibleAdhesiveSpecies (const ReversibleAdhesiveSpecies &s)
 The default constructor. More...
 
virtual ~ReversibleAdhesiveSpecies ()
 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 (ReversibleAdhesiveSpecies *const S, ReversibleAdhesiveSpecies *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 setAdhesionStiffness (Mdouble new_k0)
 Allows the spring constant to be changed. More...
 
Mdouble getAdhesionStiffness () const
 Allows the spring constant to be accessed. More...
 
void setAdhesionForceMax (Mdouble new_f0)
 Allows the spring constant to be changed. More...
 
Mdouble getAdhesionForceMax () const
 Allows the spring constant to be accessed. 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 BaseSpeciescopy () 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...
 
SpeciesHandlergetHandler () 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 BaseInteractiongetNewInteraction (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

IrreversibleAdhesiveSpecies contains the parameters used to describe a linear irreversible short-range force.

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

Definition at line 37 of file IrreversibleAdhesiveSpecies.h.

Member Typedef Documentation

Constructor & Destructor Documentation

IrreversibleAdhesiveSpecies::IrreversibleAdhesiveSpecies ( )

The default constructor.

Definition at line 29 of file IrreversibleAdhesiveSpecies.cc.

31 {
32 #ifdef DEBUG_CONSTRUCTOR
33  std::cout<<"IrreversibleAdhesiveSpecies::IrreversibleAdhesiveSpecies() finished"<<std::endl;
34 #endif
35 }
ReversibleAdhesiveSpecies()
The default constructor.
IrreversibleAdhesiveSpecies::IrreversibleAdhesiveSpecies ( const IrreversibleAdhesiveSpecies s)

The default copy constructor.

Parameters
[in]thespecies that is copied

Definition at line 40 of file IrreversibleAdhesiveSpecies.cc.

42 {
43 #ifdef DEBUG_CONSTRUCTOR
44  std::cout<<"IrreversibleAdhesiveSpecies::IrreversibleAdhesiveSpecies(const IrreversibleAdhesiveSpecies &p) finished"<<std::endl;
45 #endif
46 }
ReversibleAdhesiveSpecies()
The default constructor.
IrreversibleAdhesiveSpecies::~IrreversibleAdhesiveSpecies ( )
virtual

The default destructor.

Definition at line 48 of file IrreversibleAdhesiveSpecies.cc.

49 {
50 #ifdef DEBUG_DESTRUCTOR
51  std::cout<<"IrreversibleAdhesiveSpecies::~IrreversibleAdhesiveSpecies() finished"<<std::endl;
52 #endif
53 }

Member Function Documentation

std::string IrreversibleAdhesiveSpecies::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 58 of file IrreversibleAdhesiveSpecies.cc.

59 {
60  return "IrreversibleAdhesive";
61 }

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