Chaste Commit::30a3e656d4b131f8c595cc6eb2becd297337570f
CellwiseSourceParabolicPde.hpp
1/*
2
3Copyright (c) 2005-2025, 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 CELLWISESOURCEPARABOLICPDE_HPP_
37#define CELLWISESOURCEPARABOLICPDE_HPP_
38
40#include <boost/serialization/base_object.hpp>
41
42#include "AbstractCellPopulation.hpp"
43#include "AbstractLinearParabolicPde.hpp"
44
62template<unsigned DIM>
64{
65 friend class TestCellBasedParabolicPdes;
66
67private:
68
77 template<class Archive>
78 void serialize(Archive & archive, const unsigned int version)
79 {
80 archive & boost::serialization::base_object<AbstractLinearParabolicPde<DIM, DIM> >(*this);
83 archive & mDiffusionCoefficient;
84 archive & mDuDtCoefficient;
85 archive & mScaleByCellVolume;
86 }
87
88protected:
89
92
95
98
101
104
107
108
109public:
110
122 double constantSourceCoefficient=0.0,
123 double linearSourceCoefficient=0.0,
124 double diffusionCoefficient=1.0,
125 double duDtCoefficient=1.0,
126 bool scaleByCellVolume=false);
127
132
136 double GetConstantCoefficient() const;
137
141 double GetLinearCoefficient() const;
142
146 double GetDiffusionCoefficient() const;
147
151 double GetDuDtCoefficient() const;
152
156 bool GetScaleByCellVolume() const;
157
165 double ComputeDuDtCoefficientFunction(const ChastePoint<DIM>& rX) override;
166
176 double ComputeSourceTerm(const ChastePoint<DIM>& rX,
177 double u,
178 Element<DIM, DIM>* pElement) override;
179
191 double ComputeSourceTermAtNode(const Node<DIM>& rNode, double u) override;
192
201 c_matrix<double,DIM,DIM> ComputeDiffusionTerm(const ChastePoint<DIM>& rX, Element<DIM, DIM>* pElement = nullptr) override;
202};
203
206
207namespace boost
208{
209namespace serialization
210{
214template<class Archive, unsigned DIM>
215inline void save_construct_data(
216 Archive & ar, const CellwiseSourceParabolicPde<DIM>* t, const unsigned int file_version)
217{
218 // Save data required to construct instance
219 const AbstractCellPopulation<DIM, DIM>* p_cell_population = &(t->rGetCellPopulation());
220 ar & p_cell_population;
221}
222
226template<class Archive, unsigned DIM>
227inline void load_construct_data(
228 Archive & ar, CellwiseSourceParabolicPde<DIM>* t, const unsigned int file_version)
229{
230 // Retrieve data from archive required to construct new instance
231 AbstractCellPopulation<DIM, DIM>* p_cell_population;
232 ar >> p_cell_population;
233
234 // Invoke inplace constructor to initialise instance
235 ::new(t)CellwiseSourceParabolicPde<DIM>(*p_cell_population);
236}
237}
238} // namespace ...
239
240#endif /*CELLWISESOURCEPARABOLICPDE_HPP_*/
gcov doesn't like this file...
#define EXPORT_TEMPLATE_CLASS_SAME_DIMS(CLASS)
void serialize(Archive &archive, const unsigned int version)
double ComputeDuDtCoefficientFunction(const ChastePoint< DIM > &rX) override
AbstractCellPopulation< DIM, DIM > & mrCellPopulation
const AbstractCellPopulation< DIM > & rGetCellPopulation() const
double ComputeSourceTerm(const ChastePoint< DIM > &rX, double u, Element< DIM, DIM > *pElement) override
c_matrix< double, DIM, DIM > ComputeDiffusionTerm(const ChastePoint< DIM > &rX, Element< DIM, DIM > *pElement=nullptr) override
friend class boost::serialization::access
double ComputeSourceTermAtNode(const Node< DIM > &rNode, double u) override
Definition Node.hpp:59