MercuryDPM  Trunk
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
ChuteBottom.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 CHUTEBOTTOM_H
27 #define CHUTEBOTTOM_H
28 
29 #include "Chute.h"
30 
39 class ChuteBottom : public Chute
40 {
41 public:
42 
43  //constructors
47  ChuteBottom();
48 
52  explicit ChuteBottom(const DPMBase& other);
53 
57  explicit ChuteBottom(const MercuryBase& other);
58 
62  explicit ChuteBottom(const Mercury3D& other);
63 
67  explicit ChuteBottom(const Chute& other);
68 
72  ChuteBottom(const ChuteBottom& other);
73 
74  //setters and getters
78  Mdouble getThickness() const;
79 
83  void setThickness(Mdouble thickness);
84 
88  bool getIsBottomPeriodic() const;
89 
93  void setIsBottomPeriodic(bool isBottomPeriodic);
94 
95  //other public member functions
96 
100  void makeRoughBottom(Chute& chute);
101 
105  void setupInitialConditions() override;
106 
110  void actionsBeforeTimeStep() override;
111 
112 private:
117  void constructor();
118 
124 
129 };
130 
131 #endif
The DPMBase header includes quite a few header files, defining all the handlers, which are essential...
Definition: DPMBase.h:72
ChuteBottom()
This is the default constructor. All it does is set sensible defaults.
Definition: ChuteBottom.cc:38
double Mdouble
Definition: GeneralDefine.h:34
void setupInitialConditions() override
Sets up initial conditions before running a chute simulation.
Definition: ChuteBottom.cc:222
Used by Chute::createBottom to create an unordered particle layer.
Definition: ChuteBottom.h:39
void constructor()
This is the actual constructor METHOD; it is called by all constructors above (except the default cop...
Definition: ChuteBottom.cc:110
Mdouble thickness_
Thickness of the multilayer chute rough bottom. See also documentation of ChuteBottom::makeRoughBotto...
Definition: ChuteBottom.h:123
Creates chutes with different bottoms. Inherits from Mercury3D (-> MercuryBase -> DPMBase)...
Definition: Chute.h:64
This is the base class for both Mercury2D and Mercury3D. Note the actually abstract grid is defined i...
Definition: MercuryBase.h:125
void makeRoughBottom(Chute &chute)
Makes a multilayered rough bottom with thickness thickness_.
Definition: ChuteBottom.cc:139
void setIsBottomPeriodic(bool isBottomPeriodic)
Sets whether the bottom should be periodic in Y.
Definition: ChuteBottom.cc:372
Mdouble getThickness() const
Returns the thickness of the multilayer rough bottom.
Definition: ChuteBottom.cc:343
This adds on the hierarchical grid code for 3D problems.
Definition: Mercury3D.h:36
void setThickness(Mdouble thickness)
Sets the thickness of the multilayer rough bottom.
Definition: ChuteBottom.cc:353
bool isBottomPeriodic_
TRUE if the bottom is periodic in Y.
Definition: ChuteBottom.h:128
void actionsBeforeTimeStep() override
Performs all necessary actions before the start of a time step (none in this case) ...
Definition: ChuteBottom.cc:334
bool getIsBottomPeriodic() const
Returns TRUE if the bottom is periodic in Y.
Definition: ChuteBottom.cc:363