MercuryDPM  Alpha
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
LiquidFilmParticle.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 LiquidFilmParticle_H
27 #define LiquidFilmParticle_H
28 
29 #include "BaseParticle.h"
35 {
36 public:
41 
46 
50  virtual ~LiquidFilmParticle();
51 
55  virtual LiquidFilmParticle* copy() const;
56 
57 
58  void write(std::ostream& os) const;
59 
60  std::string getName() const;
61 
62  void read(std::istream& is);
63 
64  Mdouble getLiquidVolume() const;
65 
66  void setLiquidVolume(Mdouble liquidVolume);
67 
68  void addLiquidVolume(Mdouble liquidVolume);
69 
70  unsigned getNumberOfFieldsVTK() const;
71 
72  std::string getTypeVTK(unsigned i) const;
73 
74  std::string getNameVTK(unsigned i) const;
75 
76  std::vector<Mdouble> getFieldVTK(unsigned i) const;
77 
78 private:
79 
81 };
82 #endif
virtual ~LiquidFilmParticle()
Particle destructor, needs to be implemented and checked if it removes tangential spring information...
void addLiquidVolume(Mdouble liquidVolume)
virtual LiquidFilmParticle * copy() const
Particle copy method. It calls to copy constructor of this Particle, useful for polymorfism.
void read(std::istream &is)
double Mdouble
std::string getTypeVTK(unsigned i) const
unsigned getNumberOfFieldsVTK() const
void write(std::ostream &os) const
std::vector< Mdouble > getFieldVTK(unsigned i) const
void setLiquidVolume(Mdouble liquidVolume)
std::string getNameVTK(unsigned i) const
Mdouble getLiquidVolume() const
std::string getName() const
LiquidFilmParticle()
Basic Particle constructor, creates an Particle at (0,0,0) with radius, mass and inertia equal to 1...