MercuryDPM  Trunk
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
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
BaseSpeciesgetBaseSpecies () 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.

Definition at line 37 of file RegimeSinterSpecies.h.

Member Typedef Documentation

Constructor & Destructor Documentation

RegimeSinterSpecies::RegimeSinterSpecies ( )

The default constructor.

Definition at line 29 of file RegimeSinterSpecies.cc.

30 {
31 // adhesionForceMax_ = 0;
32 // adhesionStiffness_ = 0;
33 #ifdef DEBUG_CONSTRUCTOR
34  std::cout<<"RegimeSinterSpecies::RegimeSinterSpecies() finished"<<std::endl;
35 #endif
36 }
RegimeSinterSpecies::RegimeSinterSpecies ( const RegimeSinterSpecies s)

The default constructor.

Parameters
[in]sthe species that is copied

Definition at line 41 of file RegimeSinterSpecies.cc.

42 {
43 
44 #ifdef DEBUG_CONSTRUCTOR
45  std::cout<<"RegimeSinterSpecies::RegimeSinterSpecies(const RegimeSinterSpecies &p) finished"<<std::endl;
46 #endif
47 }
RegimeSinterSpecies::~RegimeSinterSpecies ( )

The default constructor.

Definition at line 49 of file RegimeSinterSpecies.cc.

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

Member Function Documentation

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")

Definition at line 78 of file RegimeSinterSpecies.cc.

79 {
80  return "RegimeSinter";
81 }
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,Tthe two species whose properties are mixed to create the new species

Definition at line 88 of file RegimeSinterSpecies.cc.

89 {
90 // adhesionForceMax_ = BaseSpecies::average(S->getAdhesionForceMax(), T->getAdhesionForceMax());
91 // adhesionStiffness_ = BaseSpecies::average(S->getAdhesionStiffness(), T->getAdhesionStiffness());
92 }
void RegimeSinterSpecies::read ( std::istream &  is)

Reads the species properties from an input stream.

Parameters
[in]isinput stream (typically the restart file)

Definition at line 68 of file RegimeSinterSpecies.cc.

69 {
70 // std::string dummy;
71 // is >> dummy >> adhesionForceMax_;
72 // is >> dummy >> adhesionStiffness_;
73 }
void RegimeSinterSpecies::write ( std::ostream &  os) const

Writes the species properties to an output stream.

Parameters
[out]osoutput stream (typically the restart file)

Definition at line 59 of file RegimeSinterSpecies.cc.

60 {
61 // os << " adhesionForceMax " << adhesionForceMax_;
62 // os << " adhesionStiffness " << adhesionStiffness_;
63 }

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