Species for the HeatFluidCoupledParticle. More...

#include <HeatFluidCoupledSpecies.h>

Inheritance diagram for HeatFluidCoupledSpecies< NormalForceSpecies >:

Public Types
typedef HeatFluidCoupledInteraction< typename NormalForceSpecies::InteractionType >	InteractionType

Public Types inherited from ThermalSpecies< NormalForceSpecies >
typedef ThermalInteraction< typename NormalForceSpecies::InteractionType >	InteractionType
	The correct Interaction type for this FrictionForceSpecies. More...

Public Member Functions
	HeatFluidCoupledSpecies ()
	The default constructor. More...

	HeatFluidCoupledSpecies (const HeatFluidCoupledSpecies &s)
	The default copy constructor. More...

virtual	~HeatFluidCoupledSpecies ()
	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	getMassTransferCoefficient () const
	Allows massTransferCoefficient_ to be accessed. More...

void	setMassTransferCoefficient (Mdouble massTransferCoefficient)
	Allows massTransferCoefficient_ to be changed. More...

Mdouble	getLatentHeatVaporization () const
	Allows latentHeatVaporization_ to be accessed. More...

void	setLatentHeatVaporization (Mdouble latentHeatVaporization)
	Allows latentHeatVaporization_ to be changed. More...

Mdouble	getLiquidDensity () const
	Allows liquidDensity_ to be accessed. More...

void	setLiquidDensity (Mdouble liquidDensity)
	Allows liquidDensity_ to be changed. More...

Mdouble	getEvaporationCoefficientA () const
	Allows evaporationCoefficientA_ to be accessed. More...

void	setEvaporationCoefficientA (Mdouble evaporationCoefficientA)
	Allows evaporationCoefficientA_ to be changed. More...

Mdouble	getEvaporationCoefficientB () const
	Allows evaporationCoefficientB_ to be accessed. More...

void	setEvaporationCoefficientB (Mdouble evaporationCoefficientB)
	Allows evaporationCoefficientB_ to be changed. More...

Mdouble	getAmbientHumidity () const
	Allows ambientHumidity_ to be accessed. More...

void	setAmbientHumidity (Mdouble ambientHumidity)
	Allows ambientHumidity_ to be changed. More...

Mdouble	getAmbientEquilibriumMoistureContent () const
	Allows ambientEquilibriumMoistureContent_ to be accessed. More...

void	setAmbientEquilibriumMoistureContent (Mdouble ambientEquilibriumMoistureContent)
	Allows ambientEquilibriumMoistureContent_ to be changed. More...

Mdouble	getAmbientVapourConcentration () const
	Allows ambientVapourConcentration_ to be accessed. More...

void	setAmbientVapourConcentration (Mdouble ambientVapourConcentration)
	Allows ambientVapourConcentration_ to be changed. More...

Mdouble	getAmbientTemperature () const
	Allows ambientTemperature_ to be accessed. More...

void	setAmbientTemperature (Mdouble ambientTemperature)
	Allows ambientTemperature_ to be changed. More...

void	actionsAfterTimeStep (BaseParticle *particle) const override

std::array< double, 2 >	f (double liquidVolume, double temperature, double mass, double surfaceArea) const
	f1 is used in Runge–Kutta method. More...

Public Member Functions inherited from ThermalSpecies< NormalForceSpecies >
	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	massTransferCoefficient_
	The mass transfer rate (m/s) More...

Mdouble	latentHeatVaporization_
	The latent heat of vaporization (J/kg) More...

Mdouble	liquidDensity_
	The liquid density (kg/m^3) More...

Mdouble	evaporationCoefficientA_
	The evaporation coefficient a (dimensionless) More...

Mdouble	evaporationCoefficientB_
	The evaporation coefficient b (dimensionless) More...

Mdouble	ambientHumidity_
	The ambient humidity (dimensionless, between 0 and 1, but cannot be 0) More...

Mdouble	ambientEquilibriumMoistureContent_
	The ambient equilibrium moisture content (dimensionless, between 0 and 1). More...

Mdouble	ambientVapourConcentration_
	The ambient vapour concentration (kg/m^3). More...

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

Detailed Description

template<class NormalForceSpecies>
class HeatFluidCoupledSpecies< NormalForceSpecies >

Species for the HeatFluidCoupledParticle.

Member Typedef Documentation

◆ InteractionType

template<class NormalForceSpecies >

typedef HeatFluidCoupledInteraction<typename NormalForceSpecies::InteractionType> HeatFluidCoupledSpecies< NormalForceSpecies >::InteractionType

