Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
AveragedSourceParabolicPde.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 AVERAGESOURCEPARABOLICPDE_HPP_
37#define AVERAGESOURCEPARABOLICPDE_HPP_
38
40#include <boost/serialization/base_object.hpp>
41
42#include "AbstractCellPopulation.hpp"
43#include "TetrahedralMesh.hpp"
44#include "AbstractLinearParabolicPde.hpp"
45
65template<unsigned DIM>
67{
68 friend class TestCellBasedParabolicPdes;
69
70private:
71
80 template<class Archive>
81 void serialize(Archive & archive, const unsigned int version)
82 {
83 archive & boost::serialization::base_object<AbstractLinearParabolicPde<DIM, DIM> >(*this);
84 archive & mDuDtCoefficient;
85 archive & mDiffusionCoefficient;
86 archive & mSourceCoefficient;
88 }
89
90protected:
91
94
97
100
103
105 std::vector<double> mCellDensityOnCoarseElements;
106
107public:
108
118 double duDtCoefficient=1.0,
119 double diffusionCoefficient=1.0,
120 double sourceCoefficient=0.0);
121
126
135 void virtual SetupSourceTerms(TetrahedralMesh<DIM,DIM>& rCoarseMesh, std::map<CellPtr, unsigned>* pCellPdeElementMap=nullptr);
136
144 virtual double ComputeDuDtCoefficientFunction(const ChastePoint<DIM>& rX);
145
155 virtual double ComputeSourceTerm(const ChastePoint<DIM>& rX,
156 double u,
157 Element<DIM,DIM>* pElement=NULL);
158
167 virtual double ComputeSourceTermAtNode(const Node<DIM>& rNode, double u);
168
177 virtual c_matrix<double,DIM,DIM> ComputeDiffusionTerm(const ChastePoint<DIM>& rX, Element<DIM,DIM>* pElement=NULL);
178
184 double GetUptakeRateForElement(unsigned elementIndex);
185};
186
189
190namespace boost
191{
192namespace serialization
193{
197template<class Archive, unsigned DIM>
198inline void save_construct_data(
199 Archive & ar, const AveragedSourceParabolicPde<DIM>* t, const unsigned int file_version)
200{
201 // Save data required to construct instance
202 const AbstractCellPopulation<DIM, DIM>* p_cell_population = &(t->rGetCellPopulation());
203 ar & p_cell_population;
204}
205
209template<class Archive, unsigned DIM>
210inline void load_construct_data(
211 Archive & ar, AveragedSourceParabolicPde<DIM>* t, const unsigned int file_version)
212{
213 // Retrieve data from archive required to construct new instance
214 AbstractCellPopulation<DIM, DIM>* p_cell_population;
215 ar >> p_cell_population;
216
217 // Invoke inplace constructor to initialise instance
218 ::new(t)AveragedSourceParabolicPde<DIM>(*p_cell_population);
219}
220}
221} // namespace ...
222
223#endif /*AVERAGESOURCEPARABOLICPDE_HPP_*/
gcov doesn't like this file...
#define EXPORT_TEMPLATE_CLASS_SAME_DIMS(CLASS)
std::vector< double > mCellDensityOnCoarseElements
AbstractCellPopulation< DIM, DIM > & mrCellPopulation
virtual double ComputeSourceTermAtNode(const Node< DIM > &rNode, double u)
void serialize(Archive &archive, const unsigned int version)
virtual double ComputeDuDtCoefficientFunction(const ChastePoint< DIM > &rX)
friend class boost::serialization::access
virtual c_matrix< double, DIM, DIM > ComputeDiffusionTerm(const ChastePoint< DIM > &rX, Element< DIM, DIM > *pElement=NULL)
double GetUptakeRateForElement(unsigned elementIndex)
const AbstractCellPopulation< DIM > & rGetCellPopulation() const
virtual void SetupSourceTerms(TetrahedralMesh< DIM, DIM > &rCoarseMesh, std::map< CellPtr, unsigned > *pCellPdeElementMap=nullptr)
virtual double ComputeSourceTerm(const ChastePoint< DIM > &rX, double u, Element< DIM, DIM > *pElement=NULL)
Definition Node.hpp:59