MercuryDPM  Beta
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
DeletionBoundary.cc
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 #include <limits>
27 
28 #include "DeletionBoundary.h"
29 #include "ParticleHandler.h"
30 #include "Particles/BaseParticle.h"
31 
36  : BaseBoundary()
37 {
38  distance_ = std::numeric_limits<double>::quiet_NaN();
39  scaleFactor_ = std::numeric_limits<double>::quiet_NaN();
40 #ifdef DEBUG_CONSTRUCTOR
41  std::cout<<"DeletionBoundary::DeletionBoundary() finished"<<std::endl;
42 #endif
43 }
44 
49 {
50 #ifdef DEBUG_DESTRUCTOR
51  std::cout<<"DeletionBoundary::~DeletionBoundary() finished"<<std::endl;
52 #endif
53 }
54 
61 {
62  return new DeletionBoundary(*this);
63 }
64 
79 void DeletionBoundary::set(const Vec3D& normal, Mdouble distance)
80 {
81  scaleFactor_ = 1. / std::sqrt(Vec3D::dot(normal, normal));
82  normal_ = normal * scaleFactor_;
83  distance_ = distance * scaleFactor_;
84 }
85 
92 {
93  distance_ = distance * scaleFactor_;
94 }
95 
101  {
102  return distance_ - Vec3D::dot(position, normal_);
103 }
104 
115 {
116  if (getDistance(p->getPosition()) < 0)
117  {
118  pH.removeObject(p->getIndex());
119  return true;
120  }
121  else
122  return false;
123 }
124 
129 void DeletionBoundary::read(std::istream& is)
130 {
131  BaseBoundary::read(is);
132  std::string dummy;
133  is >> dummy >> normal_
134  >> dummy >> scaleFactor_
135  >> dummy >> distance_;
136 }
137 
143 void DeletionBoundary::oldRead(std::istream& is)
144 {
145  std::string dummy;
146  is >> dummy >> normal_ >> dummy >> scaleFactor_ >> dummy >> distance_;
147 }
148 
153 void DeletionBoundary::write(std::ostream& os) const
154  {
156  os << " normal " << normal_
157  << " scaleFactor " << scaleFactor_
158  << " distance " << distance_;
159 }
160 
165 std::string DeletionBoundary::getName() const
166 {
167  return "DeletionBoundary";
168 }
169 
unsigned int getIndex() const
Returns the index of the object in the handler.
Definition: BaseObject.cc:106
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.
void write(std::ostream &os) const =0
Adds object's id_ to given ostream NB: purely virtual function.
Definition: BaseBoundary.cc:76
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.
static Mdouble dot(const Vec3D &a, const Vec3D &b)
Calculates the dot product of two Vec3D: .
Definition: Vector.cc:187
const Vec3D & getPosition() const
Returns the position of this BaseInteractable.
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
virtual void removeObject(unsigned const int id)
Removes a BaseParticle from the ParticleHandler.
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.
void read(std::istream &is)=0
Reads the object's id_ from given istream NB: purely virtual function.
Definition: BaseBoundary.cc:67