MercuryDPM  Trunk
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
BoundaryHandler.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 BOUNDARYHANDLER_H
28 #define BOUNDARYHANDLER_H
29 
30 #include "BaseHandler.h"
32 
38 class BoundaryHandler final : public BaseHandler<BaseBoundary>
39 {
40 public:
45 
50 
55 
59  ~BoundaryHandler() final;
60 
64  void addObject(BaseBoundary* P) final;
65 
66  static BaseBoundary* createObject(const std::string& type);
67 
71  void readAndAddObject(std::istream& is) final;
72 
76  void readOldObject(std::istream& is);
77 
81  std::string getName() const final;
82 
84 
85 private:
86  bool writeVTK_;
87 public:
89 
90  bool getWriteVTK() const { return writeVTK_; }
91 };
92 
93 #endif
94 
virtual void writeVTK() const
now empty function for writing VTK files.
Definition: BaseHandler.h:286
Container to store pointers to all BaseBoundary objects.
bool getWriteVTK() const
BoundaryHandler()
Default constructor, it creates an empty BoundaryHandler.
void readOldObject(std::istream &is)
Reads a periodic boundary from old-style restart data.
void readAndAddObject(std::istream &is) final
Reads BaseBoundary into the BoundaryHandler from restart data.
void setWriteVTK(bool writeVTK)
~BoundaryHandler() final
Destructor, it destructs the BoundaryHandler and all BaseBoundary it contains.
Container to store the pointers to all objects that one creates in a simulation.
Definition: BaseHandler.h:50
static BaseBoundary * createObject(const std::string &type)
BoundaryHandler & operator=(const BoundaryHandler &rhs)
Assignment operator, copies only the vector of BaseBoundary and sets the other variables to 0/nullptr...
void boundaryActionsBeforeTimeLoop()
std::string getName() const final
Returns the name of the handler, namely the string "BoundaryHandler".
void addObject(BaseBoundary *P) final
Adds a BaseBoundary to the BoundaryHandler.