Chaste Commit::ca8ccdedf819b6e02855bc0e8e6f50bdecbc5208
WntConcentration.hpp
1/*
2
3Copyright (c) 2005-2024, University of Oxford.
4All rights reserved.
5
6University of Oxford means the Chancellor, Masters and Scholars of the
7University of Oxford, having an administrative office at Wellington
8Square, Oxford OX1 2JD, UK.
9
10This file is part of Chaste.
11
12Redistribution and use in source and binary forms, with or without
13modification, 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
23THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
24AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
27LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
29GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33
34*/
35
36#ifndef WNTCONCENTRATION_HPP_
37#define WNTCONCENTRATION_HPP_
38
40#include "SerializableSingleton.hpp"
41#include <boost/serialization/base_object.hpp>
42
43#include <iostream>
44
45#include "AbstractCellPopulation.hpp"
46
53typedef enum WntConcentrationType_
54{
55 NONE,
56 LINEAR,
57 RADIAL,
58 EXPONENTIAL
59} WntConcentrationType;
60
61
65template<unsigned DIM>
66class WntConcentration : public SerializableSingleton<WntConcentration<DIM> >
67{
68private:
69
72
77
82
89 WntConcentrationType mWntType;
90
95
100
105
111
122
129
136
145 template<class Archive>
146 void serialize(Archive & archive, const unsigned int version)
147 {
148 bool is_set_up = IsWntSetUp();
149 archive & is_set_up;
150 if (is_set_up)
151 {
152 archive & mCryptLength;
153 archive & mLengthSet;
154 archive & mWntType;
155 archive & mpCellPopulation;
156 archive & mTypeSet;
162 }
163 }
164
165protected:
166
171
172public:
173
180 static WntConcentration* Instance();
181
185 virtual ~WntConcentration();
186
191 static void Destroy();
192
199 double GetWntLevel(double height);
200
208 double GetWntLevel(CellPtr pCell);
209
215 c_vector<double, DIM> GetWntGradient(c_vector<double, DIM>& rLocation);
216
222 c_vector<double, DIM> GetWntGradient(CellPtr pCell);
223
229 void SetCellPopulation(AbstractCellPopulation<DIM>& rCellPopulation);
230
235
239 double GetCryptLength();
240
246 void SetCryptLength(double cryptLength);
247
251 WntConcentrationType GetType();
252
258 void SetType(WntConcentrationType type);
259
266 void SetConstantWntValueForTesting(double value);
267
278 bool IsWntSetUp();
279
284
290 void SetWntConcentrationParameter(double wntConcentrationParameter);
291
296
301
307 void SetCryptProjectionParameterA(double cryptProjectionParameterA);
308
314 void SetCryptProjectionParameterB(double cryptProjectionParameterB);
315};
316
317#endif /*WNTCONCENTRATION_HPP_*/
static WntConcentration * Instance()
static void Destroy()
void SetWntConcentrationParameter(double wntConcentrationParameter)
void serialize(Archive &archive, const unsigned int version)
AbstractCellPopulation< DIM > & rGetCellPopulation()
double GetCryptProjectionParameterB()
void SetType(WntConcentrationType type)
c_vector< double, DIM > GetWntGradient(c_vector< double, DIM > &rLocation)
void SetCellPopulation(AbstractCellPopulation< DIM > &rCellPopulation)
static WntConcentration * mpInstance
WntConcentrationType mWntType
double GetCryptProjectionParameterA()
void SetCryptProjectionParameterB(double cryptProjectionParameterB)
WntConcentrationType GetType()
double GetWntConcentrationParameter()
void SetCryptLength(double cryptLength)
AbstractCellPopulation< DIM > * mpCellPopulation
void SetCryptProjectionParameterA(double cryptProjectionParameterA)
friend class boost::serialization::access
double GetWntLevel(double height)
void SetConstantWntValueForTesting(double value)