SolidifyingLiquidMigrationWilletSpecies.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 SolidifyingLiquidMigrationWilletSpecies_h
#define SolidifyingLiquidMigrationWilletSpecies_h
 
#include "Species/AdhesiveForceSpecies/LiquidMigrationWilletSpecies.h"
#include "Math/ExtendedMath.h"
#include "Interactions/AdhesiveForceInteractions/SolidifyingLiquidMigrationWilletInteraction.h"
#include "../BaseSpecies.h"
 
class SolidifyingLiquidMigrationWilletSpecies : public LiquidMigrationWilletSpecies
{
public:
    typedef SolidifyingLiquidMigrationWilletInteraction InteractionType;
 
    SolidifyingLiquidMigrationWilletSpecies();
 
    SolidifyingLiquidMigrationWilletSpecies(const SolidifyingLiquidMigrationWilletSpecies& s);
 
    ~SolidifyingLiquidMigrationWilletSpecies();
 
    void read(std::istream& is);
 
    void write(std::ostream& os) const;
 
    std::string getBaseName() const;
 
    void mix(SolidifyingLiquidMigrationWilletSpecies* S, SolidifyingLiquidMigrationWilletSpecies* T);
 
//setters and getters
    // Allows the spring constant to be changed
    void setBondDissipation(Mdouble bondDissipation) {
        logger.assert_debug(bondDissipation >= 0, "Error in setBondDissipation");
        bondDissipation_ = bondDissipation;
    }
 
    // Allows the spring constant to be accessed
    Mdouble getBondDissipation() const {
        return bondDissipation_;
    }
 
    // Allows bondForceMax_ to be changed
    void setBondForceMax(Mdouble bondForceMax) {
        logger.assert_debug(bondForceMax >= 0, "Error in setBondForceMax");
        bondForceMax_ = bondForceMax;
    }
 
    // Allows bondForceMax_ to be accessed
    Mdouble getBondForceMax() const {
        return bondForceMax_;
    }
 
    // Allows bondForceMax_ to be changed
    void setSolidFraction(Mdouble solidFraction) {
        logger.assert_debug(solidFraction >= 0, "Error in setBondForceMax");
        solidFraction_ = solidFraction;
    }
 
    // Allows bondForceMax_ to be accessed
    Mdouble getSolidFraction() const {
        return solidFraction_;
    }
 
private:
    Mdouble bondDissipation_;
 
    Mdouble bondForceMax_;
 
    Mdouble solidFraction_;
};
 
#endif