Constructor & Destructor Documentation

◆ HeatFluidCoupledSpecies() [1/2]

template<class NormalForceSpecies >

HeatFluidCoupledSpecies< NormalForceSpecies >::HeatFluidCoupledSpecies

The default constructor.

         : ThermalSpecies<NormalForceSpecies>()
 {
     massTransferCoefficient_=0.0;
     latentHeatVaporization_=0.0;
     liquidDensity_=1.0;
     evaporationCoefficientA_=0.0;
     evaporationCoefficientB_=0.0;
     // note, this default value is unrealistically high; 0.3 is realistic.
     ambientHumidity_=1.0;
     ambientEquilibriumMoistureContent_=0.0;
     ambientVapourConcentration_=0.0;
     ambientTemperature_=0.0;
 }

◆ HeatFluidCoupledSpecies() [2/2]

template<class NormalForceSpecies >

HeatFluidCoupledSpecies< NormalForceSpecies >::HeatFluidCoupledSpecies ( const HeatFluidCoupledSpecies< NormalForceSpecies > & s )

The default copy constructor.

         : ThermalSpecies<NormalForceSpecies>(s)
 {
     massTransferCoefficient_= s.massTransferCoefficient_;
     latentHeatVaporization_= s.latentHeatVaporization_;
     liquidDensity_=s.liquidDensity_;
     evaporationCoefficientA_=s.evaporationCoefficientA_;
     evaporationCoefficientB_=s.evaporationCoefficientB_;
     ambientHumidity_=s.ambientHumidity_;
     ambientEquilibriumMoistureContent_=s.ambientEquilibriumMoistureContent_;
     ambientVapourConcentration_=s.ambientVapourConcentration_;
     ambientTemperature_=s.ambientTemperature_;
 }

◆ ~HeatFluidCoupledSpecies()

template<class NormalForceSpecies >

HeatFluidCoupledSpecies< NormalForceSpecies >::~HeatFluidCoupledSpecies

virtual

The default destructor.

199 {}

Member Function Documentation

◆ actionsAfterTimeStep()

template<class NormalForceSpecies >

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

override

 {
     double dt = baseParticle->getHandler()->getDPMBase()->getTimeStep();
     auto p = dynamic_cast<HeatFluidCoupledParticle*>(baseParticle);
     double mass = p->getMass();
     double surfaceArea = p->getSurfaceArea();
     //Runge–Kutta method
     std::array<double,2> k1 = f(p->getLiquidVolume(),p->getTemperature(), mass, surfaceArea);
     //logger(INFO, "dL % dT %", k1[0], k1[1]);
     std::array<double,2> k2 = f(p->getLiquidVolume()+dt*0.5*k1[0],p->getTemperature()+dt*0.5*k1[1], mass, surfaceArea);
     std::array<double,2> k3 = f(p->getLiquidVolume()+dt*0.5*k2[0],p->getTemperature()+dt*0.5*k2[1], mass, surfaceArea);
     std::array<double,2> k4 = f(p->getLiquidVolume()+dt*k3[0],p->getTemperature()+dt*k3[1], mass, surfaceArea);
     double dliquidVolume = dt*(k1[0]+2*k2[0]+2*k3[0]+k4[0])/6.0;
     double dTemperature = dt*(k1[1]+2*k2[1]+2*k3[1]+k4[1])/6.0;
     // if liquid film volume is larger than the volume that needs to be subtracted
     if (p->getLiquidVolume()+dliquidVolume>=0.0) {
         p->setLiquidVolume(p->getLiquidVolume()+dliquidVolume);
         p->setTemperature(std::max(0.0,p->getTemperature()+dTemperature));
         //logger(INFO,"% LF % T %", p->getIndex(), p->getLiquidVolume(), p->getTemperature());
     } else {
         // how much to remove from liquid bridges
         double liquidVolumeToDistribute = - (p->getLiquidVolume()+dliquidVolume);
         p->setLiquidVolume(0.0);
         // get liquid bridge volume
         double liquidBridgeVolume = 0.0;
         for (BaseInteraction* i : p-> getInteractions()) {
             auto j = dynamic_cast<LiquidMigrationWilletInteraction*>(i);
             liquidBridgeVolume += j->getLiquidBridgeVolume();
         }
         // if liquid bridge volume is larger than the volume that needs to be subtracted
         if (liquidVolumeToDistribute<=liquidBridgeVolume) {
             double factor = 1.0-liquidVolumeToDistribute/liquidBridgeVolume;
             for (BaseInteraction* i : p-> getInteractions()) {
                 auto j = dynamic_cast<LiquidMigrationWilletInteraction*>(i);
                 j->setLiquidBridgeVolume(factor*j->getLiquidBridgeVolume());
             }
             p->setTemperature(std::max(0.0,p->getTemperature()+dTemperature));
         } else {
             // if both liquid bridges and liquid films are empty after the subtraction
             if (liquidBridgeVolume!=0.0) {
                 liquidVolumeToDistribute -= liquidBridgeVolume;
                 for (BaseInteraction *i: p->getInteractions()) {
                     auto j = dynamic_cast<LiquidMigrationWilletInteraction *>(i);
                     j->setLiquidBridgeVolume(0.0);
                 }
             }
             double factor = 1.0+liquidVolumeToDistribute/dliquidVolume;
             p->setTemperature(std::max(0.0,p->getTemperature()+factor*dTemperature));
         }
     }
 }

