LiquidMigrationLSInteraction.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 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;
 
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();
    
    int getNumberOfContacts(BaseInteractable* interactable);
    
    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:
    bool wasInContact_;
    
    Mdouble liquidBridgeVolume_;
};
 
#endif