revision: v0.14

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

#include <ReversibleAdhesiveSpecies.h>

## Public Types

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.

## ◆ InteractionType

The correct Interaction type for this AdhesiveForceSpecies.

## Constructor & Destructor Documentation

The default constructor.

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
44 {
47 #ifdef DEBUG_CONSTRUCTOR
49 #endif
50 }

The default constructor.

53 {
54 #ifdef DEBUG_DESTRUCTOR
56 #endif
57 }

## Member Function Documentation

Allows the spring constant to be accessed.

128 {
130 }

Allows the spring constant to be accessed.

114 {
116 }

## ◆ getBaseName()

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")
82 {
84 }

## ◆ mix()

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
92 {
95 }

Reads the species properties from an input stream.

Parameters
 [in] is input stream (typically the restart file)
72 {
73  std::string dummy;
74  is >> dummy >> adhesionForceMax_;
75  is >> dummy >> adhesionStiffness_;
76 }

Allows the spring constant to be changed.

120 {
124 }

Allows the spring constant to be changed.

106 {
110 }

## ◆ setInteractionDistance()

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)
99 {
102 }

## ◆ write()

 void ReversibleAdhesiveSpecies::write ( std::ostream & os ) const

Writes the species properties to an output stream.

Parameters
 [out] os output stream (typically the restart file)
63 {
66 }

## Member Data Documentation

private

private

The documentation for this class was generated from the following files:
void setInteractionDistance()
returns the largest separation distance at which adhesive short-range forces can occur.
BaseSpecies::setInteractionDistance
void setInteractionDistance(Mdouble interactionDistance)
Definition: BaseSpecies.cc:156
logger
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
Definition of different loggers with certain modules. A user can define its own custom logger here.
Allows the spring constant to be accessed.
BaseSpecies::average
static Mdouble average(Mdouble a, Mdouble b)
Returns the harmonic mean of two variables.
Definition: BaseSpecies.cc:110