MercuryDPM  Trunk
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Mercury2D.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 #ifndef MERCURY2D_H
27 #define MERCURY2D_H
28 
29 #include "MercuryBase.h"
30 #include <iostream>
31 
35 class Mercury2D : public MercuryBase
36 {
37 public:
41  Mercury2D();
42 
46  explicit Mercury2D(const DPMBase& other);
47 
51  Mercury2D(const Mercury2D& other);
52 
56  void constructor();
57 
61  std::vector<BaseParticle*> hGridFindParticleContacts(const BaseParticle* obj) override;
62 
63 protected:
67  virtual void hGridFindContactsWithinTargetCell(int x, int y, unsigned int l);
68 
72  virtual void hGridFindContactsWithTargetCell(int x, int y, unsigned int l, BaseParticle* obj);
73 
75  virtual void
76  hGridFindParticlesWithTargetCell(int x, int y, unsigned int l, BaseParticle* obj, std::vector<BaseParticle*>& list);
77 
81  void hGridGetInteractingParticleList(BaseParticle* obj, std::vector<BaseParticle*>& list) override;
82 
86  void computeInternalForces(BaseParticle* obj) override;
87 
91  bool hGridHasContactsInTargetCell(int x, int y, unsigned int l, const BaseParticle* obj) const;
92 
96  bool hGridHasParticleContacts(const BaseParticle* obj) override;
97 
101  void hGridRemoveParticle(BaseParticle* obj) override;
102 
106  void hGridUpdateParticle(BaseParticle* obj) override;
107 
108 #ifdef CONTACT_LIST_HGRID
109 
112  void InsertCell(int x, int y, unsigned int l, BaseParticle *obj);
113 
117  void InsertObjAgainstGrid(BaseParticle *obj);
118 #endif
119 };
120 
121 #endif
The DPMBase header includes quite a few header files, defining all the handlers, which are essential...
Definition: DPMBase.h:72
bool hGridHasParticleContacts(const BaseParticle *obj) override
Test if a BaseParticle has any contacts in the HGrid.
Definition: Mercury2D.cc:448
void hGridGetInteractingParticleList(BaseParticle *obj, std::vector< BaseParticle * > &list) override
Obtains all neighbour particles of a given object, obtained from the hgrid.
Definition: Mercury2D.cc:161
virtual void hGridFindContactsWithTargetCell(int x, int y, unsigned int l, BaseParticle *obj)
Finds contacts between given BaseParticle and the BaseParticle in the target cell.
Definition: Mercury2D.cc:117
void hGridUpdateParticle(BaseParticle *obj) override
Updates the cell (not the level) of a BaseParticle.
Definition: Mercury2D.cc:320
virtual void hGridFindContactsWithinTargetCell(int x, int y, unsigned int l)
Finds contacts between particles the in the target cell.
Definition: Mercury2D.cc:72
virtual void hGridFindParticlesWithTargetCell(int x, int y, unsigned int l, BaseParticle *obj, std::vector< BaseParticle * > &list)
Definition: Mercury2D.cc:140
void constructor()
Function that sets the ParticleDimensions and SystemDimensions to 2.
Definition: Mercury2D.cc:59
void computeInternalForces(BaseParticle *obj) override
Finds contacts with the BaseParticle; avoids multiple checks.
Definition: Mercury2D.cc:204
This is the base class for both Mercury2D and Mercury3D. Note the actually abstract grid is defined i...
Definition: MercuryBase.h:125
bool hGridHasContactsInTargetCell(int x, int y, unsigned int l, const BaseParticle *obj) const
Tests if the BaseParticle has contacts with other Particles in the target cell.
Definition: Mercury2D.cc:420
Mercury2D()
This is the default constructor. All it does is set sensible defaults.
Definition: Mercury2D.cc:29
std::vector< BaseParticle * > hGridFindParticleContacts(const BaseParticle *obj) override
Returns all particles that have a contact with a given particle.
Definition: Mercury2D.cc:498
This adds on the hierarchical grid code for 2D problems.
Definition: Mercury2D.h:35
void hGridRemoveParticle(BaseParticle *obj) override
Removes a BaseParticle to the HGrid.
Definition: Mercury2D.cc:378