Chaste  Release::3.4
DiffusionForce.hpp
1 /*
2 
3 Copyright (c) 2005-2016, University of Oxford.
4 All rights reserved.
5 
6 University of Oxford means the Chancellor, Masters and Scholars of the
7 University of Oxford, having an administrative office at Wellington
8 Square, Oxford OX1 2JD, UK.
9 
10 This file is part of Chaste.
11 
12 Redistribution and use in source and binary forms, with or without
13 modification, are permitted provided that the following conditions are met:
14  * Redistributions of source code must retain the above copyright notice,
15  this list of conditions and the following disclaimer.
16  * Redistributions in binary form must reproduce the above copyright notice,
17  this list of conditions and the following disclaimer in the documentation
18  and/or other materials provided with the distribution.
19  * Neither the name of the University of Oxford nor the names of its
20  contributors may be used to endorse or promote products derived from this
21  software without specific prior written permission.
22 
23 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
24 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
27 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
29 GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32 OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 
34 */
35 
36 #ifndef DIFFUSIONFORCE_HPP_
37 #define DIFFUSIONFORCE_HPP_
38 
39 #include "ChasteSerialization.hpp"
40 #include <boost/serialization/base_object.hpp>
41 
42 #include "AbstractForce.hpp"
43 #include "AbstractOffLatticeCellPopulation.hpp"
44 #include "RandomNumberGenerator.hpp"
45 
51 template<unsigned DIM>
52 class DiffusionForce : public AbstractForce<DIM>
53 {
54 private :
55 
60 
66  double mViscosity;
67 
72  static const double msBoltzmannConstant;
73 
85  template<class Archive>
86  void serialize(Archive & archive, const unsigned int version)
87  {
88  archive & boost::serialization::base_object<AbstractForce<DIM> >(*this);
89  archive & mAbsoluteTemperature;
90  archive & mViscosity;
91  }
92 
93 public :
94 
99 
103  ~DiffusionForce();
104 
111  void SetAbsoluteTemperature(double absoluteTemperature);
112 
119  void SetViscosity(double viscosity);
120 
126  double GetAbsoluteTemperature();
127 
133  double GetViscosity();
134 
141 
148  void AddForceContribution(AbstractCellPopulation<DIM>& rCellPopulation);
149 
155  void OutputForceParameters(out_stream& rParamsFile);
156 };
157 
160 
161 #endif /*DIFFUSIONFORCE_HPP_*/
void serialize(Archive &archive, const unsigned int version)
double GetAbsoluteTemperature()
friend class boost::serialization::access
double GetViscosity()
#define EXPORT_TEMPLATE_CLASS_SAME_DIMS(CLASS)
double GetDiffusionScalingConstant()
static const double msBoltzmannConstant
double mAbsoluteTemperature
void AddForceContribution(AbstractCellPopulation< DIM > &rCellPopulation)
void SetViscosity(double viscosity)
void OutputForceParameters(out_stream &rParamsFile)
void SetAbsoluteTemperature(double absoluteTemperature)