MercuryDPM  Beta

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

#include <ReversibleAdhesiveSpecies.h>

## Public Types

typedef
InteractionType
The correct Interaction type for this AdhesiveForceSpecies. More...

## Public Member Functions

The default constructor. More...

The default constructor. More...

The default constructor. More...

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...

creates default values for mixed species More...

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

Allows the spring constant to be changed. More...

Allows the spring constant to be accessed. More...

Allows the spring constant to be changed. More...

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)=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

stiffness of linear adhesion force More...

adhesion force at zero overlap More...

## Detailed Description

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

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

Definition at line 36 of file ReversibleAdhesiveSpecies.h.

## Member Typedef Documentation

The correct Interaction type for this AdhesiveForceSpecies.

Definition at line 40 of file ReversibleAdhesiveSpecies.h.

## Constructor & Destructor Documentation

The default constructor.

Definition at line 29 of file ReversibleAdhesiveSpecies.cc.

30 {
33 #ifdef DEBUG_CONSTRUCTOR
35 #endif
36 }

The default constructor.

Parameters
 [in] s the species that is copied

Definition at line 41 of file ReversibleAdhesiveSpecies.cc.

42 {
45 #ifdef DEBUG_CONSTRUCTOR
47 #endif
48 }
virtual

The default constructor.

Definition at line 50 of file ReversibleAdhesiveSpecies.cc.

51 {
52 #ifdef DEBUG_DESTRUCTOR
54 #endif
55 }

## Member Function Documentation

Allows the spring constant to be accessed.

Definition at line 136 of file ReversibleAdhesiveSpecies.cc.

137 {
139 }

Allows the spring constant to be accessed.

Definition at line 119 of file ReversibleAdhesiveSpecies.cc.

120 {
122 }

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 79 of file ReversibleAdhesiveSpecies.cc.

80 {
82 }
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 96 of file ReversibleAdhesiveSpecies.cc.

97 {
100  else
101  {
103  exit(-1);
104  }
105 }

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 89 of file ReversibleAdhesiveSpecies.cc.

90 {
93 }
Allows the spring constant to be accessed.
Mdouble average(Mdouble a, Mdouble b)
defines the average of two variables by the harmonic mean.
Definition: BaseSpecies.cc:85
Allows the spring constant to be accessed.
virtual

Reads the species properties from an input stream.

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

Implements BaseObject.

Definition at line 69 of file ReversibleAdhesiveSpecies.cc.

70 {
71  std::string dummy;
72  is >> dummy >> adhesionForceMax_;
73  is >> dummy >> adhesionStiffness_;
74 }

Allows the spring constant to be changed.

Definition at line 125 of file ReversibleAdhesiveSpecies.cc.

126 {
127  if (new_f0 >= 0)
129  else
130  {
131  std::cerr << "Error in setAdhesionForceMax" << std::endl;
132  exit(-1);
133  }
134 }

Allows the spring constant to be changed.

Definition at line 108 of file ReversibleAdhesiveSpecies.cc.

109 {
110  if (new_k0 >= 0)
112  else
113  {
114  std::cerr << "Error in setAdhesionStiffness" << std::endl;
115  exit(-1);
116  }
117 }
 void ReversibleAdhesiveSpecies::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 60 of file ReversibleAdhesiveSpecies.cc.

61  {
64 }

private