Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
AbstractForce.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 ABSTRACTFORCE_HPP_
37#define ABSTRACTFORCE_HPP_
38
40#include "ClassIsAbstract.hpp"
41
42#include "AbstractCellPopulation.hpp"
43
50#ifdef DOXYGEN_CHASTE_ISSUE_199 // See https://github.com/Chaste/Chaste/issues/199
51template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
52#else
53template<unsigned ELEMENT_DIM, unsigned SPACE_DIM = ELEMENT_DIM>
54#endif
56{
65 template<class Archive>
66 void serialize(Archive & archive, const unsigned int version)
67 {
68 }
69
70public:
71
76
80 virtual ~AbstractForce();
81
91
97 void OutputForceInfo(out_stream& rParamsFile);
98
107 virtual void OutputForceParameters(out_stream& rParamsFile)=0;
108
115 virtual void WriteDataToVisualizerSetupFile(out_stream& pVizSetupFile);
116};
117
119
120#endif /*ABSTRACTFORCE_HPP_*/
#define TEMPLATED_CLASS_IS_ABSTRACT_2_UNSIGNED(T)
virtual void OutputForceParameters(out_stream &rParamsFile)=0
virtual ~AbstractForce()
virtual void AddForceContribution(AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > &rCellPopulation)=0
void OutputForceInfo(out_stream &rParamsFile)
friend class boost::serialization::access
virtual void WriteDataToVisualizerSetupFile(out_stream &pVizSetupFile)
void serialize(Archive &archive, const unsigned int version)