LiquidFilmParticle.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 LiquidFilmParticle_H
#define LiquidFilmParticle_H
#include "DPMBase.h"
 
template<class Particle>
class LiquidFilm : public Particle
{
public:
    LiquidFilm()
    {
        liquidVolume_ = 0;
    }
    
    LiquidFilm(const LiquidFilm& p) : Particle(p)
    {
        liquidVolume_ = p.liquidVolume_;
    }
    
    ~LiquidFilm() override
    = default;
    
    LiquidFilm* copy() const override
    {
        return new LiquidFilm(*this);
    }
 
    void write(std::ostream& os) const override
    {
        Particle::write(os);
        os << " liquidVolume " << liquidVolume_;
    }
 
    std::string getName() const override
    {
        return "LiquidFilm";
    }
    
    void read(std::istream& is) override;
    
    Mdouble getLiquidVolume() const
    {
        return liquidVolume_;
    }
    
    void setLiquidVolume(Mdouble liquidVolume)
    {
        liquidVolume_ = liquidVolume;
    }
    
    void addLiquidVolume(Mdouble liquidVolume)
    {
        liquidVolume_ += liquidVolume;
    }
    
    unsigned getNumberOfFieldsVTK() const override
    {
        return 3;
    }
    
    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_;
};
 
 
//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_;
    }
}
 
template<class Particle>
std::string LiquidFilm<Particle>::getNameVTK(unsigned i) const
{
    if (i==1)
        return "liquidFilmVolume";
    else if (i==2)
        return "liquidBridgeVolume";
    else /*i=0*/
        return "fullLiquidVolume";
}
 
template<class Particle>
std::vector<Mdouble> LiquidFilm<Particle>::getFieldVTK(unsigned i) const
{
    if (i==1) {
        return std::vector<Mdouble>(1, liquidVolume_);
    } else /*i=2 or 0*/ {
        Mdouble fullLiquidVolume = (i==2)?0:liquidVolume_;
        for (auto k : this->getInteractions()) {
            if(dynamic_cast<LiquidMigrationWilletInteraction*>(k)){
                auto j = dynamic_cast<LiquidMigrationWilletInteraction*>(k);
                if (j && j->getLiquidBridgeVolume()) {
                    fullLiquidVolume += 0.5*j->getLiquidBridgeVolume();
                }
            }
            if(dynamic_cast<LiquidMigrationLSInteraction*>(k)) {
                auto j = dynamic_cast<LiquidMigrationLSInteraction*>(k);
                if (j && j->getLiquidBridgeVolume()) {
                    fullLiquidVolume += 0.5 * j->getLiquidBridgeVolume();
                }
            }
 
        }
        return std::vector<Mdouble>(1, fullLiquidVolume);
    }
}
 
typedef LiquidFilm<SphericalParticle> LiquidFilmParticle;
 
#endif