Interaction.h

Go to the documentation of this file.

//Copyright (c) 2013-2020, 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 INTERACTION_H
#define INTERACTION_H

#include "FrictionForceInteractions/EmptyFrictionInteraction.h"
#include "AdhesiveForceInteractions/EmptyAdhesiveInteraction.h"
#include "InteractionHandler.h"
#include "BaseInteractable.h"

//used for mpi
#include "MpiContainer.h"
#include "MPIInteraction.h"
#include "Logger.h"

class BaseInteractable;

template<class NormalForceSpecies, class FrictionForceSpecies, class AdhesiveForceSpecies>
class Species;

//this class combines normal and tangential force laws
template<class NormalForceInteraction, class FrictionForceInteraction=EmptyFrictionInteraction, class AdhesiveForceInteraction=EmptyAdhesiveInteraction>
class Interaction : public NormalForceInteraction, public FrictionForceInteraction, public AdhesiveForceInteraction
{
public:
    
    Interaction(BaseInteractable* P, BaseInteractable* I, unsigned timeStamp);
    
    Interaction();
    
    Interaction(const Interaction& p);
    
    virtual ~Interaction();
    
    Interaction<NormalForceInteraction, FrictionForceInteraction, AdhesiveForceInteraction>* copy() const final;
    
    void computeForce() final;
    
    void computeInteraction();
    
    void read(std::istream& is) final;
    
    void write(std::ostream& os) const final;
    
    std::string getName() const final;
    
    Mdouble getElasticEnergy() const final;
    
    void integrate(Mdouble timeStep) final;
    
    void reverseHistory() final;
    
    void rotateHistory(Matrix3D& rotationMatrix) final;
    
    void actionsAfterTimeStep();
    
    Mdouble getElasticEnergyAtEquilibrium(Mdouble adhesiveForce) const;
    
    void getMPIInteraction(void* historyDataArray, unsigned int index) const final;
    
    //if resetPointers is true, then the pointers in the interaction will be set to nullptr, indicating it is a dummyInteraction
    //and that it is not actually linked to real particles (which might not be in the domain)
    void setMPIInteraction(void* historyDataArray, unsigned int index, const bool resetPointers) final;
    
    void getInteractionDetails(void* interactionDataArray, unsigned int index, unsigned int& identificationP,
                               unsigned int& identificationI, bool& isWallInteraction, unsigned& timeStamp);
    
    void createMPIType() final;
    
    void* createMPIInteractionDataArray(unsigned int numberOfInteractions) const final;
    
    void deleteMPIInteractionDataArray(void* dataArray) final;
};

template<class NormalForceInteraction, class FrictionForceInteraction, class AdhesiveForceInteraction>
Interaction<NormalForceInteraction, FrictionForceInteraction, AdhesiveForceInteraction>::Interaction(
        BaseInteractable* P, BaseInteractable* I, unsigned timeStamp)
        : BaseInteraction(P, I, timeStamp), NormalForceInteraction(P, I, timeStamp),
          FrictionForceInteraction(P, I, timeStamp), AdhesiveForceInteraction(P, I, timeStamp)
{
#ifdef DEBUG_CONSTRUCTOR
    std::cout<<"Interaction::Interaction() finished"<<std::endl;
#endif
}


template<class NormalForceInteraction, class FrictionForceInteraction, class AdhesiveForceInteraction>
Interaction<NormalForceInteraction, FrictionForceInteraction, AdhesiveForceInteraction>::Interaction()
        : BaseInteraction(), NormalForceInteraction(), FrictionForceInteraction(), AdhesiveForceInteraction()
{
#ifdef DEBUG_CONSTRUCTOR
    std::cout<<"Interaction::Interaction() finished"<<std::endl;
#endif
}

template<class NormalForceInteraction, class FrictionForceInteraction, class AdhesiveForceInteraction>
Interaction<NormalForceInteraction, FrictionForceInteraction, AdhesiveForceInteraction>::Interaction(
        const Interaction& p)
        : BaseInteraction(p), NormalForceInteraction(p), FrictionForceInteraction(p), AdhesiveForceInteraction(p)
{
#ifdef DEBUG_CONSTRUCTOR
    std::cout<<"Interaction::Interaction(const Interaction &p finished"<<std::endl;
#endif
}

