MercuryDPM  Trunk
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
WallHandler.h
Go to the documentation of this file.
1 //Copyright (c) 2013-2020, The MercuryDPM Developers Team. All rights reserved.
2 //For the list of developers, see <http://www.MercuryDPM.org/Team>.
3 //
4 //Redistribution and use in source and binary forms, with or without
5 //modification, are permitted provided that the following conditions are met:
6 // * Redistributions of source code must retain the above copyright
7 // notice, this list of conditions and the following disclaimer.
8 // * Redistributions in binary form must reproduce the above copyright
9 // notice, this list of conditions and the following disclaimer in the
10 // documentation and/or other materials provided with the distribution.
11 // * Neither the name MercuryDPM nor the
12 // names of its contributors may be used to endorse or promote products
13 // derived from this software without specific prior written permission.
14 //
15 //THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
16 //ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
17 //WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18 //DISCLAIMED. IN NO EVENT SHALL THE MERCURYDPM DEVELOPERS TEAM BE LIABLE FOR ANY
19 //DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
20 //(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
21 //LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
22 //ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 //(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
24 //SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 
26 
27 #ifndef WALLHANDLER_H
28 #define WALLHANDLER_H
29 
30 #include "BaseHandler.h"
31 #include "Walls/BaseWall.h"
32 
33 class BaseWall;
34 
42 class WallHandler final : public BaseHandler<BaseWall>
43 {
44 public:
48  WallHandler();
49 
53  WallHandler(const WallHandler& BH);
54 
58  WallHandler& operator=(const WallHandler& rhs);
59 
63  ~WallHandler() final;
64 
68  void addObject(BaseWall* W) final;
69 
73  static BaseWall* createObject(const std::string& type);
74 
78  BaseWall* readAndCreateObject(std::istream& is);
79 
83  void readAndAddObject(std::istream& is) final;
84 
88  std::string getName() const final;
89 
94  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});
95 
96 private:
97 
101  BaseWall* readAndCreateOldObject(std::istream& is);
102 
106  void writeVTKBoundingBox() const;
107 
108 };
109 
110 #endif
111 
void readAndAddObject(std::istream &is) final
Create a new wall in the WallHandler, based on the information provided in a restart file...
Definition: WallHandler.cc:276
double Mdouble
Definition: GeneralDefine.h:34
void addObject(BaseWall *W) final
Adds a BaseWall to the WallHandler.
Definition: WallHandler.cc:108
~WallHandler() final
Destructor, it destructs the WallHandler and all BaseWall it contains.
Definition: WallHandler.cc:96
BaseWall * readAndCreateObject(std::istream &is)
Create a new wall, based on the information provided in a restart file.
Definition: WallHandler.cc:190
std::string getName() const final
Returns the name of the handler, namely the string "WallHandler".
Definition: WallHandler.cc:287
static BaseWall * createObject(const std::string &type)
Create a new wall, with the type given as a string (required for restarting).
Definition: WallHandler.cc:122
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})
Reads triangulated walls from vtk or stl files, and converts them into a set of TriangleWalls.
Definition: WallHandler.cc:357
WallHandler & operator=(const WallHandler &rhs)
Assignment operator that copies the pointer to the DPMBase and all BaseWall in the given WallHandler...
Definition: WallHandler.cc:82
BaseWall * readAndCreateOldObject(std::istream &is)
Create a new wall, based on the information from old-style restart data.
Definition: WallHandler.cc:236
void writeVTKBoundingBox() const
Writes a bounding box around the domain into a vtk file.
Definition: WallHandler.cc:297
WallHandler()
Default constructor, it creates an empty WallHandler.
Definition: WallHandler.cc:50
Container to store the pointers to all objects that one creates in a simulation.
Definition: BaseHandler.h:50
Basic class for walls.
Definition: BaseWall.h:47
Container to store all BaseWall.
Definition: WallHandler.h:42
Definition: Vector.h:49