CubeDeletionBoundary.h
Go to the documentation of this file.
1 //Copyright (c) 2013-2023, 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 #ifndef CUBEDELETIONBOUNDARY_H
27 #define CUBEDELETIONBOUNDARY_H
28 
29 #include "DeletionBoundary.h"
30 #include "BaseBoundary.h"
31 #include "Math/Vector.h"
32 
33 class ParticleHandler;
34 
35 class BaseParticle;
36 
38 {
39 public:
44 
48  ~CubeDeletionBoundary() override;
49 
53  CubeDeletionBoundary* copy() const override;
54 
58  void set(Vec3D posMin, Vec3D posMax);
59 
63  Mdouble getDistance(const Vec3D& position) const override;
64 
68  void read(std::istream& is) override;
69 
73  void write(std::ostream& os) const override;
74 
78  std::string getName() const override;
79 
80 private:
81 
86 };
87 
88 #endif
Definition: BaseParticle.h:54
Definition: CubeDeletionBoundary.h:38
void set(Vec3D posMin, Vec3D posMax)
Sets boundary position based on two opposite corners.
Definition: CubeDeletionBoundary.cc:46
Mdouble getDistance(const Vec3D &position) const override
Returns a negative value if and only if the particle is inside the boundary.
Definition: CubeDeletionBoundary.cc:60
void write(std::ostream &os) const override
writes boundary properties to ostream
Definition: CubeDeletionBoundary.cc:79
void read(std::istream &is) override
reads boundary properties from istream
Definition: CubeDeletionBoundary.cc:71
CubeDeletionBoundary * copy() const override
Copy method; creates copy on the heap and returns a pointer to it.
Definition: CubeDeletionBoundary.cc:52
std::string getName() const override
Returns the name of the object.
Definition: CubeDeletionBoundary.cc:89
Vec3D posMin_
Minimal and maximal positions defining the boundary's boundaries.
Definition: CubeDeletionBoundary.h:85
CubeDeletionBoundary()
default constructor
Definition: CubeDeletionBoundary.cc:34
~CubeDeletionBoundary() override
destructor
Definition: CubeDeletionBoundary.cc:41
Vec3D posMax_
Definition: CubeDeletionBoundary.h:85
Used for removing particles from the problem. Inherits from BaseBoundary. By default,...
Definition: DeletionBoundary.h:44
Container to store all BaseParticle.
Definition: ParticleHandler.h:48
Definition: Vector.h:51