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.

Member Typedef Documentation

◆ InteractionType

The correct Interaction type for this AdhesiveForceSpecies.

Constructor & Destructor Documentation

◆ RegimeSinterSpecies() [1/2]

RegimeSinterSpecies::RegimeSinterSpecies ( )

The default constructor.

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

◆ RegimeSinterSpecies() [2/2]

RegimeSinterSpecies::RegimeSinterSpecies ( const RegimeSinterSpecies s)

The default constructor.

Parameters
[in]sthe species that is copied
42 {
43 
44 #ifdef DEBUG_CONSTRUCTOR
45  std::cout<<"RegimeSinterSpecies::RegimeSinterSpecies(const RegimeSinterSpecies &p) finished"<<std::endl;
46 #endif
47 }

◆ ~RegimeSinterSpecies()

RegimeSinterSpecies::~RegimeSinterSpecies ( )

The default constructor.

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

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")
79 {
80  return "RegimeSinter";
81 }

◆ 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,Tthe two species whose properties are mixed to create the new species
89 {
90 // adhesionForceMax_ = BaseSpecies::average(S->getAdhesionForceMax(), T->getAdhesionForceMax());
91 // adhesionStiffness_ = BaseSpecies::average(S->getAdhesionStiffness(), T->getAdhesionStiffness());
92 }

◆ read()

void RegimeSinterSpecies::read ( std::istream &  is)

Reads the species properties from an input stream.

Parameters
[in]isinput stream (typically the restart file)
69 {
70 // std::string dummy;
71 // is >> dummy >> adhesionForceMax_;
72 // is >> dummy >> adhesionStiffness_;
73 }

◆ write()

void RegimeSinterSpecies::write ( std::ostream &  os) const

Writes the species properties to an output stream.

Parameters
[out]osoutput stream (typically the restart file)
60 {
61 // os << " adhesionForceMax " << adhesionForceMax_;
62 // os << " adhesionStiffness " << adhesionStiffness_;
63 }

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