RegimeSinterSpecies Class Reference

RegimeSinterSpecies contains the parameters used to describe the sintering of particles following three different mechanisms. More...

#include <RegimeSinterSpecies.h>

Inheritance diagram for RegimeSinterSpecies:

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

Public Member Functions
	RegimeSinterSpecies ()
	The default constructor. More...
	RegimeSinterSpecies (const RegimeSinterSpecies &s)
	The default constructor. More...
	~RegimeSinterSpecies ()
	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 (RegimeSinterSpecies *S, RegimeSinterSpecies *T)
	creates default values for mixed species More...
Public Member Functions inherited from BaseForce
BaseSpecies *	getBaseSpecies () const
void	setBaseSpecies (BaseSpecies *baseSpecies)

Detailed Description

RegimeSinterSpecies contains the parameters used to describe the sintering of particles following three different mechanisms.

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

Member Typedef Documentation

InteractionType

typedef RegimeSinterInteraction RegimeSinterSpecies::InteractionType

The correct Interaction type for this AdhesiveForceSpecies.

Constructor & Destructor Documentation

RegimeSinterSpecies() [1/2]

RegimeSinterSpecies::RegimeSinterSpecies

(

)

The default constructor.

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

RegimeSinterSpecies() [2/2]

RegimeSinterSpecies::RegimeSinterSpecies

(

const RegimeSinterSpecies &

s

)

The default constructor.

Parameters

[in]

s

the species that is copied

{
 
#ifdef DEBUG_CONSTRUCTOR
    std::cout<<"RegimeSinterSpecies::RegimeSinterSpecies(const RegimeSinterSpecies &p) finished"<<std::endl;
#endif
}

~RegimeSinterSpecies()

RegimeSinterSpecies::~RegimeSinterSpecies

(

)

The default constructor.

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

Member Function Documentation

getBaseName()

std::string RegimeSinterSpecies::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 "RegimeSinter";
}

mix()

void RegimeSinterSpecies::mix	(	RegimeSinterSpecies *	S,
		RegimeSinterSpecies *	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_ = BaseSpecies::average(S->getAdhesionForceMax(), T->getAdhesionForceMax());
//    adhesionStiffness_ = BaseSpecies::average(S->getAdhesionStiffness(), T->getAdhesionStiffness());
}

read()

void RegimeSinterSpecies::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_;
}

write()

void RegimeSinterSpecies::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_;
}

---

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

• RegimeSinterSpecies.h
• RegimeSinterSpecies.cc