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

void	actionsAfterTimeStep (BaseParticle *particle) const override
	Computes the heat transfer rate (. 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...

Mdouble	getAmbientTemperature () const

void	setAmbientTemperature (Mdouble ambientTemperature)

Vec3D	getAmbientVelocity () const
	Allows ambientVelocity_ to be accessed. More...

void	setAmbientVelocity (Vec3D ambientVelocity)
	Allows ambientVelocity_ to be changed. More...

Mdouble	getAmbientThermalConductivity () const
	Allows ambientThermalConductivity_ to be accessed. More...

void	setAmbientThermalConductivity (Mdouble ambientThermalConductivity)
	Allows ambientThermalConductivity_ to be changed. More...

Mdouble	getAmbientDynamicViscosity () const
	Allows ambientDynamicViscosity_ to be accessed. More...

void	setAmbientDynamicViscosity (Mdouble ambientDynamicViscosity)
	Allows ambientDynamicViscosity_ to be changed. More...

Mdouble	getAmbientHeatCapacity () const
	Allows ambientHeatCapacity_ to be accessed. More...

void	setAmbientHeatCapacity (Mdouble ambientHeatCapacity)
	Allows ambientHeatCapacity_ to be changed. More...

Mdouble	getAmbientDensity () const
	Allows ambientDensity_ to be accessed. More...

void	setAmbientDensity (Mdouble ambientDensity)
	Allows ambientDensity_ to be changed. More...

Private Attributes
Mdouble	heatCapacity_
	The specific heat capacity of the particle/wall. More...

Mdouble	thermalConductivity_
	The thermal conductivity of the particle/wall. More...

Mdouble	ambientTemperature_
	The ambient temperature (K). More...

Vec3D	ambientVelocity_
	The velocity of the ambient fluid (m/s). More...

double	ambientThermalConductivity_
	The thermal conductivity of the ambient fluid (W/m/K). More...

double	ambientDynamicViscosity_
	The dynamic viscosity of the ambient fluid (kg/m/s=Pa.s). More...

double	ambientHeatCapacity_
	The specific heat capacity of the ambient fluid (J/kg/K). More...

double	ambientDensity_
	The density of the ambient fluid (kg/m^3). 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;
     ambientTemperature_=0.0;
     ambientVelocity_ = {0,0,0};
     ambientThermalConductivity_ = 0.0;
     ambientDynamicViscosity_ = 0.0;
     ambientHeatCapacity_ = 0.0;
     ambientDensity_ = 0.0;
 }

References ThermalSpecies< NormalForceSpecies >::ambientDensity_, ThermalSpecies< NormalForceSpecies >::ambientDynamicViscosity_, ThermalSpecies< NormalForceSpecies >::ambientHeatCapacity_, ThermalSpecies< NormalForceSpecies >::ambientTemperature_, ThermalSpecies< NormalForceSpecies >::ambientThermalConductivity_, ThermalSpecies< NormalForceSpecies >::ambientVelocity_, 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_;
     ambientTemperature_=s.ambientTemperature_;
     ambientVelocity_ = s.ambientVelocity_;
     ambientThermalConductivity_ = s.ambientThermalConductivity_;
     ambientDynamicViscosity_ = s.ambientDynamicViscosity_;
     ambientHeatCapacity_ = s.ambientHeatCapacity_;
     ambientDensity_ = s.ambientDensity_;
 }

References ThermalSpecies< NormalForceSpecies >::ambientDensity_, ThermalSpecies< NormalForceSpecies >::ambientDynamicViscosity_, ThermalSpecies< NormalForceSpecies >::ambientHeatCapacity_, ThermalSpecies< NormalForceSpecies >::ambientTemperature_, ThermalSpecies< NormalForceSpecies >::ambientThermalConductivity_, ThermalSpecies< NormalForceSpecies >::ambientVelocity_, ThermalSpecies< NormalForceSpecies >::heatCapacity_, s, and ThermalSpecies< NormalForceSpecies >::thermalConductivity_.

◆ ~ThermalSpecies()

template<class NormalForceSpecies >

ThermalSpecies< NormalForceSpecies >::~ThermalSpecies

virtual

The default destructor.

193 {}

Member Function Documentation

◆ actionsAfterTimeStep()

template<class NormalForceSpecies >

void ThermalSpecies< NormalForceSpecies >::actionsAfterTimeStep ( BaseParticle * particle ) const

override

Computes the heat transfer rate (.

Q) to to convective heat transfer with the ambience

◆ getAmbientDensity()

template<class NormalForceSpecies >

Mdouble ThermalSpecies< NormalForceSpecies >::getAmbientDensity ( ) const

inline

Allows ambientDensity_ to be accessed.

                                       {
         return ambientDensity_;
     }

References ThermalSpecies< NormalForceSpecies >::ambientDensity_.

◆ getAmbientDynamicViscosity()

template<class NormalForceSpecies >

Mdouble ThermalSpecies< NormalForceSpecies >::getAmbientDynamicViscosity ( ) const

inline

Allows ambientDynamicViscosity_ to be accessed.

                                                {
         return ambientDynamicViscosity_;
     }

References ThermalSpecies< NormalForceSpecies >::ambientDynamicViscosity_.

◆ getAmbientHeatCapacity()

template<class NormalForceSpecies >

Mdouble ThermalSpecies< NormalForceSpecies >::getAmbientHeatCapacity ( ) const

inline

Allows ambientHeatCapacity_ to be accessed.

                                            {
         return ambientHeatCapacity_;
     }

