MindlinSpecies.cc

Go to the documentation of this file.

//Copyright (c) 2013-2017, 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.

#include <cmath>
#include "MindlinSpecies.h"
#include "Species/NormalForceSpecies/LinearViscoelasticNormalSpecies.h"
#include "Species/BaseSpecies.h"
#include "Species/NormalForceSpecies/LinearPlasticViscoelasticNormalSpecies.h"

class BaseParticle;
class BaseInteractable;

MindlinSpecies::MindlinSpecies()
{
    slidingDissipation_ = 0;
    slidingFrictionCoefficient_ = 0;
    slidingFrictionCoefficientStatic_ = 0;
    //k_edit
    //setting the shear modulus to have a default value of zero, in-keeping with the other parameters...
    shearModulus_ = 0;
    //...and the same for K_t0
#ifdef DEBUG_CONSTRUCTOR
    std::cout<<"MindlinSpecies::MindlinSpecies() finished"<<std::endl;
#endif
}

MindlinSpecies::MindlinSpecies(const MindlinSpecies &s)
{
    slidingDissipation_ = s.slidingDissipation_;
    slidingFrictionCoefficient_ = s.slidingFrictionCoefficient_;
    slidingFrictionCoefficientStatic_ = s.slidingFrictionCoefficientStatic_;
    //k_edit
    //setting the shear modulus to the value of 's', in-keeping with the other parameters...
    shearModulus_ = s.shearModulus_;
#ifdef DEBUG_CONSTRUCTOR
    std::cout<<"MindlinSpecies::MindlinSpecies(const MindlinSpecies &p) finished"<<std::endl;
#endif
}

MindlinSpecies::~MindlinSpecies()
{
#ifdef DEBUG_DESTRUCTOR
    std::cout<<"MindlinSpecies::~MindlinSpecies() finished"<<std::endl;
#endif   
}

void MindlinSpecies::write(std::ostream& os) const
        {
    //BaseSpecies::write(os);
    os << " shearModulus " << shearModulus_;
    os << " slidingDissipation " << slidingDissipation_;
    os << " slidingFrictionCoefficient " << slidingFrictionCoefficient_;
    os << " slidingFrictionCoefficientStatic " << slidingFrictionCoefficientStatic_;
}

void MindlinSpecies::read(std::istream& is)
{
    //BaseSpecies::read(is);
    std::string dummy;
    is >> dummy >> shearModulus_;
    is >> dummy >> slidingDissipation_;
    is >> dummy >> slidingFrictionCoefficient_;
    is >> dummy >> slidingFrictionCoefficientStatic_;
}

std::string MindlinSpecies::getBaseName() const
{
    return "Mindlin";
}



void MindlinSpecies::setSlidingDissipation(Mdouble new_dispt)
{
    if (new_dispt >= 0)
        slidingDissipation_ = new_dispt;
    else
    {
        std::cerr << "Error in setSlidingDissipation" << std::endl;
        exit(-1);
    }
}
Mdouble MindlinSpecies::getSlidingDissipation() const
{
    return slidingDissipation_;
}

//mu has to be set to allow tangential forces (sets dispt=disp as default)
void MindlinSpecies::setSlidingFrictionCoefficient(Mdouble new_mu)
{
    if (new_mu >= 0)
    {
        slidingFrictionCoefficient_ = new_mu;
        slidingFrictionCoefficientStatic_ = slidingFrictionCoefficient_;
    }
    else
    {
        std::cerr << "Error in setSlidingFrictionCoefficient" << std::endl;
        exit(-1);
    }
}

Mdouble MindlinSpecies::getSlidingFrictionCoefficient() const
{
    return slidingFrictionCoefficient_;
}

void MindlinSpecies::setSlidingFrictionCoefficientStatic(Mdouble new_mu)
{
    if (new_mu >= 0)
    {
        slidingFrictionCoefficientStatic_ = new_mu;
    }
    else
    {
        std::cerr << "Error in setSlidingFrictionCoefficientStatic" << std::endl;
        exit(-1);
    }
}
//k_edit
//allows the shear modulus to be set / changed
void MindlinSpecies::setShearModulus(Mdouble new_G) {
    //sanity check to ensure that a negative shear modulus cannot be set!
    if (new_G >= 0)
    {
        shearModulus_ = new_G;
    }
    else
    {
        std::cerr << "Error in setShearModulus" << std::endl;
        exit(-1);
    }
}

//k_edit
//allows the shear modulus of a given species to be accessed
Mdouble MindlinSpecies::getShearModulus() const {
    return shearModulus_;
}

Mdouble MindlinSpecies::getSlidingFrictionCoefficientStatic() const
{
    return slidingFrictionCoefficientStatic_;
}

bool MindlinSpecies::getUseAngularDOFs() const
{
    return true;
}

void MindlinSpecies::mix(MindlinSpecies* const SFrictional, MindlinSpecies* const TFrictional)
{
    slidingDissipation_ = average(SFrictional->getSlidingDissipation(), TFrictional->getSlidingDissipation());
    slidingFrictionCoefficient_ = average(SFrictional->getSlidingFrictionCoefficient(), TFrictional->getSlidingFrictionCoefficient());
    slidingFrictionCoefficientStatic_ = average(SFrictional->getSlidingFrictionCoefficientStatic(), TFrictional->getSlidingFrictionCoefficientStatic());
}