ThermalParticle.h

Go to the documentation of this file.

//Copyright (c) 2013-2023, The MercuryDPM Developers Team. All rights reserved.
//For the list of developers, see <http://www.MercuryDPM.org/Team>.
//
//Redistribution and use in source and binary forms, with or without
//modification, are permitted provided that the following conditions are met:
//  * Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//  * Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//  * Neither the name MercuryDPM nor the
//    names of its contributors may be used to endorse or promote products
//    derived from this software without specific prior written permission.
//
//THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
//ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
//WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
//DISCLAIMED. IN NO EVENT SHALL THE MERCURYDPM DEVELOPERS TEAM BE LIABLE FOR ANY
//DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
//(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
//LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
//ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
//(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
//SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
#ifndef ThermalParticle_H
#define ThermalParticle_H
#include "DPMBase.h"
 
template<class Particle>
class Thermal : public Particle
{
public:
    Thermal()
    {
        temperature_ = 0;
        //temperatureDependentDensity_
    }
    
    Thermal(const Thermal& p) : Particle(p)
    {
        temperature_ = p.temperature_;
        timeDependentTemperature_ = p.timeDependentTemperature_;
    }
    
    ~Thermal() override
    = default;
    
    Thermal* copy() const override
    {
        return new Thermal(*this);
    }
 
    void write(std::ostream& os) const override
    {
        Particle::write(os);
        os << " temperature " << temperature_;
    }
    
    std::string getName() const override
    {
        return "Thermal" + Particle::getName();
    }
    
    void read(std::istream& is) override;
    
    Mdouble getTemperature() const
    {
        return temperature_;
    }
    
    void setTemperature(Mdouble temperature)
    {
        logger.assert_debug(temperature>0, "Temperature has to be positive");
        temperature_ = temperature;
    }
    
    void addTemperature(Mdouble temperature)
    {
        temperature_ += temperature;
        logger.assert_debug(temperature_>0, "Temperature has to be positive");
    }
    
    void setTemperatureDependentDensity(const std::function<double(double)>& temperatureDependentDensity);
    
    const std::function<double(double)>& getTemperatureDependentDensity() const;
    
    const std::function<double(double)>& getTimeDependentTemperature() const
    {
        return timeDependentTemperature_;
    }
    
    void setTimeDependentTemperature(const std::function<double(double)>& timeDependentTemperature);
    
    void actionsAfterTimeStep() override;
 
    bool isSphericalParticle() const override {return true;}
 
private:
    
    std::function<double(double temperature)> timeDependentTemperature_;
 
protected:
    Mdouble temperature_;
};
 
template<class Particle>
void Thermal<Particle>::read(std::istream& is)
{
    Particle::read(is);
    std::string dummy;
    is >> dummy >> temperature_;
}
 
template<class Particle>
void Thermal<Particle>::actionsAfterTimeStep()
{
    if (timeDependentTemperature_)
    {
        temperature_ = timeDependentTemperature_(this->getHandler()->getDPMBase()->getTime());
    }
    if (this->getSpecies()->getTemperatureDependentDensity())
    {
        const Mdouble density = this->getSpecies()->getTemperatureDependentDensity()(temperature_);
        this->radius_ = this->getRadius() * cbrt(this->getMass() / (this->getVolume() * density));
    }
}
 
template<class Particle>
void Thermal<Particle>::setTimeDependentTemperature(const std::function<double(double)>& timeDependentTemperature)
{
    timeDependentTemperature_ = timeDependentTemperature;
    temperature_ = timeDependentTemperature(0);
    logger(INFO, "Setting initial temperature to %", temperature_);
}
 
typedef Thermal<SphericalParticle> ThermalParticle;
#endif