MercuryDPM  Trunk
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
ThermalParticle.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 ThermalParticle_H
27 #define ThermalParticle_H
28 
29 #include "BaseParticle.h"
30 
35 class ThermalParticle final : public BaseParticle
36 {
37 public:
42 
47 
51  ~ThermalParticle() override;
52 
56  ThermalParticle* copy() const override;
57 
58 
59  void write(std::ostream& os) const override;
60 
61  std::string getName() const override;
62 
63  void read(std::istream& is) override;
64 
65  Mdouble getTemperature() const;
66 
67  void setTemperature(Mdouble temperature);
68 
69  void addTemperature(Mdouble temperature);
70 
71  void setTemperatureDependentDensity(const std::function<double(double)>& temperatureDependentDensity);
72 
73  const std::function<double(double)>& getTemperatureDependentDensity() const;
74 
75  const std::function<double(double)>& getTimeDependentTemperature() const;
76 
77  void setTimeDependentTemperature(const std::function<double(double)>& timeDependentTemperature);
78 
79  void actionsAfterTimeStep() override;
80 
81  bool isSphericalParticle() const override {return true;}
82 
83 private:
84 
88  std::function<double(double temperature)> timeDependentTemperature_;
89 
91 };
92 
93 #endif
ThermalParticle * copy() const override
Particle copy method. It calls to copy constructor of this Particle, useful for polymorfism.
void actionsAfterTimeStep() override
std::string getName() const override
double Mdouble
Definition: GeneralDefine.h:34
void setTemperatureDependentDensity(const std::function< double(double)> &temperatureDependentDensity)
~ThermalParticle() override
Particle destructor, needs to be implemented and checked if it removes tangential spring information...
Mdouble getTemperature() const
ThermalParticle()
Basic Particle constructor, creates a particle at (0,0,0) with radius, mass and inertia equal to 1...
const std::function< double(double)> & getTemperatureDependentDensity() const
void addTemperature(Mdouble temperature)
const std::function< double(double)> & getTimeDependentTemperature() const
std::function< double(double temperature)> timeDependentTemperature_
void setTemperature(Mdouble temperature)
bool isSphericalParticle() const override
void read(std::istream &is) override
void write(std::ostream &os) const override
void setTimeDependentTemperature(const std::function< double(double)> &timeDependentTemperature)