ThermalSpecies< NormalForceSpecies > Class Template Reference

#include <ThermalInteraction.h>

Inheritance diagram for ThermalSpecies< NormalForceSpecies >:

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...

Detailed Description

template<class NormalForceSpecies>
class ThermalSpecies< NormalForceSpecies >

Definition at line 33 of file ThermalInteraction.h.

Member Typedef Documentation

template<class NormalForceSpecies >

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

The correct Interaction type for this FrictionForceSpecies.

Definition at line 37 of file ThermalSpecies.h.

Constructor & Destructor Documentation

template<class NormalForceSpecies >

ThermalSpecies< NormalForceSpecies >::ThermalSpecies

(

)

The default constructor.

Definition at line 82 of file ThermalSpecies.h.

References ThermalSpecies< NormalForceSpecies >::heatCapacity_, and ThermalSpecies< NormalForceSpecies >::thermalConductivity_.

 : NormalForceSpecies()
{
    heatCapacity_ = 0.0;
    thermalConductivity_ = 0.0;
}

template<class NormalForceSpecies >

ThermalSpecies< NormalForceSpecies >::ThermalSpecies

(

const ThermalSpecies< NormalForceSpecies > &

s

)

The default copy constructor.

Definition at line 90 of file ThermalSpecies.h.

References ThermalSpecies< NormalForceSpecies >::heatCapacity_, and ThermalSpecies< NormalForceSpecies >::thermalConductivity_.

 : NormalForceSpecies(s)
{
    heatCapacity_=s.heatCapacity_;
    thermalConductivity_=s.thermalConductivity_;
}

template<class NormalForceSpecies >

ThermalSpecies< NormalForceSpecies >::~ThermalSpecies ( )

virtual

The default destructor.

Definition at line 98 of file ThermalSpecies.h.

{}

Member Function Documentation

template<class NormalForceSpecies >

std::string ThermalSpecies< NormalForceSpecies >::getBaseName

(

)

const

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

Definition at line 119 of file ThermalSpecies.h.

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

template<class NormalForceSpecies >

Mdouble ThermalSpecies< NormalForceSpecies >::getHeatCapacity

(

)

const

Allows heatCapacity_ to be accessed.

Definition at line 126 of file ThermalSpecies.h.

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

{
    return heatCapacity_;
}

template<class NormalForceSpecies >

Mdouble ThermalSpecies< NormalForceSpecies >::getThermalConductivity

(

)

const

Allows heatCapacity_ to be accessed.

Definition at line 141 of file ThermalSpecies.h.

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

{
    return thermalConductivity_;
}

template<class NormalForceSpecies >

void ThermalSpecies< NormalForceSpecies >::read

(

std::istream &

is

)

Reads the species properties from an input stream.

Definition at line 110 of file ThermalSpecies.h.

{
    std::string dummy;
    NormalForceSpecies::read(is);
    is >> dummy >> heatCapacity_;
    is >> dummy >> thermalConductivity_;
}

template<class NormalForceSpecies >

void ThermalSpecies< NormalForceSpecies >::setHeatCapacity

(

Mdouble

heatCapacity

)

Allows heatCapacity_ to be changed.

Definition at line 132 of file ThermalSpecies.h.

References logger.

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

template<class NormalForceSpecies >

void ThermalSpecies< NormalForceSpecies >::setThermalConductivity

(

Mdouble

thermalConductivity

)

Allows heatCapacity_ to be changed.

Definition at line 147 of file ThermalSpecies.h.

References logger.

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

template<class NormalForceSpecies >

void ThermalSpecies< NormalForceSpecies >::write

(

std::ostream &

os

)

const

Writes the species properties to an output stream.

Definition at line 102 of file ThermalSpecies.h.

{
    NormalForceSpecies::write(os);
    os << " heatCapacity " << heatCapacity_;
    os << " thermalConductivity " << thermalConductivity_;
}

Member Data Documentation

template<class NormalForceSpecies >

Mdouble ThermalSpecies< NormalForceSpecies >::heatCapacity_

private

The heat capacity.

Definition at line 73 of file ThermalSpecies.h.

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

template<class NormalForceSpecies >

Mdouble ThermalSpecies< NormalForceSpecies >::thermalConductivity_

private

The thermal conductivity.

Definition at line 78 of file ThermalSpecies.h.

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

---

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

• Interactions/NormalForceInteractions/ThermalInteraction.h
• Species/NormalForceSpecies/ThermalSpecies.h