ChargedBondedSpecies.h

Go to the documentation of this file.

//Copyright (c) 2013-2014, 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 ChargedBondedSpecies_H
#define ChargedBondedSpecies_H
#include "Species/BaseSpecies.h"
#include "Math/ExtendedMath.h"
#include "Interactions/AdhesiveForceInteractions/ChargedBondedInteraction.h"

class ChargedBondedSpecies : public virtual BaseSpecies
{
public:
    typedef ChargedBondedInteraction InteractionType;

    ChargedBondedSpecies();

    ChargedBondedSpecies(const ChargedBondedSpecies &s);

    virtual ~ChargedBondedSpecies();

    void read(std::istream& is);

    void write(std::ostream& os) const;

    std::string getBaseName() const;

    void mix(ChargedBondedSpecies* const S, ChargedBondedSpecies* const T);

//adhesion-specific functions

    Mdouble getInteractionDistance() const;

//setters and getters
    void setAdhesionStiffness(Mdouble new_k0);

    Mdouble getAdhesionStiffness() const;

    void setAdhesionForceMax(Mdouble new_f0);

    Mdouble getAdhesionForceMax() const;

    //function to allows the charge of a particle to be easily accessed
    int getCharge() const;

    //allows the user to set the charge possessed by a particle species
    void setCharge(int newCharge);

//*********************************************************************************************************************
//******************************ADDING ADDITIONAL FUNCTIONS FOR BOND INTERACTIONS**************************************
//*********************************************************************************************************************

    void setBondForceMax(Mdouble new_f0);

    Mdouble getBondForceMax() const;

    void setBondDissipation(Mdouble disp);

    Mdouble getBondDissipation() const;

private:
    Mdouble adhesionStiffness_; 

    Mdouble adhesionForceMax_;

    //creating a simple integer flag to denote whether a particle is charged or not
    //the boolean will be 0 if the particle has no charge, 1 if positively charged
    //and -1 if negatively charged
    int charge_;

//*********************************************************************************************************************
//******************************ADDING ADDITIONAL VARIABLES FOR BOND INTERACTIONS**************************************
//*********************************************************************************************************************

    Mdouble bondForceMax_;

    Mdouble bondDissipation_;


//*********************************************************************************************************************
//****************************ADDING ADDITIONAL VARIABLES VAN DER WAALS INTERACTIONS***********************************
//*********************************************************************************************************************
    //Adding parameters to recreate a highly simplified (but relatively computationally efficient!)
    // van der Waals-like force at short distances

    //The maximal strength of the van der Waals force.
    //Note that this should, by definition, be great enough to overcome the maximal repulsive force experienced by
    //a particle, as the net force must be attractive in order to correctly represent vand der Waals
    Mdouble vanDerWaalsForceMax_;

    //The stiffness used to determine the 'reach' of the van der Waals force applied to particles.
    Mdouble vanDerWaalsStiffness_;

public:
    //Declaring the relevant get and set functions for the van der Waals stiffness and maximal force
    Mdouble getVanDerWaalsStiffness() const;
    Mdouble getVanDerWaalsForceMax() const;
    void setVanDerWaalsStiffness(Mdouble);
    void setVanDerWaalsForceMax(Mdouble);



};
#endif