template<class NormalForceInteraction, class FrictionForceInteraction, class AdhesiveForceInteraction>
Interaction<NormalForceInteraction, FrictionForceInteraction, AdhesiveForceInteraction>::~Interaction()
{
#ifdef DEBUG_DESTRUCTOR
    std::cout<<"Interaction::~Interaction() finished"<<std::endl;
#endif
}

template<class NormalForceInteraction, class FrictionForceInteraction, class AdhesiveForceInteraction>
Interaction<NormalForceInteraction, FrictionForceInteraction, AdhesiveForceInteraction>*
Interaction<NormalForceInteraction, FrictionForceInteraction, AdhesiveForceInteraction>::copy() const
{
    return new Interaction(*this);
}

template<class NormalForceInteraction, class FrictionForceInteraction, class AdhesiveForceInteraction>
void
Interaction<NormalForceInteraction, FrictionForceInteraction, AdhesiveForceInteraction>::write(std::ostream& os) const
{
    NormalForceInteraction::write(os);
    FrictionForceInteraction::write(os);
    AdhesiveForceInteraction::write(os);
    
}

template<class NormalForceInteraction, class FrictionForceInteraction, class AdhesiveForceInteraction>
void Interaction<NormalForceInteraction, FrictionForceInteraction, AdhesiveForceInteraction>::read(std::istream& is)
{
    NormalForceInteraction::read(is);
    FrictionForceInteraction::read(is);
    AdhesiveForceInteraction::read(is);
}

template<class NormalForceInteraction, class FrictionForceInteraction, class AdhesiveForceInteraction>
void Interaction<NormalForceInteraction, FrictionForceInteraction, AdhesiveForceInteraction>::reverseHistory()
{
    NormalForceInteraction::reverseHistory();
    FrictionForceInteraction::reverseHistory();
    AdhesiveForceInteraction::reverseHistory();
}

template<class NormalForceInteraction, class FrictionForceInteraction, class AdhesiveForceInteraction>
void Interaction<NormalForceInteraction, FrictionForceInteraction, AdhesiveForceInteraction>::rotateHistory(
        Matrix3D& rotationMatrix)
{
    NormalForceInteraction::rotateHistory(rotationMatrix);
    FrictionForceInteraction::rotateHistory(rotationMatrix);
    AdhesiveForceInteraction::rotateHistory(rotationMatrix);
}

template<class NormalForceInteraction, class FrictionForceInteraction, class AdhesiveForceInteraction>
std::string Interaction<NormalForceInteraction, FrictionForceInteraction, AdhesiveForceInteraction>::getName() const
{
    return NormalForceInteraction::getBaseName() + FrictionForceInteraction::getBaseName() +
           AdhesiveForceInteraction::getBaseName() + "Interaction";
}

template<class NormalForceInteraction, class FrictionForceInteraction, class AdhesiveForceInteraction>
void
Interaction<NormalForceInteraction, FrictionForceInteraction, AdhesiveForceInteraction>::integrate(Mdouble timeStep)
{
    FrictionForceInteraction::integrate(timeStep);
}

template<class NormalForceInteraction, class FrictionForceInteraction, class AdhesiveForceInteraction>
void Interaction<NormalForceInteraction, FrictionForceInteraction, AdhesiveForceInteraction>::computeForce()
{
    NormalForceInteraction::computeNormalForce();
    FrictionForceInteraction::computeFrictionForce();
    AdhesiveForceInteraction::computeAdhesionForce();
}

template<class NormalForceInteraction, class FrictionForceInteraction, class AdhesiveForceInteraction>
Mdouble
Interaction<NormalForceInteraction, FrictionForceInteraction, AdhesiveForceInteraction>::getElasticEnergy() const
{
    return NormalForceInteraction::getElasticEnergy() + FrictionForceInteraction::getElasticEnergy() +
           AdhesiveForceInteraction::getElasticEnergy();
}

template<class NormalForceInteraction, class FrictionForceInteraction, class AdhesiveForceInteraction>
void Interaction<NormalForceInteraction, FrictionForceInteraction, AdhesiveForceInteraction>::actionsAfterTimeStep()
{
    AdhesiveForceInteraction::actionsAfterTimeStep();
}

template<class NormalForceInteraction, class FrictionForceInteraction, class AdhesiveForceInteraction>
Mdouble
Interaction<NormalForceInteraction, FrictionForceInteraction, AdhesiveForceInteraction>::getElasticEnergyAtEquilibrium(
        Mdouble adhesiveForce) const
{
    return NormalForceInteraction::getElasticEnergyAtEquilibrium(adhesiveForce);
};


