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...
 
 ~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...
 
 ~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 *S, ReversibleAdhesiveSpecies *T)
 creates default values for mixed species More...
 
void setInteractionDistance ()
 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 BaseForce
BaseSpeciesgetBaseSpecies () const
 
void setBaseSpecies (BaseSpecies *baseSpecies)
 

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.

Member Typedef Documentation

◆ InteractionType

The correct Interaction type for this AdhesiveForceSpecies.

Constructor & Destructor Documentation

◆ IrreversibleAdhesiveSpecies() [1/2]

IrreversibleAdhesiveSpecies::IrreversibleAdhesiveSpecies ( )

The default constructor.

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

◆ IrreversibleAdhesiveSpecies() [2/2]

IrreversibleAdhesiveSpecies::IrreversibleAdhesiveSpecies ( const IrreversibleAdhesiveSpecies s)

The default copy constructor.

Parameters
[in]thespecies that is copied
42 {
43 #ifdef DEBUG_CONSTRUCTOR
44  std::cout<<"IrreversibleAdhesiveSpecies::IrreversibleAdhesiveSpecies(const IrreversibleAdhesiveSpecies &p) finished"<<std::endl;
45 #endif
46 }

◆ ~IrreversibleAdhesiveSpecies()

IrreversibleAdhesiveSpecies::~IrreversibleAdhesiveSpecies ( )

The default destructor.

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

Member Function Documentation

◆ getBaseName()

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")
59 {
60  return "IrreversibleAdhesive";
61 }

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