References BaseHandler< T >::getDPMBase(), BaseParticle::getHandler(), DPMBase::getTimeStep(), constants::i, and LiquidMigrationWilletInteraction::setLiquidBridgeVolume().

◆ f()

template<class NormalForceSpecies >

std::array< double, 2 > HeatFluidCoupledSpecies< NormalForceSpecies >::f	(	double	liquidVolume_,
		double	temperature_,
		double	mass,
		double	surfaceArea
	)		const

f1 is used in Runge–Kutta method.

Computes the drying and cooling rate of a particle; based on equations in (Azmir et al., 2018), which are summarised in EvaporationModel.pdf

Parameters

liquidVolume_	Liquid film volume
temperature_	Temperature of particle
mass	Mass of particle
surfaceArea	Surface area of particle

Returns

                                                                                                                                                  {
     // Saturated vapour concentration  (kg/m^3), eq(7)
     // Dependency on temperature is valid between 1 and 200 degree Celsius
     // (it is unphysically decreasing between 0 and 1 degree),
     // extrapolated as linear functions
     double dT = temperature_-273;
     double saturatedVapourConcentration = dT < 1 ? 8.319815774e-3*temperature_/274 :
                                           (((4.844e-9*dT-1.4807e-7)*dT+2.6572e-5)*dT-4.8613e-5)*dT+8.342e-3;
  
     // Relative activation energy of evaporation, eq(6)
     double equilibriumActivationEnergy=-constants::R*getAmbientTemperature()*log(getAmbientHumidity());
     // \todo what is the difference between the variable X and Y in Azmir?
     double moistureContent = liquidVolume_*getLiquidDensity()/mass;
     double activationEnergy=equilibriumActivationEnergy*(moistureContent-getAmbientEquilibriumMoistureContent());
  
     // Vapour concentrations at the particle-medium interface (kg/m^3), eq(5)
     // Implemented such that the code does not necessarily fail if temperature is 0
     double interfaceVapourConcentration = temperature_==0?0.0:
                                           exp(-activationEnergy/(constants::R*temperature_))*saturatedVapourConcentration;
  
     // Drying rate of liquid film mass (kg/s), eq (4)
     double dLiquidMass=-getMassTransferCoefficient()*surfaceArea
                        *(interfaceVapourConcentration-getAmbientVapourConcentration());
  
     // Drying rate of liquid film volume (kg/s), eq (3)
     double dLiquidVolume = dLiquidMass/getLiquidDensity();
  
     // Heat of evaporation (J/s), eq (2)
     double heatOfEvaporation = getLatentHeatVaporization()*(1.0+getEvaporationCoefficientA()*exp((getEvaporationCoefficientB()*getLiquidDensity()/mass)*liquidVolume_))*dLiquidMass;
  
     // Cooling rate of particle (K/s), eq (1)
     double dTemperature = heatOfEvaporation / (mass * this->getHeatCapacity());
  
     return {dLiquidVolume, dTemperature};
 }

References mathsFunc::exp(), mathsFunc::log(), and constants::R.

◆ getAmbientEquilibriumMoistureContent()

template<class NormalForceSpecies >

Mdouble HeatFluidCoupledSpecies< NormalForceSpecies >::getAmbientEquilibriumMoistureContent

Allows ambientEquilibriumMoistureContent_ to be accessed.

 {
     return ambientEquilibriumMoistureContent_;
 }

◆ getAmbientHumidity()

template<class NormalForceSpecies >

