LiquidMigrationLSSpecies.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 LiquidMigrationLSSpecies_H
#define LiquidMigrationLSSpecies_H
 
#include "Species/AdhesiveForceSpecies/BaseAdhesiveForce.h"
#include "Math/ExtendedMath.h"
#include "Interactions/AdhesiveForceInteractions/LiquidMigrationLSInteraction.h"
 
class LiquidMigrationLSSpecies : public BaseAdhesiveForce
{
public:
    typedef LiquidMigrationLSInteraction InteractionType;
    
    LiquidMigrationLSSpecies();
    
    LiquidMigrationLSSpecies(const LiquidMigrationLSSpecies& s);
    
    ~LiquidMigrationLSSpecies();
    
    void read(std::istream& is);
    
    void write(std::ostream& os) const;
    
    std::string getBaseName() const;
    
    void mix(LiquidMigrationLSSpecies* S, LiquidMigrationLSSpecies* T);
 
//adhesion-specific functions
    
    void setInteractionDistance();
 
    //const LiquidMigrationLSInteraction*;
 
//setters and getters
    void setLiquidBridgeVolumeMax(Mdouble liquidBridgeVolume);
    
    Mdouble getLiquidBridgeVolumeMax() const;
 
    void setLiquidBridgeVolumeMin(Mdouble);
 
    Mdouble getLiquidBridgeVolumeMin() const;
 
    void setDistributionCoefficient(Mdouble distributionCoefficient);
    
    Mdouble getDistributionCoefficient() const;
    
    void setSurfaceTension(Mdouble surfaceTension);
    
    Mdouble getSurfaceTension() const;
    
    void setContactAngle(Mdouble contactAngle);
    
    Mdouble getContactAngle() const;
 
    void setViscosity(Mdouble viscosity);
 
    Mdouble getViscosity() const;
 
private:
    Mdouble liquidBridgeVolumeMax_;
 
    Mdouble liquidBridgeVolumeMin_;
 
    Mdouble distributionCoefficient_;
    
    Mdouble contactAngle_;
    
    Mdouble surfaceTension_;
 
    Mdouble viscosity_;
    
};
 
#endif