MpiDataClass.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 MPIDATACLASS_H_
#define MPIDATACLASS_H_
 
#include <Particles/SphericalParticle.h>
#include "Particles/BaseParticle.h"
#include "ParticleHandler.h"
 
class SuperQuadricParticle;
 
class MPISphericalParticle
{
public:
    unsigned int id;
    unsigned int indSpecies;
    unsigned int HGridLevel;
    Mdouble radius;
    Vec3D position;
    Vec3D angularVelocity;
    Vec3D velocity;
    Quaternion orientation;
    unsigned communicationComplexity;
    bool isMaser; //TODO 
    bool isFixed;
    void copyDataFromMPIParticleToParticle(BaseParticle* p);
    void copyDataFromParticleToMPIParticle(BaseParticle* p);
    static BaseParticle* newParticle ();
};
 
class MPISuperQuadric : public MPISphericalParticle
{
public:
    Vec3D axes;
    Mdouble epsilon1;
    Mdouble epsilon2;
    void copyDataFromMPIParticleToParticle(BaseParticle* p);
    void copyDataFromParticleToMPIParticle(BaseParticle* p);
    static BaseParticle* newParticle ();
};
 
class MPILiquidFilmParticle : public MPISphericalParticle
{
public:
    Mdouble liquidVolume;
    void copyDataFromMPIParticleToParticle(BaseParticle* p);
    void copyDataFromParticleToMPIParticle(BaseParticle* p);
    static BaseParticle* newParticle ();
};
 
class MPIParticle : public MPISphericalParticle {};
//to run simulations with LiquidFilmParticles in parallel, uncomment the line below (and comment the line above).
//class MPIParticle : public MPILiquidFilmParticle {};
 
class MPIParticlePosition
{
public:
    unsigned int id;
    Vec3D position;
    Quaternion orientation;
    Mdouble liquidVolume;
};
 
class MPIParticleVelocity
{
public:
    Vec3D velocity;
    Vec3D angularVelocity;
};
 
class MPIParticleForce
{
public:
    Vec3D force;
    Vec3D torque;
};
 
class Empty
{
};
 
class MpiPeriodicParticleIDBase
{
public:
    BaseParticle* particle; //Used to store the pointer of the current particle (ghost or periodic) located on the same domain
    BaseParticle* otherParticle; //Used to store the pointer of the other particle (ghost or periodic) located on the same domain
    //int currentProcessor;
    //int otherProcessor;
    int targetProcessor; //Stores the target processor where the ghost or periodic is located
    //int targetID;
    //int periodicBoundaryIndex;
    //std::vector<int> previousPeriodicComplexity;
    //std::vector<int> currentPeriodicComplexity;
    std::vector<int> periodicComplexity; //Not sure if this is required
    std::vector<int> targetPeriodicComplexity; //ppid uses this to store the ghost periodic complexity when adding
    std::vector<int> realPeriodicComplexity; //gpid uses this to store the realPeriodicComplexity of the real particle
    //std::vector<int> previousRealPeriodicComplexity;
    //Vec3D targetPosition;
};
 
typedef MpiPeriodicParticleIDBase MpiPeriodicParticleID;
typedef MpiPeriodicParticleIDBase MpiPeriodicGhostParticleID;
 
MPIParticle copyDataFromParticleToMPIParticle(BaseParticle* p);
 
void copyDataFromMPIParticleToParticle(MPIParticle* bP, BaseParticle* p, ParticleHandler* particleHandler);
 
MPIParticlePosition copyPositionFrom(BaseParticle* particle);
 
MPIParticleVelocity copyVelocityFrom(BaseParticle* particles);
 
Vec3D getMPISum(Vec3D& val);
 
double getMPISum(double val);
 
#endif  /* MPIDATACLASS_H_ */