MercuryDPM  Alpha
 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-2014, 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 : public BaseHandler<BaseWall>
43 {
44 public:
48  WallHandler();
49 
53  WallHandler(const WallHandler& BH);
54 
59 
63  ~WallHandler();
64 
68  void addObject(BaseWall* W);
69 
73  void readObject(std::istream& is);
74 
78  void readOldObject(std::istream& is);
79 
83  std::string getName() const;
84 
88  void writeVTKFile(const VTKContainer vtk) const;
89 
93  void writeVTKBoundingBox() const;
94 
99  void writeVTK() const;
100 
101 };
102 
103 #endif
104 
void readOldObject(std::istream &is)
Reads a BaseWall into the WallHandler from old-style restart data.
Definition: WallHandler.cc:190
void readObject(std::istream &is)
Reads BaseWall into the WallHandler from restart data.
Definition: WallHandler.cc:109
void writeVTKFile(const VTKContainer vtk) const
Writes the data collected in writeVTK into vtk files, one per timestep.
Definition: WallHandler.cc:267
void writeVTKBoundingBox() const
Writes a bounding box around the domain into a vtk file.
Definition: WallHandler.cc:341
WallHandler()
Default constructor, it creates an empty WallHandler.
Definition: WallHandler.cc:42
Container to store the pointers to all objects that one creates in a simulation.
Definition: BaseHandler.h:51
Basic class for walls.
Definition: BaseWall.h:44
Container to store all BaseWall.
Definition: WallHandler.h:42
void addObject(BaseWall *W)
Adds a BaseWall to the WallHandler.
Definition: WallHandler.cc:92
WallHandler operator=(const WallHandler &rhs)
Assignment operator that copies the pointer to the DPMBase and all BaseWall in the given WallHandler...
Definition: WallHandler.cc:70
~WallHandler()
Destructor, it destructs the WallHandler and all BaseWall it contains.
Definition: WallHandler.cc:82
void writeVTK() const
Writes all walls into a vtk format, consisting of points (edges) and cells (faces).
Definition: WallHandler.cc:239
std::string getName() const
Returns the name of the handler, namely the string "WallHandler".
Definition: WallHandler.cc:227