BondedSpecies Class Reference

BondedSpecies contains the parameters used to describe a linear irreversible short-range force. More...

#include <BondedSpecies.h>

Inheritance diagram for BondedSpecies:

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

Public Member Functions
	BondedSpecies ()
	The default constructor. More...
	BondedSpecies (const BondedSpecies &s)
	The default copy constructor. More...
	~BondedSpecies ()
	The default destructor. 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 (BondedSpecies *S, BondedSpecies *T)
	creates default values for mixed species More...
void	setBondDissipation (Mdouble disp)
	Allows the spring constant to be changed. More...
Mdouble	getBondDissipation () const
	Allows the spring constant to be accessed. More...
void	setBondForceMax (Mdouble new_f0)
	Allows bondForceMax_ to be changed. More...
Mdouble	getBondForceMax () const
	Allows bondForceMax_ to be accessed. More...
Public Member Functions inherited from BaseForce
BaseSpecies *	getBaseSpecies () const
void	setBaseSpecies (BaseSpecies *baseSpecies)

Private Attributes
Mdouble	bondDissipation_
	dissipation in bond More...
Mdouble	bondForceMax_
	adhesion force at zero overlap More...

Detailed Description

BondedSpecies contains the parameters used to describe a linear irreversible short-range force.

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

Member Typedef Documentation

InteractionType

typedef BondedInteraction BondedSpecies::InteractionType

The correct Interaction type for this AdhesiveForceSpecies.

Constructor & Destructor Documentation

BondedSpecies() [1/2]

BondedSpecies::BondedSpecies

(

)

The default constructor.

Default constructor for gluable species. Sets default values for all relevant parameters. Note: if the stiffness of particles is left as zero, no force will be felt during interaction with other particles

Parameters

[in]

s

the species that is copied

{
    bondForceMax_ = 0;
    bondDissipation_ = 0;
#ifdef DEBUG_CONSTRUCTOR
    std::cout<<"BondedSpecies::BondedSpecies() finished"<<std::endl;
#endif
}

References bondDissipation_, and bondForceMax_.

BondedSpecies() [2/2]

BondedSpecies::BondedSpecies

(

const BondedSpecies &

s

)

The default copy constructor.

Parameters

[in]

the

species that is copied

{
    bondForceMax_ = s.bondForceMax_;
    bondDissipation_ = s.bondDissipation_;
#ifdef DEBUG_CONSTRUCTOR
    std::cout<<"BondedSpecies::BondedSpecies(const BondedSpecies &p) finished"<<std::endl;
#endif
}

References bondDissipation_, and bondForceMax_.

~BondedSpecies()

BondedSpecies::~BondedSpecies

(

)

The default destructor.

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

Member Function Documentation

getBaseName()

std::string BondedSpecies::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 "Bonded";
}

getBondDissipation()

Mdouble BondedSpecies::getBondDissipation

(

)

const

Allows the spring constant to be accessed.

{
    return bondDissipation_;
}

References bondDissipation_.

Referenced by BondedInteraction::computeAdhesionForce(), and mix().

getBondForceMax()

Mdouble BondedSpecies::getBondForceMax

(

)

const

Allows bondForceMax_ to be accessed.

Allows the spring constant to be accessed.

{
    return bondForceMax_;
}

References bondForceMax_.

Referenced by BondedInteraction::bond(), BondedInteraction::getElasticEnergy(), and mix().

mix()

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

{
    bondForceMax_ = BaseSpecies::average(S->getBondForceMax(), T->getBondForceMax());
    bondDissipation_ = BaseSpecies::average(S->getBondDissipation(), T->getBondDissipation());
}

References BaseSpecies::average(), bondDissipation_, bondForceMax_, getBondDissipation(), and getBondForceMax().

read()

void BondedSpecies::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 >> bondForceMax_;
    is >> dummy >> bondDissipation_;
}

References bondDissipation_, and bondForceMax_.

setBondDissipation()

void BondedSpecies::setBondDissipation

(

Mdouble

disp

)

Allows the spring constant to be changed.

{
    if (disp >= 0)
        bondDissipation_ = disp;
    else
    {
        logger(ERROR, "Error in setBondDissipation");
    }
}

References bondDissipation_, ERROR, and logger.

setBondForceMax()

void BondedSpecies::setBondForceMax

(

Mdouble

new_f0

)

Allows bondForceMax_ to be changed.

Allows the spring constant to be changed.

{
    if (new_f0 >= 0)
        bondForceMax_ = new_f0;
    else
    {
        logger(ERROR, "Error in setBondForceMax");
    }
}

References bondForceMax_, ERROR, and logger.

write()

void BondedSpecies::write

(

std::ostream &

os

)

const

Writes the species properties to an output stream.

Parameters

[out]

os

output stream (typically the restart file)

{
    os << " bondForceMax " << bondForceMax_;
    os << " bondDissipation " << bondDissipation_;
}

References bondDissipation_, and bondForceMax_.

Member Data Documentation

bondDissipation_

Mdouble BondedSpecies::bondDissipation_

private

dissipation in bond

Referenced by BondedSpecies(), getBondDissipation(), mix(), read(), setBondDissipation(), and write().

bondForceMax_

Mdouble BondedSpecies::bondForceMax_

private

adhesion force at zero overlap

Referenced by BondedSpecies(), getBondForceMax(), mix(), read(), setBondForceMax(), and write().

---

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

• BondedSpecies.h
• BondedSpecies.cc