References ThermalSpecies< NormalForceSpecies >::ambientHeatCapacity_.

◆ getAmbientTemperature()

template<class NormalForceSpecies >

Mdouble ThermalSpecies< NormalForceSpecies >::getAmbientTemperature ( ) const

inline

     {
         return ambientTemperature_;
     }

References ThermalSpecies< NormalForceSpecies >::ambientTemperature_.

◆ getAmbientThermalConductivity()

template<class NormalForceSpecies >

Mdouble ThermalSpecies< NormalForceSpecies >::getAmbientThermalConductivity ( ) const

inline

Allows ambientThermalConductivity_ to be accessed.

                                                   {
         return ambientThermalConductivity_;
     }

References ThermalSpecies< NormalForceSpecies >::ambientThermalConductivity_.

◆ getAmbientVelocity()

template<class NormalForceSpecies >

Vec3D ThermalSpecies< NormalForceSpecies >::getAmbientVelocity ( ) const

inline

Allows ambientVelocity_ to be accessed.

                                      {
         return ambientVelocity_;
     }

References ThermalSpecies< NormalForceSpecies >::ambientVelocity_.

◆ 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(), ThermalInteraction< NormalForceInteraction >::computeNormalForce(), and DropletBoundary::getSpeciesHeatCapacity().

◆ 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_;
     helpers::readOptionalVariable<Mdouble>(is, "ambientTemperature", ambientTemperature_);
     helpers::readOptionalVariable<Vec3D>(is, "ambientVelocity", ambientVelocity_);
     helpers::readOptionalVariable<Mdouble>(is, "ambientThermalConductivity", ambientThermalConductivity_);
     helpers::readOptionalVariable<Mdouble>(is, "ambientDynamicViscosity", ambientDynamicViscosity_);
     helpers::readOptionalVariable<Mdouble>(is, "ambientHeatCapacity", ambientHeatCapacity_);
     helpers::readOptionalVariable<Mdouble>(is, "ambientDensity", ambientDensity_);
 }

References Eigen::TensorSycl::internal::read(), and oomph::Global_string_for_annotation::string().

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

◆ setAmbientDensity()

template<class NormalForceSpecies >

void ThermalSpecies< NormalForceSpecies >::setAmbientDensity ( Mdouble ambientDensity )

inline

Allows ambientDensity_ to be changed.

                                                    {
         logger.assert_always(ambientDensity>0,"ambientDensity has to be positive");
         ambientDensity_ = ambientDensity;
     }

References ThermalSpecies< NormalForceSpecies >::ambientDensity_, and logger.

◆ setAmbientDynamicViscosity()

template<class NormalForceSpecies >

void ThermalSpecies< NormalForceSpecies >::setAmbientDynamicViscosity ( Mdouble ambientDynamicViscosity )

inline

Allows ambientDynamicViscosity_ to be changed.

                                                                      {
         logger.assert_always(ambientDynamicViscosity>0,"ambientDynamicViscosity has to be positive");
         ambientDynamicViscosity_ = ambientDynamicViscosity;
     }

References ThermalSpecies< NormalForceSpecies >::ambientDynamicViscosity_, and logger.

◆ setAmbientHeatCapacity()

template<class NormalForceSpecies >

void ThermalSpecies< NormalForceSpecies >::setAmbientHeatCapacity ( Mdouble ambientHeatCapacity )

inline

Allows ambientHeatCapacity_ to be changed.

                                                              {
         logger.assert_always(ambientHeatCapacity>0,"ambientHeatCapacity has to be positive");
         ambientHeatCapacity_ = ambientHeatCapacity;
     }

References ThermalSpecies< NormalForceSpecies >::ambientHeatCapacity_, and logger.

◆ setAmbientTemperature()

template<class NormalForceSpecies >

void ThermalSpecies< NormalForceSpecies >::setAmbientTemperature ( Mdouble ambientTemperature )

inline

     {
         logger.assert_always(ambientTemperature >= 0,"ambientTemperature cannot be negative");
         ambientTemperature_ = ambientTemperature;
     }

References ThermalSpecies< NormalForceSpecies >::ambientTemperature_, and logger.

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

◆ setAmbientThermalConductivity()

template<class NormalForceSpecies >

void ThermalSpecies< NormalForceSpecies >::setAmbientThermalConductivity ( Mdouble ambientThermalConductivity )

inline

Allows ambientThermalConductivity_ to be changed.

                                                                            {
         logger.assert_always(ambientThermalConductivity>0,"ambientThermalConductivity has to be positive");
         ambientThermalConductivity_ = ambientThermalConductivity;
     }

References ThermalSpecies< NormalForceSpecies >::ambientThermalConductivity_, and logger.

◆ setAmbientVelocity()

template<class NormalForceSpecies >

void ThermalSpecies< NormalForceSpecies >::setAmbientVelocity ( Vec3D ambientVelocity )

inline

Allows ambientVelocity_ to be changed.

                                                    {
         ambientVelocity_ = ambientVelocity;
     }

References ThermalSpecies< NormalForceSpecies >::ambientVelocity_.

◆ 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_;
     os << " ambientTemperature " << ambientTemperature_;
     os << " ambientVelocity " << ambientVelocity_;
     os << " ambientThermalConductivity " << ambientThermalConductivity_;
     os << " ambientDynamicViscosity " << ambientDynamicViscosity_;
     os << " ambientHeatCapacity " << ambientHeatCapacity_;
     os << " ambientDensity " << ambientDensity_;
 }