Species.h

Go to the documentation of this file.

//Copyright (c) 2013-2023, 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 SPECIES_H
#define SPECIES_H
 
#include "MixedSpecies.h"
#include "ParticleSpecies.h"
#include "Species/FrictionForceSpecies/EmptyFrictionSpecies.h"
#include "Species/AdhesiveForceSpecies/EmptyAdhesiveSpecies.h"
#include "Interactions/Interaction.h"
 
class BaseInteraction;
 
template<class NormalForceSpecies, class FrictionForceSpecies = EmptyFrictionSpecies, class AdhesiveForceSpecies = EmptyAdhesiveSpecies>
class Species final
        : public ParticleSpecies, public NormalForceSpecies, public FrictionForceSpecies, public AdhesiveForceSpecies
{
public:
 
    typedef MixedSpecies<NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies> MixedSpeciesType;
    typedef Interaction<typename NormalForceSpecies::InteractionType, typename FrictionForceSpecies::InteractionType, typename AdhesiveForceSpecies::InteractionType> InteractionType;
    
    
    Species();
    
    Species(const Species& s);
    
    virtual ~Species();
    
    Species<NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies>* copy() const final;
    
    void copyInto(BaseSpecies* bs) const final;
    
    BaseSpecies* copyMixed() const final;
    
    void read(std::istream& is) final;
    
    void write(std::ostream& os) const final;
    
    std::string getName() const final;
    
    BaseInteraction*
    getNewInteraction(BaseInteractable* const P, BaseInteractable* const I, unsigned timeStamp) const final;
    
    //used to create a dummy for MPI purposes (I need a prototype of the interaction)
    BaseInteraction* getEmptyInteraction() const final;
    
    void deleteEmptyInteraction(BaseInteraction* interaction) const final;
    
    bool getUseAngularDOFs() const final;
    
    void mixAll(BaseSpecies* const S, BaseSpecies* const T) final;
 
    void actionsAfterTimeStep(BaseParticle* particle) const final {
        NormalForceSpecies::actionsAfterTimeStep(particle);
    }
};
 
template<class NormalForceSpecies, class FrictionForceSpecies, class AdhesiveForceSpecies>
Species<NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies>::Species()
        : ParticleSpecies(this,this,this), NormalForceSpecies(), FrictionForceSpecies(), AdhesiveForceSpecies()
{
    logger(DEBUG, "Species::Species() finished");
}
 
template<class NormalForceSpecies, class FrictionForceSpecies, class AdhesiveForceSpecies>
Species<NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies>::Species(const Species& s)
        : ParticleSpecies(s), NormalForceSpecies(s), FrictionForceSpecies(s), AdhesiveForceSpecies(s)
{
    normalForce_ = this;
    frictionForce_ = this;
    adhesiveForce_ = this;
    normalForce_->setBaseSpecies(this);
    frictionForce_->setBaseSpecies(this);
    adhesiveForce_->setBaseSpecies(this);
    logger(DEBUG, "Species::Species(const Species &p) finished");
}
 
template<class NormalForceSpecies, class FrictionForceSpecies, class AdhesiveForceSpecies>
Species<NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies>::~Species()
{
    logger(DEBUG, "Species::~Species() finished");
}
 
template<class NormalForceSpecies, class FrictionForceSpecies, class AdhesiveForceSpecies>
Species<NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies>*
Species<NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies>
::copy() const
{
    return new Species(*this);
}
 
template<class NormalForceSpecies, class FrictionForceSpecies, class AdhesiveForceSpecies>
BaseSpecies* Species<NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies>
::copyMixed() const
{
    return new MixedSpecies<NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies>(*this);
}
 
template<class NormalForceSpecies, class FrictionForceSpecies, class AdhesiveForceSpecies>
void Species<NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies>
::copyInto(BaseSpecies* bs) const
{
    if (bs == nullptr)
    {
        logger(WARN, "Error in %::copyInto: cannot copy into a nullptr");
        return;
    }
    auto* s = dynamic_cast<Species<NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies>*>(bs);
    if (s == nullptr)
    {
        logger(WARN, "Error in %::copyInto: copying of species failed", getName());
        return;
    }
    *s = *this;
}
 
template<class NormalForceSpecies, class FrictionForceSpecies, class AdhesiveForceSpecies>
void Species<NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies>
::write(std::ostream& os) const
{
    ParticleSpecies::write(os);
    NormalForceSpecies::write(os);
    FrictionForceSpecies::write(os);
    AdhesiveForceSpecies::write(os);
}
 
template<class NormalForceSpecies, class FrictionForceSpecies, class AdhesiveForceSpecies>
void Species<NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies>::read(std::istream& is)
{
    ParticleSpecies::read(is);
    NormalForceSpecies::read(is);
    FrictionForceSpecies::read(is);
    AdhesiveForceSpecies::read(is);
}
 
template<class NormalForceSpecies, class FrictionForceSpecies, class AdhesiveForceSpecies>
std::string Species<NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies>::getName() const
{
    return NormalForceSpecies::getBaseName()
           + FrictionForceSpecies::getBaseName()
           + AdhesiveForceSpecies::getBaseName() + "Species";
}
 
template<class NormalForceSpecies, class FrictionForceSpecies, class AdhesiveForceSpecies>
BaseInteraction*
Species<NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies>::getNewInteraction(BaseInteractable* const P,
                                                                                           BaseInteractable* const I,
                                                                                           unsigned timeStamp) const
{
    return new InteractionType(P, I, timeStamp);
}
 
template<class NormalForceSpecies, class FrictionForceSpecies, class AdhesiveForceSpecies>
BaseInteraction* Species<NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies>::getEmptyInteraction() const
{
    return new Interaction<typename NormalForceSpecies::InteractionType, typename FrictionForceSpecies::InteractionType, typename AdhesiveForceSpecies::InteractionType>();
}
 
template<class NormalForceSpecies, class FrictionForceSpecies, class AdhesiveForceSpecies>
void Species<NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies>::deleteEmptyInteraction(
        BaseInteraction* interaction) const
{
    Interaction<typename NormalForceSpecies::InteractionType, typename FrictionForceSpecies::InteractionType, typename AdhesiveForceSpecies::InteractionType>* interactionDestroyer;
    interactionDestroyer = dynamic_cast<Interaction<typename NormalForceSpecies::InteractionType, typename FrictionForceSpecies::InteractionType, typename AdhesiveForceSpecies::InteractionType>*>(interaction);
    delete interactionDestroyer;
}
 
template<class NormalForceSpecies, class FrictionForceSpecies, class AdhesiveForceSpecies>
bool Species<NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies>::getUseAngularDOFs() const
{
    return FrictionForceSpecies::getUseAngularDOFs();
}
 
template<class NormalForceSpecies, class FrictionForceSpecies, class AdhesiveForceSpecies>
void Species<NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies>::mixAll(BaseSpecies* const S UNUSED,
                                                                                     BaseSpecies* const T UNUSED)
{
    logger(ERROR, "%::mix() This function should not be called", getName());
}
 
#endif