ThermalSpecies< NormalForceSpecies > Class Template Reference

#include <ThermalSpecies.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...

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]

template<class NormalForceSpecies >

ThermalSpecies< NormalForceSpecies >::ThermalSpecies

The default constructor.

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

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

ThermalSpecies() [2/2]

template<class NormalForceSpecies >

ThermalSpecies< NormalForceSpecies >::ThermalSpecies

(

const ThermalSpecies< NormalForceSpecies > &

s

)

The default copy constructor.

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

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

~ThermalSpecies()

template<class NormalForceSpecies >

ThermalSpecies< NormalForceSpecies >::~ThermalSpecies

virtual

The default destructor.

{}

Member Function Documentation

getBaseName()

template<class NormalForceSpecies >

std::string ThermalSpecies< NormalForceSpecies >::getBaseName

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

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

getHeatCapacity()

template<class NormalForceSpecies >

Mdouble ThermalSpecies< NormalForceSpecies >::getHeatCapacity

Allows heatCapacity_ to be accessed.

{
    return heatCapacity_;
}

Referenced by HeatFluidCoupledInteraction< NormalForceInteraction >::computeNormalForce(), and ThermalInteraction< NormalForceInteraction >::computeNormalForce().

getThermalConductivity()

template<class NormalForceSpecies >

Mdouble ThermalSpecies< NormalForceSpecies >::getThermalConductivity

Allows heatCapacity_ to be accessed.

{
    return thermalConductivity_;
}

Referenced by HeatFluidCoupledInteraction< NormalForceInteraction >::computeNormalForce(), and ThermalInteraction< NormalForceInteraction >::computeNormalForce().

read()

template<class NormalForceSpecies >

void ThermalSpecies< NormalForceSpecies >::read

(

std::istream &

is

)

Reads the species properties from an input stream.

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

Referenced by HeatFluidCoupledSpecies< NormalForceSpecies >::read().

setHeatCapacity()

template<class NormalForceSpecies >

void ThermalSpecies< NormalForceSpecies >::setHeatCapacity

(

Mdouble

heatCapacity

)

Allows heatCapacity_ to be changed.

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

References logger.

setThermalConductivity()

template<class NormalForceSpecies >

void ThermalSpecies< NormalForceSpecies >::setThermalConductivity

(

Mdouble

thermalConductivity

)

Allows heatCapacity_ to be changed.

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

References logger.

write()

template<class NormalForceSpecies >

void ThermalSpecies< NormalForceSpecies >::write

(

std::ostream &

os

)

const

Writes the species properties to an output stream.

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

Referenced by HeatFluidCoupledSpecies< NormalForceSpecies >::write().

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:

• ThermalInteraction.h
• ThermalSpecies.h