Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
AbstractBoxDomainPdeModifier.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 ABSTRACTBOXDOMAINPDEMODIFIER_HPP_
37#define ABSTRACTBOXDOMAINPDEMODIFIER_HPP_
38
40#include <boost/serialization/base_object.hpp>
41
42#include "AbstractPdeModifier.hpp"
43
49template<unsigned DIM>
51{
52 friend class TestEllipticBoxDomainPdeModifier;
53 friend class TestParabolicBoxDomainPdeModifier;
54 friend class TestOffLatticeSimulationWithPdes;
55
56private:
57
67 template<class Archive>
68 void serialize(Archive & archive, const unsigned int version)
69 {
70 archive & boost::serialization::base_object<AbstractPdeModifier<DIM> >(*this);
71 archive & mpMeshCuboid;
72 archive & mStepSize;
73 archive & mSetBcsOnBoxBoundary;
74 }
75
76protected:
77
79 std::map<CellPtr, unsigned> mCellPdeElementMap;
80
85 boost::shared_ptr<ChasteCuboid<DIM> > mpMeshCuboid;
86
91 double mStepSize;
92
98
99public:
100
112 AbstractBoxDomainPdeModifier(boost::shared_ptr<AbstractLinearPde<DIM,DIM> > pPde=boost::shared_ptr<AbstractLinearPde<DIM,DIM> >(),
113 boost::shared_ptr<AbstractBoundaryCondition<DIM> > pBoundaryCondition=boost::shared_ptr<AbstractBoundaryCondition<DIM> >(),
114 bool isNeumannBoundaryCondition=true,
115 boost::shared_ptr<ChasteCuboid<DIM> > pMeshCuboid=boost::shared_ptr<ChasteCuboid<DIM> >(),
116 double stepSize=1.0,
117 Vec solution=nullptr);
118
123
127 double GetStepSize();
128
134 void SetBcsOnBoxBoundary(bool setBcsOnBoxBoundary);
135
140
151 virtual void SetupSolve(AbstractCellPopulation<DIM,DIM>& rCellPopulation, std::string outputDirectory);
152
159 void GenerateFeMesh(boost::shared_ptr<ChasteCuboid<DIM> > pMeshCuboid, double stepSize);
160
168 void UpdateCellData(AbstractCellPopulation<DIM,DIM>& rCellPopulation);
169
176
186
193 void OutputSimulationModifierParameters(out_stream& rParamsFile);
194};
195
198
199#endif /*ABSTRACTBOXDOMAINPDEMODIFIER_HPP_*/
#define TEMPLATED_CLASS_IS_ABSTRACT_1_UNSIGNED(T)
gcov doesn't like this file...
void OutputSimulationModifierParameters(out_stream &rParamsFile)
virtual void SetupSolve(AbstractCellPopulation< DIM, DIM > &rCellPopulation, std::string outputDirectory)
void serialize(Archive &archive, const unsigned int version)
std::map< CellPtr, unsigned > mCellPdeElementMap
void GenerateFeMesh(boost::shared_ptr< ChasteCuboid< DIM > > pMeshCuboid, double stepSize)
boost::shared_ptr< ChasteCuboid< DIM > > mpMeshCuboid
friend class boost::serialization::access
void UpdateCellData(AbstractCellPopulation< DIM, DIM > &rCellPopulation)
void SetBcsOnBoxBoundary(bool setBcsOnBoxBoundary)
void UpdateCellPdeElementMap(AbstractCellPopulation< DIM, DIM > &rCellPopulation)
void InitialiseCellPdeElementMap(AbstractCellPopulation< DIM, DIM > &rCellPopulation)