Chaste Commit::93a80d924b654e8cf58467323b464899ac9ee3f3
AbstractNumericalMethod.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 ABSTRACTNUMERICALMETHOD_HPP_
37#define ABSTRACTNUMERICALMETHOD_HPP_
38
39#include <boost/shared_ptr.hpp>
41#include "ClassIsAbstract.hpp"
42#include "Identifiable.hpp"
43
44#include "AbstractOffLatticeCellPopulation.hpp"
45#include "AbstractForce.hpp"
46#include "AbstractCellPopulationBoundaryCondition.hpp"
47
55template<unsigned ELEMENT_DIM, unsigned SPACE_DIM=ELEMENT_DIM>
57{
58 friend class TestNumericalMethods;
59
60private:
61
64
71 template<class Archive>
72 void serialize(Archive & archive, const unsigned int version)
73 {
74 archive & mUseAdaptiveTimestep;
75 archive & mUseUpdateNodeLocation;
77 }
78
79protected:
80
83
85 std::vector<boost::shared_ptr<AbstractForce<ELEMENT_DIM, SPACE_DIM> > >* mpForceCollection;
86
88 std::vector<boost::shared_ptr<AbstractCellPopulationBoundaryCondition<ELEMENT_DIM, SPACE_DIM> > >* mpBoundaryConditions;
89
95
106
112
117 std::map<Node<SPACE_DIM>*, c_vector<double, SPACE_DIM> > SaveCurrentNodeLocations();
118
123 void ImposeBoundaryConditions(std::map<Node<SPACE_DIM>*, c_vector<double, SPACE_DIM> >& rOldNodeLocations);
124
129 std::vector<c_vector<double, SPACE_DIM> > ComputeForcesIncludingDamping();
130
135 std::vector<c_vector<double, SPACE_DIM> > SaveCurrentLocations();
136
143 void SafeNodePositionUpdate(unsigned nodeIndex, c_vector<double, SPACE_DIM> newPosition);
144
154 void DetectStepSizeExceptions(unsigned nodeIndex, c_vector<double,SPACE_DIM>& displacement, double dt);
155
156public:
157
165
170
177
183 void SetForceCollection(std::vector<boost::shared_ptr<AbstractForce<ELEMENT_DIM, SPACE_DIM> > >* pForces);
184
190 void SetBoundaryConditions(std::vector<boost::shared_ptr<AbstractCellPopulationBoundaryCondition<ELEMENT_DIM, SPACE_DIM> > >* pBoundaryConditions);
191
197 void SetUseAdaptiveTimestep(bool useAdaptiveTimestep);
198
204 void SetUseUpdateNodeLocation(bool useUpdateNodeLocation);
205
212
216 bool HasAdaptiveTimestep();
217
226 virtual void UpdateAllNodePositions(double dt)=0;
227
233 void OutputNumericalMethodInfo(out_stream& rParamsFile);
234
240 virtual void OutputNumericalMethodParameters(out_stream& rParamsFile);
241};
242
244
245#endif /*ABSTRACTNUMERICALMETHOD_HPP_*/
#define TEMPLATED_CLASS_IS_ABSTRACT_2_UNSIGNED(T)
AbstractOffLatticeCellPopulation< ELEMENT_DIM, SPACE_DIM > * mpCellPopulation
void SetForceCollection(std::vector< boost::shared_ptr< AbstractForce< ELEMENT_DIM, SPACE_DIM > > > *pForces)
std::map< Node< SPACE_DIM > *, c_vector< double, SPACE_DIM > > SaveCurrentNodeLocations()
void SetCellPopulation(AbstractOffLatticeCellPopulation< ELEMENT_DIM, SPACE_DIM > *pPopulation)
void SafeNodePositionUpdate(unsigned nodeIndex, c_vector< double, SPACE_DIM > newPosition)
void ImposeBoundaryConditions(std::map< Node< SPACE_DIM > *, c_vector< double, SPACE_DIM > > &rOldNodeLocations)
std::vector< boost::shared_ptr< AbstractCellPopulationBoundaryCondition< ELEMENT_DIM, SPACE_DIM > > > * mpBoundaryConditions
virtual void UpdateAllNodePositions(double dt)=0
void OutputNumericalMethodInfo(out_stream &rParamsFile)
void DetectStepSizeExceptions(unsigned nodeIndex, c_vector< double, SPACE_DIM > &displacement, double dt)
void serialize(Archive &archive, const unsigned int version)
void SetUseAdaptiveTimestep(bool useAdaptiveTimestep)
void SetBoundaryConditions(std::vector< boost::shared_ptr< AbstractCellPopulationBoundaryCondition< ELEMENT_DIM, SPACE_DIM > > > *pBoundaryConditions)
std::vector< c_vector< double, SPACE_DIM > > ComputeForcesIncludingDamping()
friend class boost::serialization::access
void SetUseUpdateNodeLocation(bool useUpdateNodeLocation)
std::vector< c_vector< double, SPACE_DIM > > SaveCurrentLocations()
virtual void OutputNumericalMethodParameters(out_stream &rParamsFile)
std::vector< boost::shared_ptr< AbstractForce< ELEMENT_DIM, SPACE_DIM > > > * mpForceCollection
Definition Node.hpp:59