LiquidFilmParticle.h

Go to the documentation of this file.

// This file is part of the MercuryDPM project (https://www.mercurydpm.org).
// Copyright (c), The MercuryDPM Developers Team. All rights reserved.
// License: BSD 3-Clause License; see the LICENSE file in the root directory.
 
#ifndef LiquidFilmParticle_H
#define LiquidFilmParticle_H
#include "DPMBase.h"
 
template<class Particle>
class LiquidFilm : public Particle
{
public:
    LiquidFilm()
    {
        liquidVolume_ = 0;
        totalEvaporatedLiquidVolume_ = 0;
    }
    
    LiquidFilm(const LiquidFilm& p) : Particle(p)
    {
        liquidVolume_ = p.liquidVolume_;
        totalEvaporatedLiquidVolume_ = p.totalEvaporatedLiquidVolume_;
    }
    
    ~LiquidFilm() override
    = default;
    
    LiquidFilm* copy() const override
    {
        return new LiquidFilm(*this);
    }
 
    void write(std::ostream& os) const override
    {
        Particle::write(os);
        os << " liquidVolume " << liquidVolume_ << " totalEvaporatedLiquidVolume " << totalEvaporatedLiquidVolume_;
    }
 
    std::string getName() const override
    {
        return "LiquidFilm" + Particle::getName();
    }
    
    void read(std::istream& is) override;
    
    Mdouble getLiquidVolume() const
    {
        return liquidVolume_;
    }
    
    void setLiquidVolume(Mdouble liquidVolume)
    {
        liquidVolume_ = liquidVolume;
    }
    
    void addLiquidVolume(Mdouble liquidVolume)
    {
        liquidVolume_ += liquidVolume;
    }
 
    Mdouble getFullLiquidVolume() const
    {
        return liquidVolume_ + getLiquidBridgeVolume();
    }
 
    Mdouble getLiquidBridgeVolume() const;
 
    Mdouble getTotalEvaporatedLiquidVolume() const
    {
        return totalEvaporatedLiquidVolume_;
    }
 
    void setTotalEvaporatedLiquidVolume(Mdouble liquidVolume)
    {
        totalEvaporatedLiquidVolume_ = liquidVolume;
    }
 
    void addTotalEvaporatedLiquidVolume(Mdouble liquidVolume)
    {
        totalEvaporatedLiquidVolume_ += liquidVolume;
    }
 
    Mdouble getMeanLiquidFilmThickness() const
    { 
        return liquidVolume_ / Particle::getSurfaceArea(); 
    }
 
    Mdouble getRelativeLiquidVolume() const
    { 
        return liquidVolume_ / Particle::getVolume(); 
    }
    
    unsigned getNumberOfFieldsVTK() const override
    {
        return 6;
    }
    
    std::string getTypeVTK(unsigned i) const override
    {
        return "Float32";
    }
    
    std::string getNameVTK(unsigned i) const override;
    
    std::vector<Mdouble> getFieldVTK(unsigned i) const override;
 
    bool isSphericalParticle() const override {return true;}
 
protected:
    
    Mdouble liquidVolume_, totalEvaporatedLiquidVolume_;
};
 
 
//todo Does mass and interaction radius change when a liquid film is added?
template<class Particle>
void LiquidFilm<Particle>::read(std::istream& is)
{
    Particle::read(is);
    std::string dummy;
    is >> dummy >> liquidVolume_;
    // a fix to allow reading of restart files pre-nonspherical
    if (dummy == "invInertia")
    {
        is >> dummy >> liquidVolume_;
    }
    is >> dummy >> totalEvaporatedLiquidVolume_;
}
 
template<class Particle>
std::string LiquidFilm<Particle>::getNameVTK(unsigned i) const
{
    if (i==1)
        return "liquidFilmVolume";
    else if (i==2)
        return "liquidBridgeVolume";
    else if (i==3)
        return "totalEvaporatedLiquidVolume";
    else if (i==4)
        return "meanLiquidFilmThickness";
    else if (i==5)
        return "relativeLiquidVolume";
    else /*i=0*/
        return "fullLiquidVolume";
}
 
template<class Particle>
std::vector<Mdouble> LiquidFilm<Particle>::getFieldVTK(unsigned i) const
{
    if (i==1)
        return { liquidVolume_ };
    else if (i==2)
        return { getLiquidBridgeVolume() };
    else if (i==3)
        return { totalEvaporatedLiquidVolume_ };
    else if (i==4)
        return { getMeanLiquidFilmThickness() };
    else if (i==5)
        return { getRelativeLiquidVolume() };
    else /*i=0*/
        return { getFullLiquidVolume() };
}
 
template<class Particle>
Mdouble LiquidFilm<Particle>::getLiquidBridgeVolume() const
{
    // Sums the volume of all liquid bridges. Half when interacting with a particle, full when interacting with a wall.
    Mdouble volume = 0.0;
    for (auto i : this->getInteractions())
    {
        auto j = dynamic_cast<LiquidMigrationWilletInteraction*>(i);
        if (j)
        {
            if (dynamic_cast<BaseParticle*>(j->getI()))
                volume += 0.5 * j->getLiquidBridgeVolume();
            else
                volume += j->getLiquidBridgeVolume();
        }
        else
        {
            auto k = dynamic_cast<LiquidMigrationLSInteraction*>(i);
            if (k)
            {
                if (dynamic_cast<BaseParticle*>(k->getI()))
                    volume += 0.5 * k->getLiquidBridgeVolume();
                else
                    volume += k->getLiquidBridgeVolume();
            }
        }
    }
    return volume;
}
 
typedef LiquidFilm<SphericalParticle> LiquidFilmParticle;
 
#endif