Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
PopulationTestingForce.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 POPULATIONTESTINGFORCE_HPP_
37#define POPULATIONTESTINGFORCE_HPP_
38
40#include <boost/serialization/base_object.hpp>
41#include "AbstractForce.hpp"
42
47template<unsigned ELEMENT_DIM, unsigned SPACE_DIM=ELEMENT_DIM>
48class PopulationTestingForce : public AbstractForce<ELEMENT_DIM, SPACE_DIM>
49{
50private:
51
56
64 template<class Archive>
65 void serialize(Archive & archive, const unsigned int version)
66 {
67 archive & boost::serialization::base_object<AbstractForce<ELEMENT_DIM,SPACE_DIM> >(*this);
69 }
70
77
78public:
79
85 PopulationTestingForce(bool hasPositionDependence = true);
86
107
118 c_vector<double, SPACE_DIM> GetExpectedOneStepLocationFE(unsigned nodeIndex,
119 double damping,
120 c_vector<double, SPACE_DIM>& oldLocation,
121 double dt);
122
133 c_vector<double, SPACE_DIM> GetExpectedOneStepLocationRK4(unsigned nodeIndex,
134 double damping,
135 c_vector<double, SPACE_DIM>& oldLocation,
136 double dt);
137
148 c_vector<double, SPACE_DIM> GetExpectedOneStepLocationAM2(unsigned nodeIndex,
149 double damping,
150 c_vector<double, SPACE_DIM>& oldLocation,
151 double dt);
152
163 c_vector<double, SPACE_DIM> GetExpectedOneStepLocationBE(unsigned nodeIndex,
164 double damping,
165 c_vector<double, SPACE_DIM>& oldLocation,
166 double dt);
167
173 virtual void OutputForceParameters(out_stream& rParamsFile);
174};
175
178
179#endif /*POPULATIONTESTINGFORCE_HPP_*/
gcov doesn't like this file...
#define EXPORT_TEMPLATE_CLASS_ALL_DIMS(CLASS)
c_vector< double, SPACE_DIM > GetExpectedOneStepLocationAM2(unsigned nodeIndex, double damping, c_vector< double, SPACE_DIM > &oldLocation, double dt)
c_vector< double, SPACE_DIM > GetExpectedOneStepLocationFE(unsigned nodeIndex, double damping, c_vector< double, SPACE_DIM > &oldLocation, double dt)
virtual void OutputForceParameters(out_stream &rParamsFile)
c_vector< double, SPACE_DIM > GetExpectedOneStepLocationRK4(unsigned nodeIndex, double damping, c_vector< double, SPACE_DIM > &oldLocation, double dt)
void AddForceContribution(AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > &rCellPopulation)
c_vector< double, SPACE_DIM > GetExpectedOneStepLocationBE(unsigned nodeIndex, double damping, c_vector< double, SPACE_DIM > &oldLocation, double dt)
void serialize(Archive &archive, const unsigned int version)
friend class boost::serialization::access