LiquidMigrationLSInteraction.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 LiquidMigrationLSInteraction_H
#define LiquidMigrationLSInteraction_H
 
#include "Interactions/BaseInteraction.h"
#include "Math/Vector.h"
#include "ParticleHandler.h"
#include "InteractionHandler.h"
 
class BaseParticle;
 
class LiquidMigrationLSSpecies;
 
class BaseInteractable;
 
// First forward declare template class LiquidFilm and class SphericalParticle, to forward declare typedef LiquidFilmParticle.
template <class T>
class LiquidFilm;
class SphericalParticle;
typedef LiquidFilm<SphericalParticle> LiquidFilmParticle;
 
class LiquidMigrationLSInteraction : public virtual BaseInteraction
{
public:
    typedef LiquidMigrationLSSpecies SpeciesType;
    
    LiquidMigrationLSInteraction(BaseInteractable* P, BaseInteractable* I, unsigned timeStamp);
    
    //used for mpi
    LiquidMigrationLSInteraction();
    
    LiquidMigrationLSInteraction(const LiquidMigrationLSInteraction& p);
    
    ~LiquidMigrationLSInteraction() override;
    
    void actionsOnErase() override;
    
    void actionsAfterTimeStep() override;
    
    void computeAdhesionForce();
    
    void read(std::istream& is) override;
    
    void write(std::ostream& os) const override;
    
    Mdouble getElasticEnergy() const override;
    
    const LiquidMigrationLSSpecies* getSpecies() const;
    
    std::string getBaseName() const;
    
    Mdouble getLiquidBridgeVolume() const;
    
    void setLiquidBridgeVolume(Mdouble liquidBridgeVolume);
    
    void addLiquidBridgeVolume(Mdouble liquidBridgeVolume);
    
    bool getWasInContact() const;
    
    void setWasInContact(bool wasInContact);
    
    void rupture();
    
    void form();
    
    Mdouble getRuptureDistance();
 
    Mdouble getHalfFillingAngle();
 
    Mdouble getLimitingDistance();
    
    unsigned getNumberOfFieldsVTK() const override;
    
    std::string getTypeVTK(unsigned i) const override;
    
    std::string getNameVTK(unsigned i) const override;
    
    std::vector<Mdouble> getFieldVTK(unsigned i) const override;
    
    static Mdouble getTotalLiquidFilmVolume(ParticleHandler&);
    
    static Mdouble getTotalLiquidBridgeVolume(InteractionHandler&);
 
private:
    void distributeToOtherBridges(LiquidFilmParticle* particle, Mdouble distributableVolume);
 
private:
    bool wasInContact_;
    
    Mdouble liquidBridgeVolume_;
};
 
#endif