Chaste  Build::
Owen11CaUpdateRule.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 OWEN11CAUPDATERULE_HPP_
37 #define OWEN11CAUPDATERULE_HPP_
38 
39 #include "ChasteSerialization.hpp"
40 #include <boost/serialization/base_object.hpp>
41 #include "AbstractCaUpdateRule.hpp"
42 #include "CaBasedCellPopulation.hpp"
43 #include "VesselNetwork.hpp"
44 #include "UnitCollection.hpp"
45 #include "RegularGrid.hpp"
46 
64 template<unsigned DIM>
66 {
67 friend class TestCaUpdateRules;
68 
69 private:
70 
74  units::quantity<unit::diffusivity> mDiffusionParameter;
75 
79  boost::shared_ptr<VesselNetwork<DIM> > mpVesselNetwork;
80 
84  boost::shared_ptr<RegularGrid<DIM> > mpRegularGrid;
85 
89  units::quantity<unit::length> mReferenceLengthScale;
90 
95 
96  friend class boost::serialization::access;
104  template<class Archive>
105  void serialize(Archive & archive, const unsigned int version)
106  {
107  archive & boost::serialization::base_object<AbstractCaUpdateRule<DIM> >(*this);
108  archive & mDiffusionParameter;
109  archive & mReferenceLengthScale;
110  archive & mCancerCellCarryingCapacity;
111  }
112 
113 public:
114 
119 
124 
138  double EvaluateProbability(unsigned currentNodeIndex,
139  unsigned targetNodeIndex,
140  CaBasedCellPopulation<DIM>& rCellPopulation,
141  double dt,
142  double deltaX,
143  CellPtr cell);
144 
148  units::quantity<unit::diffusivity> GetDiffusionParameter();
149 
155  void SetVesselNetwork(boost::shared_ptr<VesselNetwork<DIM> > pVesselNetwork);
156 
162  void SetRegularGrid(boost::shared_ptr<RegularGrid<DIM> > pRegularGrid);
163 
169  void SetReferenceLengthScale(units::quantity<unit::length> referenceLengthScale);
170 
176  void SetDiffusionParameter(units::quantity<unit::diffusivity> diffusionParameter);
177 
183  void OutputUpdateRuleParameters(out_stream& rParamsFile);
184 };
185 
186 #include "SerializationExportWrapper.hpp"
187 EXPORT_TEMPLATE_CLASS_SAME_DIMS(Owen11CaUpdateRule)
188 
189 #endif /*OWEN11CAUPDATERULE_HPP_*/
unsigned mCancerCellCarryingCapacity
void SetVesselNetwork(boost::shared_ptr< VesselNetwork< DIM > > pVesselNetwork)
boost::shared_ptr< VesselNetwork< DIM > > mpVesselNetwork
void OutputUpdateRuleParameters(out_stream &rParamsFile)
units::quantity< unit::length > mReferenceLengthScale
units::quantity< unit::diffusivity > mDiffusionParameter
double EvaluateProbability(unsigned currentNodeIndex, unsigned targetNodeIndex, CaBasedCellPopulation< DIM > &rCellPopulation, double dt, double deltaX, CellPtr cell)
units::quantity< unit::diffusivity > GetDiffusionParameter()
void SetReferenceLengthScale(units::quantity< unit::length > referenceLengthScale)
void SetDiffusionParameter(units::quantity< unit::diffusivity > diffusionParameter)
boost::shared_ptr< RegularGrid< DIM > > mpRegularGrid
void serialize(Archive &archive, const unsigned int version)
void SetRegularGrid(boost::shared_ptr< RegularGrid< DIM > > pRegularGrid)