template<class NormalForceInteraction, class FrictionForceInteraction, class AdhesiveForceInteraction>
void Interaction<NormalForceInteraction, FrictionForceInteraction, AdhesiveForceInteraction>::getMPIInteraction(
        void* interactionDataArray, unsigned int index) const
{
    MPIInteraction<NormalForceInteraction, FrictionForceInteraction, AdhesiveForceInteraction> interactionData;
    
    interactionData.copyFromInteraction(this);
    
    MPIInteraction<NormalForceInteraction, FrictionForceInteraction, AdhesiveForceInteraction>* array = static_cast<MPIInteraction<NormalForceInteraction, FrictionForceInteraction, AdhesiveForceInteraction>*>(interactionDataArray);
    array[index] = interactionData;
}

template<class NormalForceInteraction, class FrictionForceInteraction, class AdhesiveForceInteraction>
void Interaction<NormalForceInteraction, FrictionForceInteraction, AdhesiveForceInteraction>::setMPIInteraction(
        void* interactionDataArray, unsigned int index, const bool resetPointers)
{
    MPIInteraction<NormalForceInteraction, FrictionForceInteraction, AdhesiveForceInteraction>* array = static_cast<MPIInteraction<NormalForceInteraction, FrictionForceInteraction, AdhesiveForceInteraction>*>(interactionDataArray);
    MPIInteraction<NormalForceInteraction, FrictionForceInteraction, AdhesiveForceInteraction> interactionData = array[index];
    
    //Copy the interaction data into the interaction
    interactionData.copyToInteraction(this, resetPointers);
}

template<class NormalForceInteraction, class FrictionForceInteraction, class AdhesiveForceInteraction>
void Interaction<NormalForceInteraction, FrictionForceInteraction, AdhesiveForceInteraction>::getInteractionDetails(
        void* interactionDataArray, unsigned int index, unsigned int& identificationP, unsigned int& identificationI,
        bool& isWallInteraction, unsigned& timeStamp)
{
    MPIInteraction<NormalForceInteraction, FrictionForceInteraction, AdhesiveForceInteraction>* array = static_cast<MPIInteraction<NormalForceInteraction, FrictionForceInteraction, AdhesiveForceInteraction>*>(interactionDataArray);
    MPIInteraction<NormalForceInteraction, FrictionForceInteraction, AdhesiveForceInteraction> interactionData = array[index];
    
    identificationP = interactionData.P;
    identificationI = interactionData.I;
    isWallInteraction = interactionData.isWallInteraction;
    timeStamp = interactionData.timeStamp;
}


template<class NormalForceInteraction, class FrictionForceInteraction, class AdhesiveForceInteraction>
void*
Interaction<NormalForceInteraction, FrictionForceInteraction, AdhesiveForceInteraction>::createMPIInteractionDataArray(
        unsigned int numberOfInteractions) const
{
    MPIInteraction<NormalForceInteraction, FrictionForceInteraction, AdhesiveForceInteraction>* array = new MPIInteraction<NormalForceInteraction, FrictionForceInteraction, AdhesiveForceInteraction>[numberOfInteractions];
    void* interactionArray = static_cast<void*>(array);
    return interactionArray;
}

template<class NormalForceInteraction, class FrictionForceInteraction, class AdhesiveForceInteraction>
void
Interaction<NormalForceInteraction, FrictionForceInteraction, AdhesiveForceInteraction>::deleteMPIInteractionDataArray(
        void* dataArray)
{
    MPIInteraction<NormalForceInteraction, FrictionForceInteraction, AdhesiveForceInteraction>* array = static_cast<MPIInteraction<NormalForceInteraction, FrictionForceInteraction, AdhesiveForceInteraction>*>(dataArray);
    delete[] array;
}

template<class NormalForceInteraction, class FrictionForceInteraction, class AdhesiveForceInteraction>
void Interaction<NormalForceInteraction, FrictionForceInteraction, AdhesiveForceInteraction>::createMPIType()
{
#ifdef MERCURY_USE_MPI
    MPIContainer& communicator = MPIContainer::Instance();
    MPIInteraction<NormalForceInteraction, FrictionForceInteraction, AdhesiveForceInteraction> dummyHistoryInteraction;

    communicator.createMercuryMPIType(dummyHistoryInteraction, MercuryMPIType::INTERACTION);
#endif
}

#endif