WallHandler.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 WALLHANDLER_H
#define WALLHANDLER_H
 
#include "BaseHandler.h"
#include "Walls/BaseWall.h"
#include "File.h"
 
class BaseWall;
 
class WallHandler final : public BaseHandler<BaseWall>
{
public:
    WallHandler();
 
    WallHandler(const WallHandler& BH);
 
    WallHandler& operator=(const WallHandler& rhs);
    
    ~WallHandler() final;
 
    void addObject(BaseWall* W) final;
 
    static BaseWall* createObject(const std::string& type);
 
    BaseWall* readAndCreateObject(std::istream& is);
 
    void readAndAddObject(std::istream& is) final;
 
    std::string getName() const final;
 
    unsigned readTriangleWall(std::string filename, ParticleSpecies* species, Mdouble scaleFactor = 1, Vec3D centerOfRotation = {0,0,0}, Vec3D velocity = {0,0,0}, Vec3D angularVelocity = {0,0,0});
 
    void actionsAfterParticleGhostUpdate();
 
    void setWriteVTK(FileType);
 
    void setWriteVTK(bool);
 
    FileType getWriteVTK() const;
 
    enum class DetailsVTKOptions
    {
        // Used as keys for an unordered_map.
        // The actual enum values are written to the restart file and their meaning should therefore never change.
        // So when adding new options, be sure to hardcode a unique enum value!
        // The options can be in any order and their values are completely free to choose, as long as they're unique.
 
        BOUNDINGBOX = 0,
 
        NURBSWALL = 1,
 
        WEARABLENURBSWALL = 2
    };
 
    void setWriteDetailsVTK(DetailsVTKOptions, FileType);
 
    void setWriteDetailsVTK(DetailsVTKOptions, bool);
 
    FileType getWriteDetailsVTK(DetailsVTKOptions) const;
 
    bool getWriteDetailsVTKAny() const;
 
    std::unordered_map<DetailsVTKOptions, FileType> getWriteWallDetailsVTKAll() const;
 
    void writeWallDetailsVTKBoundingBox(VTKData& data) const;
 
    void setWriteWallSurfaceAreaVTK(bool writeWallSurfaceAreaVTK);
 
    bool getWriteWallSurfaceAreaVTK() const;
 
private:
 
    BaseWall* readAndCreateOldObject(std::istream& is);
 
    FileType writeVTK_;
 
    std::unordered_map<DetailsVTKOptions, FileType> writeDetailsVTK_;
};
 
#endif