MercuryDPM  Alpha
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
DeletionBoundary.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 #ifndef DELETIONBOUNDARY_H
27 #define DELETIONBOUNDARY_H
28 
29 #include "BaseBoundary.h"
30 #include "Math/Vector.h"
31 
32 class ParticleHandler;
33 class BaseParticle;
34 
41 {
42 public:
54  DeletionBoundary* copy() const;
55 
59  void set(const Vec3D& normal, Mdouble distance);
60 
64  void move(Mdouble position);
65 
69  Mdouble getDistance(const Vec3D &position) const;
70 
75 
79  void read(std::istream& is);
80 
85  void oldRead(std::istream& is);
86 
90  void write(std::ostream& os) const;
91 
95  virtual std::string getName() const;
96 
97 private:
115 };
116 
117 #endif
Vec3D normal_
outward unit normal vector
void read(std::istream &is)
Reads some boundary properties from an std::istream.
virtual std::string getName() const
Returns the name of the object.
~DeletionBoundary()
destructor
void write(std::ostream &os) const
Writes the boundary properties to an std::ostream.
bool checkBoundaryAfterParticleMoved(BaseParticle *p, ParticleHandler &pH)
Checks if particle passed the boundary and deletes the particle if so.
double Mdouble
Used for removing particles from the problem. Inherits from BaseBoundary.
Mdouble scaleFactor_
This is the factor to rescale the given normal vector to a unit vectors.
#define MERCURY_DEPRECATED
Definition: GeneralDefine.h:37
DeletionBoundary * copy() const
Copy method; creates copy on the heap and returns a pointer to it.
DeletionBoundary()
default constructor
Mdouble getDistance(const Vec3D &position) const
Returns the shortest distance between the boundary and given position.
MERCURY_DEPRECATED void oldRead(std::istream &is)
Deprecated read method. use DeletionBoundary::read() instead.
Mdouble distance_
The boundary's distance from the origin.
Container to store all BaseParticle.
Implementation of a 3D vector (by Vitaliy).
Definition: Vector.h:45
void move(Mdouble position)
Sets the boundary's distance property to the given one.
void set(const Vec3D &normal, Mdouble distance)
Sets boundary position based on a normal and distance.