MercuryDPM  Trunk

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

void setInteractionDistance ()
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 BaseForce
BaseSpeciesgetBaseSpecies () const

void setBaseSpecies (BaseSpecies *baseSpecies)

## 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 37 of file ReversibleAdhesiveSpecies.h.

## Member Typedef Documentation

The correct Interaction type for this AdhesiveForceSpecies.

Definition at line 41 of file ReversibleAdhesiveSpecies.h.

## Constructor & Destructor Documentation

The default constructor.

Definition at line 30 of file ReversibleAdhesiveSpecies.cc.

31 {
34  //interaction distance not yet determined
35 #ifdef DEBUG_CONSTRUCTOR
37 #endif
38 }

The default constructor.

Parameters
 [in] s the species that is copied

Definition at line 43 of file ReversibleAdhesiveSpecies.cc.

44 {
47 #ifdef DEBUG_CONSTRUCTOR
49 #endif
50 }

The default constructor.

Definition at line 52 of file ReversibleAdhesiveSpecies.cc.

53 {
54 #ifdef DEBUG_DESTRUCTOR
56 #endif
57 }

## Member Function Documentation

Allows the spring constant to be accessed.

Definition at line 127 of file ReversibleAdhesiveSpecies.cc.

128 {
130 }

Allows the spring constant to be accessed.

Definition at line 113 of file ReversibleAdhesiveSpecies.cc.

114 {
116 }

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

82 {
84 }

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

92 {
95 }
Allows the spring constant to be accessed.
static Mdouble average(Mdouble a, Mdouble b)
Returns the harmonic mean of two variables.
Definition: BaseSpecies.cc:110
Allows the spring constant to be accessed.

Reads the species properties from an input stream.

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

Definition at line 71 of file ReversibleAdhesiveSpecies.cc.

72 {
73  std::string dummy;
74  is >> dummy >> adhesionForceMax_;
75  is >> dummy >> adhesionStiffness_;
76 }

Allows the spring constant to be changed.

Definition at line 119 of file ReversibleAdhesiveSpecies.cc.

120 {
124 }
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
void setInteractionDistance()
returns the largest separation distance at which adhesive short-range forces can occur.

Allows the spring constant to be changed.

Definition at line 105 of file ReversibleAdhesiveSpecies.cc.

106 {
110 }
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
void setInteractionDistance()
returns the largest separation distance at which adhesive short-range forces can occur.

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)

Definition at line 98 of file ReversibleAdhesiveSpecies.cc.

99 {
102 }
BaseSpecies * getBaseSpecies() const
Definition: BaseForce.h:35
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
void setInteractionDistance(Mdouble interactionDistance)
Sets BaseSpecies::interactionDistance_.
Definition: BaseSpecies.cc:156
 void ReversibleAdhesiveSpecies::write ( std::ostream & os ) const

Writes the species properties to an output stream.

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

Definition at line 62 of file ReversibleAdhesiveSpecies.cc.

63 {
66 }

private