AngledPeriodicBoundary.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 AngledPeriodicBoundary_H
#define AngledPeriodicBoundary_H

#include "BaseBoundary.h"
#include "Math/Vector.h"
#include "Math/Matrix.h"

class BaseParticle;
class ParticleHandler;

class AngledPeriodicBoundary : public BaseBoundary
{
public:
    
    AngledPeriodicBoundary* copy() const final;
    
    //todo constructors instead of set functions?
    //AngledPeriodicBoundary (Vec3D normal_left_, Vec3D normal_right_, Vec3D origin_) 
    
    void set(Vec3D normalLeft, Vec3D normalRight, Vec3D origin);
    
    Mdouble distance(const BaseParticle &P);
    
    //this function should be cheap, as it has to be computed for all particles
    Mdouble distance(const Vec3D &P);
    
    void shiftPosition(BaseParticle* P);

    
    void shiftPositions(Vec3D&  P1, Vec3D& P2);

    void read(std::istream& is);
    
    void oldRead(std::istream& is);
    
    void write(std::ostream& os) const;
    
    virtual std::string getName() const;
    
    Vec3D& getNormal();

    Mdouble getOpeningAngle();

    void createPeriodicParticles(BaseParticle *P, ParticleHandler &pH);
    
    bool checkBoundaryAfterParticleMoved(BaseParticle *P, ParticleHandler &pH UNUSED);
    
private:
    //values set by the user
    Vec3D leftNormal_; 

    Vec3D rightNormal_;

    Vec3D origin_; 
    //values set by the code
    bool leftWall_;
    Vec3D leftRadialAxis_; 
    Vec3D rightRadialAxis_; 
    Vec3D differenceRadialAxis_;
    Vec3D differenceNormal_;

    Matrix3D rotateLeft; 

    Matrix3D rotateRight; 
    
    Vec3D commonAxis_;
    
    //Vec3D angularShift_;
};
#endif