|
ReversibleAdhesiveSpecies contains the parameters used to describe a linear reversible short-range force. More...
#include <ReversibleAdhesiveSpecies.h>
Public Types | |
typedef ReversibleAdhesiveInteraction | InteractionType |
The correct Interaction type for this AdhesiveForceSpecies. More... | |
Public Member Functions | |
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 | |
BaseSpecies * | getBaseSpecies () const |
void | setBaseSpecies (BaseSpecies *baseSpecies) |
Private Attributes | |
Mdouble | adhesionStiffness_ |
stiffness of linear adhesion force More... | |
Mdouble | adhesionForceMax_ |
adhesion force at zero overlap More... | |
ReversibleAdhesiveSpecies contains the parameters used to describe a linear reversible short-range force.
See ReversibleAdhesiveInteraction::computeForce for a description of the force law.
The correct Interaction type for this AdhesiveForceSpecies.
ReversibleAdhesiveSpecies::ReversibleAdhesiveSpecies | ( | ) |
The default constructor.
References adhesionForceMax_, and adhesionStiffness_.
ReversibleAdhesiveSpecies::ReversibleAdhesiveSpecies | ( | const ReversibleAdhesiveSpecies & | s | ) |
The default constructor.
[in] | s | the species that is copied |
References adhesionForceMax_, and adhesionStiffness_.
ReversibleAdhesiveSpecies::~ReversibleAdhesiveSpecies | ( | ) |
Mdouble ReversibleAdhesiveSpecies::getAdhesionForceMax | ( | ) | const |
Allows the spring constant to be accessed.
References adhesionForceMax_.
Referenced by IrreversibleAdhesiveInteraction::computeAdhesionForce(), ReversibleAdhesiveInteraction::computeAdhesionForce(), IrreversibleAdhesiveInteraction::getElasticEnergy(), and mix().
Mdouble ReversibleAdhesiveSpecies::getAdhesionStiffness | ( | ) | const |
Allows the spring constant to be accessed.
References adhesionStiffness_.
Referenced by IrreversibleAdhesiveInteraction::computeAdhesionForce(), ReversibleAdhesiveInteraction::computeAdhesionForce(), IrreversibleAdhesiveInteraction::getElasticEnergy(), mix(), ParticleParticleInteraction::setupInitialConditions(), ParticleParticleInteractionWithPlasticForces::setupInitialConditions(), and ParticleWallInteraction::setupInitialConditions().
std::string ReversibleAdhesiveSpecies::getBaseName | ( | ) | const |
void ReversibleAdhesiveSpecies::mix | ( | ReversibleAdhesiveSpecies * | S, |
ReversibleAdhesiveSpecies * | T | ||
) |
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.
[in] | S,T | the two species whose properties are mixed to create the new species |
References adhesionForceMax_, adhesionStiffness_, BaseSpecies::average(), getAdhesionForceMax(), and getAdhesionStiffness().
void ReversibleAdhesiveSpecies::read | ( | std::istream & | is | ) |
Reads the species properties from an input stream.
[in] | is | input stream (typically the restart file) |
References adhesionForceMax_, and adhesionStiffness_.
void ReversibleAdhesiveSpecies::setAdhesionForceMax | ( | Mdouble | new_f0 | ) |
Allows the spring constant to be changed.
References adhesionForceMax_, adhesionStiffness_, logger, and setInteractionDistance().
Referenced by ParticleParticleInteraction::setupInitialConditions(), ParticleParticleInteractionWithPlasticForces::setupInitialConditions(), and ParticleWallInteraction::setupInitialConditions().
void ReversibleAdhesiveSpecies::setAdhesionStiffness | ( | Mdouble | new_k0 | ) |
Allows the spring constant to be changed.
References adhesionStiffness_, logger, and setInteractionDistance().
Referenced by ParticleParticleInteraction::setupInitialConditions(), ParticleParticleInteractionWithPlasticForces::setupInitialConditions(), and ParticleWallInteraction::setupInitialConditions().
void ReversibleAdhesiveSpecies::setInteractionDistance | ( | ) |
returns the largest separation distance at which adhesive short-range forces can occur.
References adhesionForceMax_, adhesionStiffness_, BaseForce::getBaseSpecies(), logger, and BaseSpecies::setInteractionDistance().
Referenced by setAdhesionForceMax(), and setAdhesionStiffness().
void ReversibleAdhesiveSpecies::write | ( | std::ostream & | os | ) | const |
Writes the species properties to an output stream.
[out] | os | output stream (typically the restart file) |
References adhesionForceMax_, and adhesionStiffness_.
|
private |
adhesion force at zero overlap
Referenced by getAdhesionForceMax(), mix(), read(), ReversibleAdhesiveSpecies(), setAdhesionForceMax(), setInteractionDistance(), and write().
|
private |
stiffness of linear adhesion force
Referenced by getAdhesionStiffness(), mix(), read(), ReversibleAdhesiveSpecies(), setAdhesionForceMax(), setAdhesionStiffness(), setInteractionDistance(), and write().