Mdouble HeatFluidCoupledSpecies< NormalForceSpecies >::getAmbientHumidity

Allows ambientHumidity_ to be accessed.

 {
     return ambientHumidity_;
 }

◆ getAmbientTemperature()

template<class NormalForceSpecies >

Mdouble HeatFluidCoupledSpecies< NormalForceSpecies >::getAmbientTemperature

Allows ambientTemperature_ to be accessed.

 {
     return ambientTemperature_;
 }

◆ getAmbientVapourConcentration()

template<class NormalForceSpecies >

Mdouble HeatFluidCoupledSpecies< NormalForceSpecies >::getAmbientVapourConcentration

Allows ambientVapourConcentration_ to be accessed.

 {
     return ambientVapourConcentration_;
 }

◆ getBaseName()

template<class NormalForceSpecies >

std::string HeatFluidCoupledSpecies< NormalForceSpecies >::getBaseName

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

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

◆ getEvaporationCoefficientA()

template<class NormalForceSpecies >

Mdouble HeatFluidCoupledSpecies< NormalForceSpecies >::getEvaporationCoefficientA

Allows evaporationCoefficientA_ to be accessed.

 {
     return evaporationCoefficientA_;
 }

◆ getEvaporationCoefficientB()

template<class NormalForceSpecies >

Mdouble HeatFluidCoupledSpecies< NormalForceSpecies >::getEvaporationCoefficientB

Allows evaporationCoefficientB_ to be accessed.

 {
     return evaporationCoefficientB_;
 }

◆ getLatentHeatVaporization()

template<class NormalForceSpecies >

Mdouble HeatFluidCoupledSpecies< NormalForceSpecies >::getLatentHeatVaporization

Allows latentHeatVaporization_ to be accessed.

 {
     return latentHeatVaporization_;
 }

◆ getLiquidDensity()

template<class NormalForceSpecies >

Mdouble HeatFluidCoupledSpecies< NormalForceSpecies >::getLiquidDensity

Allows liquidDensity_ to be accessed.

 {
     return liquidDensity_;
 }

◆ getMassTransferCoefficient()

template<class NormalForceSpecies >

Mdouble HeatFluidCoupledSpecies< NormalForceSpecies >::getMassTransferCoefficient

Allows massTransferCoefficient_ to be accessed.

 {
     return massTransferCoefficient_;
 }

◆ read()

template<class NormalForceSpecies >

void HeatFluidCoupledSpecies< NormalForceSpecies >::read ( std::istream & is )

Reads the species properties from an input stream.

 {
     std::string dummy;
     ThermalSpecies<NormalForceSpecies>::read(is);
     is >> dummy >> massTransferCoefficient_;
     is >> dummy >> latentHeatVaporization_;
     is >> dummy >> liquidDensity_;
     is >> dummy >> evaporationCoefficientA_;
     is >> dummy >> evaporationCoefficientB_;
     is >> dummy >> ambientHumidity_;
     is >> dummy >> ambientEquilibriumMoistureContent_;
     is >> dummy >> ambientVapourConcentration_;
     is >> dummy >> ambientTemperature_;
 }

References ThermalSpecies< NormalForceSpecies >::read().

◆ setAmbientEquilibriumMoistureContent()

template<class NormalForceSpecies >

void HeatFluidCoupledSpecies< NormalForceSpecies >::setAmbientEquilibriumMoistureContent ( Mdouble ambientEquilibriumMoistureContent )

Allows ambientEquilibriumMoistureContent_ to be changed.

 {
     logger.assert_always(ambientEquilibriumMoistureContent >= 0,
                          "[HeatFluidCoupledSpecies<>::setAmbientEquilibriumMoistureContent(%)] value has to be positive",
                          ambientEquilibriumMoistureContent);
     ambientEquilibriumMoistureContent_ = ambientEquilibriumMoistureContent;
 }

References logger.

◆ setAmbientHumidity()

template<class NormalForceSpecies >

void HeatFluidCoupledSpecies< NormalForceSpecies >::setAmbientHumidity ( Mdouble ambientHumidity )

Allows ambientHumidity_ to be changed.

 {
     //note, this is not allowed to be zero!
     logger.assert_always(ambientHumidity > 0,
                          "[HeatFluidCoupledSpecies<>::setAmbientHumidity(%)] value has to be positive",
                          ambientHumidity);
     ambientHumidity_ = ambientHumidity;
 }

References logger.

◆ setAmbientTemperature()

template<class NormalForceSpecies >

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

