BaseWall.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 BASEWALL_H
#define BASEWALL_H

#include "BaseInteractable.h"
#include "Particles/SuperQuadricParticle.h"

class WallHandler;

class BaseParticle;

struct VTKContainer
{
    std::vector<Vec3D> points;
    std::vector<std::vector<double>> triangleStrips;
};

class BaseWall : public BaseInteractable
{
public:
    BaseWall();
    
    BaseWall(const BaseWall& w);
    
    ~BaseWall() override;
    
    virtual BaseWall* copy() const = 0;
    
    void read(std::istream& is) override;
    
    void write(std::ostream& os) const override;
    
    virtual bool getDistanceAndNormal(const BaseParticle& P, Mdouble& distance, Vec3D& normal_return) const = 0;
    
    
    virtual bool
    getDistanceNormalOverlap(const BaseParticle& P, Mdouble& distance, Vec3D& normal_return, Mdouble& overlap) const;
    
    virtual bool getDistanceNormalOverlapSuperquadric(const SuperQuadricParticle& p, Mdouble& distance, Vec3D& normal_return,
                                                      Mdouble& overlap) const;
    
    virtual Vec3D
    getFurthestPointSuperQuadric(const Vec3D& normalBodyFixed, const Vec3D& axes, Mdouble eps1, Mdouble eps2) const;
    
    virtual void setHandler(WallHandler* handler);
    
    WallHandler* getHandler() const;
    
    void setIndSpecies(unsigned int indSpecies) override;
    
    void setSpecies(const ParticleSpecies* species);
    
    bool isFixed() const override;

    void setForceControl(Vec3D forceGoal, Vec3D gainFactor, Vec3D baseVelocity={0,0,0});
    
    virtual bool isLocal(Vec3D& min, Vec3D& max) const
    { return false; }
    
    // returns the point intersecting a wall (x-p).n=0 and a line x=p0+t(p1-p0)
    bool getLinePlaneIntersect(Vec3D& intersect, const Vec3D& p0, const Vec3D& p1, const Vec3D& n, const Vec3D& p);
    bool isInsideWallVTK(const Vec3D& point, const Vec3D& normal, const Vec3D& position) const;
    
    void projectOntoWallVTK(Vec3D& point0, const Vec3D& point1, const Vec3D& normal, const Vec3D& position) const;
    
    void intersectVTK(std::vector<Vec3D>& points, Vec3D normal, Vec3D position) const;
    
    
    virtual BaseInteraction*
    getInteractionWithSuperQuad(SuperQuadricParticle* p, unsigned timeStamp, InteractionHandler* interactionHandler);
    
    virtual void writeVTK(VTKContainer& vtk) const;
    
    void getVTK(std::vector<Vec3D>& points, std::vector<std::vector<double>>& triangleStrips)
    {}
    
    const Vec3D getAxis() const;
    
    BaseInteraction*
    getInteractionWith(BaseParticle* p, unsigned timeStamp, InteractionHandler* interactionHandler) override;
    
    virtual void actionsOnRestart() {}
    
    virtual void actionsAfterParticleGhostUpdate() {}
    
    virtual void handleParticleAddition(unsigned int id, BaseParticle* p) {}
    
    virtual void handleParticleRemoval(unsigned int id) {}
    
    virtual void checkInteractions(InteractionHandler* interactionHandler, unsigned int timeStamp) {}
    
    bool getVTKVisibility() const;
    
    void setVTKVisibility(bool vtkVisibility);
    
    static void addToVTK(const std::vector<Vec3D>& points, VTKContainer& vtk);
    
    //todo how do i write a copy and add function?
    void addRenderedWall(BaseWall* w);

    BaseWall* getRenderedWall(size_t i) const;

    void removeRenderedWalls();

    void renderWall(VTKContainer& vtk);

    void addParticlesAtWall(unsigned numElements = 50);

    void setVelocityControl(Vec3D forceGoal, Vec3D gainFactor, Vec3D baseVelocity);

private:
    WallHandler* handler_; 
    
    bool vtkVisibility_ = true;
    
    std::vector<BaseWall*> renderedWalls_;

};

#endif