revision: v0.14
ThermalSpecies< NormalForceSpecies > Class Template Reference

#include <ThermalSpecies.h>

Public Types

typedef ThermalInteraction< typename NormalForceSpecies::InteractionType > InteractionType
 The correct Interaction type for this FrictionForceSpecies. More...
 

Public Member Functions

 ThermalSpecies ()
 The default constructor. More...
 
 ThermalSpecies (const ThermalSpecies &s)
 The default copy constructor. More...
 
virtual ~ThermalSpecies ()
 The default destructor. More...
 
void write (std::ostream &os) const
 Writes the species properties to an output stream. More...
 
void read (std::istream &is)
 Reads the species properties from an input stream. More...
 
std::string getBaseName () const
 Used in Species::getName to obtain a unique name for each Species. More...
 
Mdouble getHeatCapacity () const
 Allows heatCapacity_ to be accessed. More...
 
void setHeatCapacity (Mdouble heatCapacity)
 Allows heatCapacity_ to be changed. More...
 
Mdouble getThermalConductivity () const
 Allows heatCapacity_ to be accessed. More...
 
void setThermalConductivity (Mdouble thermalConductivity)
 Allows heatCapacity_ to be changed. More...
 

Private Attributes

Mdouble heatCapacity_
 The heat capacity. More...
 
Mdouble thermalConductivity_
 The thermal conductivity. More...
 

Member Typedef Documentation

◆ InteractionType

template<class NormalForceSpecies >
typedef ThermalInteraction<typename NormalForceSpecies::InteractionType> ThermalSpecies< NormalForceSpecies >::InteractionType

The correct Interaction type for this FrictionForceSpecies.

Constructor & Destructor Documentation

◆ ThermalSpecies() [1/2]

◆ ThermalSpecies() [2/2]

◆ ~ThermalSpecies()

template<class NormalForceSpecies >
ThermalSpecies< NormalForceSpecies >::~ThermalSpecies
virtual

The default destructor.

101 {}

Member Function Documentation

◆ getBaseName()

template<class NormalForceSpecies >
std::string ThermalSpecies< NormalForceSpecies >::getBaseName

Used in Species::getName to obtain a unique name for each Species.

122 {
123  return "Thermal" + NormalForceSpecies::getBaseName();
124 }

◆ getHeatCapacity()

template<class NormalForceSpecies >
Mdouble ThermalSpecies< NormalForceSpecies >::getHeatCapacity

Allows heatCapacity_ to be accessed.

129 {
130  return heatCapacity_;
131 }

Referenced by ThermalInteraction< NormalForceInteraction >::computeNormalForce().

◆ getThermalConductivity()

template<class NormalForceSpecies >
Mdouble ThermalSpecies< NormalForceSpecies >::getThermalConductivity

Allows heatCapacity_ to be accessed.

144 {
145  return thermalConductivity_;
146 }

Referenced by ThermalInteraction< NormalForceInteraction >::computeNormalForce().

◆ read()

template<class NormalForceSpecies >
void ThermalSpecies< NormalForceSpecies >::read ( std::istream &  is)

Reads the species properties from an input stream.

113 {
114  std::string dummy;
115  NormalForceSpecies::read(is);
116  is >> dummy >> heatCapacity_;
117  is >> dummy >> thermalConductivity_;
118 }

◆ setHeatCapacity()

template<class NormalForceSpecies >
void ThermalSpecies< NormalForceSpecies >::setHeatCapacity ( Mdouble  heatCapacity)

Allows heatCapacity_ to be changed.

135 {
136  logger.assert_always(heatCapacity > 0,
137  "[ThermalSpecies<>::setHeatCapacity(%)] value has to be positive",
138  heatCapacity);
139  heatCapacity_ = heatCapacity;
140 }

References logger.

◆ setThermalConductivity()

template<class NormalForceSpecies >
void ThermalSpecies< NormalForceSpecies >::setThermalConductivity ( Mdouble  thermalConductivity)

Allows heatCapacity_ to be changed.

150 {
151  logger.assert_always(thermalConductivity >= 0,
152  "[ThermalSpecies<>::setThermalConductivity(%)] value has to be positive",
153  thermalConductivity);
154  thermalConductivity_ = thermalConductivity;
155 }

References logger.

◆ write()

template<class NormalForceSpecies >
void ThermalSpecies< NormalForceSpecies >::write ( std::ostream &  os) const

Writes the species properties to an output stream.

105 {
106  NormalForceSpecies::write(os);
107  os << " heatCapacity " << heatCapacity_;
108  os << " thermalConductivity " << thermalConductivity_;
109 }

Member Data Documentation

◆ heatCapacity_

template<class NormalForceSpecies >
Mdouble ThermalSpecies< NormalForceSpecies >::heatCapacity_
private

The heat capacity.

Referenced by ThermalSpecies< NormalForceSpecies >::ThermalSpecies().

◆ thermalConductivity_

template<class NormalForceSpecies >
Mdouble ThermalSpecies< NormalForceSpecies >::thermalConductivity_
private

The thermal conductivity.

Referenced by ThermalSpecies< NormalForceSpecies >::ThermalSpecies().


The documentation for this class was generated from the following files:
logger
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
Definition of different loggers with certain modules. A user can define its own custom logger here.
NormalForceSpecies
Defines a contact force parallel to the contact normal.
ThermalSpecies::thermalConductivity_
Mdouble thermalConductivity_
The thermal conductivity.
Definition: ThermalSpecies.h:80
ThermalSpecies::heatCapacity_
Mdouble heatCapacity_
The heat capacity.
Definition: ThermalSpecies.h:75