Allows ambientTemperature_ to be changed.

 {
     logger.assert_always(ambientTemperature > 0,
                          "[HeatFluidCoupledSpecies<>::setAmbientTemperature(%)] value has to be positive",
                          ambientTemperature);
     ambientTemperature_ = ambientTemperature;
 }

References logger.

◆ setAmbientVapourConcentration()

template<class NormalForceSpecies >

void HeatFluidCoupledSpecies< NormalForceSpecies >::setAmbientVapourConcentration ( Mdouble ambientVapourConcentration )

Allows ambientVapourConcentration_ to be changed.

 {
     logger.assert_always(ambientVapourConcentration >= 0,
                          "[HeatFluidCoupledSpecies<>::setAmbientVapourConcentration(%)] value has to be positive",
                          ambientVapourConcentration);
     ambientVapourConcentration_ = ambientVapourConcentration;
 }

References logger.

◆ setEvaporationCoefficientA()

template<class NormalForceSpecies >

void HeatFluidCoupledSpecies< NormalForceSpecies >::setEvaporationCoefficientA ( Mdouble evaporationCoefficientA )

Allows evaporationCoefficientA_ to be changed.

 {
     logger.assert_always(evaporationCoefficientA >= 0,
                          "[HeatFluidCoupledSpecies<>::setEvaporationCoefficientA(%)] value has to be positive",
                          evaporationCoefficientA);
     evaporationCoefficientA_ = evaporationCoefficientA;
 }

References logger.

◆ setEvaporationCoefficientB()

template<class NormalForceSpecies >

void HeatFluidCoupledSpecies< NormalForceSpecies >::setEvaporationCoefficientB ( Mdouble evaporationCoefficientB )

Allows evaporationCoefficientB_ to be changed.

 {
     logger.assert_always(evaporationCoefficientB <= 0,
                          "[HeatFluidCoupledSpecies<>::setEvaporationCoefficientB(%)] value has to be negative",
                          evaporationCoefficientB);
     evaporationCoefficientB_ = evaporationCoefficientB;
 }

References logger.

◆ setLatentHeatVaporization()

template<class NormalForceSpecies >

void HeatFluidCoupledSpecies< NormalForceSpecies >::setLatentHeatVaporization ( Mdouble latentHeatVaporization )

Allows latentHeatVaporization_ to be changed.

 {
     logger.assert_always(latentHeatVaporization > 0,
                          "[HeatFluidCoupledSpecies<>::setLatentHeatVaporization(%)] value has to be positive",
                          latentHeatVaporization);
     latentHeatVaporization_ = latentHeatVaporization;
 }

References logger.

◆ setLiquidDensity()

template<class NormalForceSpecies >

void HeatFluidCoupledSpecies< NormalForceSpecies >::setLiquidDensity ( Mdouble liquidDensity )

Allows liquidDensity_ to be changed.

 {
     logger.assert_always(liquidDensity > 0,
                          "[HeatFluidCoupledSpecies<>::setLiquidDensity(%)] value has to be positive",
                          liquidDensity);
     liquidDensity_ = liquidDensity;
 }

References logger.

◆ setMassTransferCoefficient()

template<class NormalForceSpecies >

void HeatFluidCoupledSpecies< NormalForceSpecies >::setMassTransferCoefficient ( Mdouble massTransferCoefficient )

Allows massTransferCoefficient_ to be changed.

 {
     logger.assert_always(massTransferCoefficient > 0,
                          "[HeatFluidCoupledSpecies<>::setMassTransferCoefficient(%)] value has to be positive",
                          massTransferCoefficient);
     massTransferCoefficient_ = massTransferCoefficient;
 }

References logger.

◆ write()

template<class NormalForceSpecies >

void HeatFluidCoupledSpecies< NormalForceSpecies >::write ( std::ostream & os ) const

Writes the species properties to an output stream.

 {
     ThermalSpecies<NormalForceSpecies>::write(os);
     os << " massTransferCoefficient " << massTransferCoefficient_;
     os << " latentHeatVaporization " << latentHeatVaporization_;
     os << " liquidDensity " << liquidDensity_;
     os << " evaporationCoefficientA " << evaporationCoefficientA_;
     os << " evaporationCoefficientA " << evaporationCoefficientB_;
     os << " ambientHumidity " << ambientHumidity_;
     os << " ambientEquilibriumMoistureContent " << ambientEquilibriumMoistureContent_;
     os << " ambientVapourConcentration " << ambientVapourConcentration_;
     os << " ambientTemperature " << ambientTemperature_;
 }