JKRAdhesiveSpecies Class Reference

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

#include <JKRAdhesiveSpecies.h>

Inheritance diagram for JKRAdhesiveSpecies:

Public Types
typedef JKRAdhesiveInteraction	InteractionType
	The correct Interaction type for this AdhesiveForceSpecies. More...

Public Member Functions
	JKRAdhesiveSpecies ()
	The default constructor. More...
	JKRAdhesiveSpecies (const JKRAdhesiveSpecies &s)
	The default constructor. More...
	~JKRAdhesiveSpecies ()
	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 (JKRAdhesiveSpecies *S, JKRAdhesiveSpecies *T)
	creates default values for mixed species More...
void	setAdhesionStiffness (Mdouble new_k0)
	returns the largest separation distance at which adhesive short-range forces can occur. More...
Mdouble	getAdhesionStiffness () const
	Allows the spring constant to be accessed. More...
void	setSurfaceEnergy (Mdouble surfaceEnergy)
	Allows the spring constant to be changed. More...
Mdouble	getSurfaceEnergy () const
Public Member Functions inherited from BaseAdhesiveForce
virtual void	setInteractionDistance ()
Public Member Functions inherited from BaseForce
BaseSpecies *	getBaseSpecies () const
void	setBaseSpecies (BaseSpecies *baseSpecies)

Private Attributes
Mdouble	adhesionStiffness_
	stiffness of linear adhesion force More...
Mdouble	surfaceEnergy_
	adhesion force at zero overlap More...

Detailed Description

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

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

Member Typedef Documentation

InteractionType

typedef JKRAdhesiveInteraction JKRAdhesiveSpecies::InteractionType

The correct Interaction type for this AdhesiveForceSpecies.

Constructor & Destructor Documentation

JKRAdhesiveSpecies() [1/2]

JKRAdhesiveSpecies::JKRAdhesiveSpecies

(

)

The default constructor.

{
    //adhesionForceMax_ = 0;
    adhesionStiffness_ = 0;
    surfaceEnergy_ = 0.0;
#ifdef DEBUG_CONSTRUCTOR
    std::cout<<"JKRAdhesiveSpecies::JKRAdhesiveSpecies() finished"<<std::endl;
#endif
}

References adhesionStiffness_, and surfaceEnergy_.

JKRAdhesiveSpecies() [2/2]

JKRAdhesiveSpecies::JKRAdhesiveSpecies

(

const JKRAdhesiveSpecies &

s

)

The default constructor.

Parameters

[in]

s

the species that is copied

{
    //adhesionForceMax_ = s.adhesionForceMax_;
    adhesionStiffness_ = s.adhesionStiffness_;
    surfaceEnergy_ = s.surfaceEnergy_;
#ifdef DEBUG_CONSTRUCTOR
    std::cout<<"JKRAdhesiveSpecies::JKRAdhesiveSpecies(const JKRAdhesiveSpecies &p) finished"<<std::endl;
#endif
}

References adhesionStiffness_, s, and surfaceEnergy_.

~JKRAdhesiveSpecies()

JKRAdhesiveSpecies::~JKRAdhesiveSpecies

(

)

The default constructor.

{
#ifdef DEBUG_DESTRUCTOR
    std::cout<<"JKRAdhesiveSpecies::~JKRAdhesiveSpecies() finished"<<std::endl;
#endif
}

Member Function Documentation

getAdhesionStiffness()

Mdouble JKRAdhesiveSpecies::getAdhesionStiffness

(

)

const

Allows the spring constant to be accessed.

{
    return adhesionStiffness_;
}

References adhesionStiffness_.

Referenced by JKRAdhesiveInteraction::computeAdhesionForce().

getBaseName()

std::string JKRAdhesiveSpecies::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")

{
    return "JKRAdhesive";
}

getSurfaceEnergy()

Mdouble JKRAdhesiveSpecies::getSurfaceEnergy

(

)

const

{
    return surfaceEnergy_;
}

References surfaceEnergy_.

Referenced by JKRAdhesiveInteraction::computeAdhesionForce().

mix()

void JKRAdhesiveSpecies::mix	(	JKRAdhesiveSpecies *	S,
		JKRAdhesiveSpecies *	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.

Parameters

[in]

S,T

the two species whose properties are mixed to create the new species

{
    //adhesionForceMax_ = average(S->getAdhesionForceMax(), T->getAdhesionForceMax());
    adhesionStiffness_ = BaseSpecies::average(S->getAdhesionStiffness(), T->getAdhesionStiffness());
}

References adhesionStiffness_, BaseSpecies::average(), and oomph::QuadTreeNames::S.

read()

void JKRAdhesiveSpecies::read

(

std::istream &

is

)

Reads the species properties from an input stream.

Parameters

[in]

is

input stream (typically the restart file)

{
    std::string dummy;
    //is >> dummy >> adhesionForceMax_;
    is >> dummy >> adhesionStiffness_;
    is >> dummy >> surfaceEnergy_;
}

References adhesionStiffness_, oomph::Global_string_for_annotation::string(), and surfaceEnergy_.

setAdhesionStiffness()

void JKRAdhesiveSpecies::setAdhesionStiffness

(

Mdouble

new_k0

)

returns the largest separation distance at which adhesive short-range forces can occur.

Allows the spring constant to be changed.

Allows the spring constant to be changed

{
    logger.assert_debug(adhesionStiffness >= 0,"Error in setAdhesionStiffness");
    adhesionStiffness_ = adhesionStiffness;
    //setInteractionDistance();
}

References adhesionStiffness_, and logger.

setSurfaceEnergy()

void JKRAdhesiveSpecies::setSurfaceEnergy

(

Mdouble

surfaceEnergy

)

Allows the spring constant to be changed.

Allows the spring constant to be accessed

{
    surfaceEnergy_ = surfaceEnergy;
}

References surfaceEnergy_.

write()

void JKRAdhesiveSpecies::write

(

std::ostream &

os

)

const

Writes the species properties to an output stream.

Parameters

[out]

os

output stream (typically the restart file)

{
    //os << " adhesionForceMax " << adhesionForceMax_;
    os << " adhesionStiffness " << adhesionStiffness_;
    os << " surfaceEnergy " << surfaceEnergy_;
}

References adhesionStiffness_, and surfaceEnergy_.

Member Data Documentation

adhesionStiffness_

Mdouble JKRAdhesiveSpecies::adhesionStiffness_

private

stiffness of linear adhesion force

Referenced by getAdhesionStiffness(), JKRAdhesiveSpecies(), mix(), read(), setAdhesionStiffness(), and write().

surfaceEnergy_

Mdouble JKRAdhesiveSpecies::surfaceEnergy_

private

adhesion force at zero overlap

Referenced by getSurfaceEnergy(), JKRAdhesiveSpecies(), read(), setSurfaceEnergy(), and write().

---

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

• JKRAdhesiveSpecies.h
• JKRAdhesiveSpecies.cc