Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
LabelBasedContractionCellFactory.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 LABELBASEDCONTRACTIONCELLFACTORY_HPP_
37#define LABELBASEDCONTRACTIONCELLFACTORY_HPP_
38
39#include "AbstractContractionCellFactory.hpp"
40#include "ContractionModelName.hpp"
41#include "NonPhysiologicalContractionModel.hpp"
42#include "Kerchoffs2003ContractionModel.hpp"
43#include "Nash2004ContractionModel.hpp"
44#include "NhsModelWithBackwardSolver.hpp"
45#include "ConstantActiveTension.hpp"
46
52template <unsigned DIM>
54{
55private:
57 ContractionModelName mContractionModelName;
58
59public:
65 LabelBasedContractionCellFactory(ContractionModelName contractionModelName)
67 mContractionModelName(contractionModelName)
68 {
69 }
70
78 {
80 {
81 case CONSTANT:
82 {
83 return new ConstantActiveTension;
84 break;
85 }
86 case NONPHYSIOL1:
87 case NONPHYSIOL2:
88 case NONPHYSIOL3:
89 {
90 unsigned option = (mContractionModelName==NONPHYSIOL1 ? 1 : (mContractionModelName==NONPHYSIOL2? 2 : 3));
91 return new NonPhysiologicalContractionModel(option);
92 break;
93 }
94 case NASH2004: //stretch dependent, will this work with explicit??
95 {
96 return new Nash2004ContractionModel;
97 break;
98 }
99 case NHS:
100 {
102 break;
103 }
104 case KERCHOFFS2003: //stretch dependent, will this work with explicit? Answer: can be unstable
105 {
107 break;
108 }
109 default:
110 {
112 }
113 }
114// LCOV_EXCL_START
115 return NULL; //This is included to appease compilers which analysis the NEVER_REACHED branch as not returning a pointer
116// LCOV_EXCL_STOP
117 }
118};
119
120#endif // LABELBASEDCONTRACTIONCELLFACTORY_HPP_
#define NEVER_REACHED
AbstractContractionModel * CreateContractionCellForElement(Element< DIM, DIM > *pElement)
LabelBasedContractionCellFactory(ContractionModelName contractionModelName)