Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
ElectroMechanicsProblemDefinition.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 ELECTROMECHANICSPROBLEMDEFINITION_HPP_
37#define ELECTROMECHANICSPROBLEMDEFINITION_HPP_
38
39#include "SolidMechanicsProblemDefinition.hpp"
40#include "ContractionModelName.hpp"
41#include "NashHunterPoleZeroLaw.hpp"
42#include "CompressibleExponentialLaw.hpp"
43#include "FileFinder.hpp"
44#include "AbstractContractionCellFactory.hpp"
45#include "SolverType.hpp"
46
51template<unsigned DIM>
53{
54private:
55 friend class TestExplicitCardiacMechanicsSolver;
56 friend class TestImplicitCardiacMechanicsSolver;
57 friend class TestElectroMechanicsProblemDefinition;
58
61
64
70
76
81
82
85
91
97
104
109
114
119
122
125
127 SolverType mSolverType;
128
129public:
135
138
149 void SetContractionModel(ContractionModelName contractionModel, double timestep);
150
161
167 void SetUseDefaultCardiacMaterialLaw(CompressibilityType compressibilityType);
168
175 void SetSolverType(SolverType solver)
176 {
177 mSolverType = solver;
178 }
179
202 void SetDeformationAffectsElectrophysiology(bool deformationAffectsConductivity, bool deformationAffectsCellModels);
203
208 void SetMechanicsSolveTimestep(double timestep);
209
210
225 void SetVariableFibreSheetDirectionsFile(const FileFinder& rFibreSheetDirectionsFile, bool definedPerQuadPoint);
226
227
239 void SetApplyIsotropicCrossFibreTension(bool applyCrossFibreTension, double crossFibreTensionFraction);
240
252 void SetApplyAnisotropicCrossFibreTension(bool applyCrossFibreTension, double sheetTensionFraction, double sheetNormalTensionFraction);
253
262
270 void SetContractionModelOdeTimestep(double timestep)
271 {
273 }
274
279 {
280 assert(mContractionModelOdeTimeStep>0.0); // see exception message in Validate()
282 }
283
288 {
289 assert(mMechanicsSolveTimestep>0.0); // if this fails SetMechanicsSolveTimestep() probably hasn't been called - call Validate() to check
291 }
292
301
310
314 SolverType GetSolverType()
315 {
316 return mSolverType;
317 }
318
326
336
347
354 void SetNumIncrementsForInitialDeformation(unsigned numIncrements)
355 {
356 if (numIncrements==0)
357 {
358 EXCEPTION("Number of increments for initial deformation must be 1 or more");
359 }
361 }
362
371
376 {
378 }
379
384 {
386 }
387
395
396
401 virtual void Validate();
402};
403
404#endif // ELECTROMECHANICSPROBLEMDEFINITION_HPP_
#define EXCEPTION(message)
void SetContractionModel(ContractionModelName contractionModel, double timestep)
void SetNumIncrementsForInitialDeformation(unsigned numIncrements)
void SetUseDefaultCardiacMaterialLaw(CompressibilityType compressibilityType)
void SetVariableFibreSheetDirectionsFile(const FileFinder &rFibreSheetDirectionsFile, bool definedPerQuadPoint)
void SetApplyAnisotropicCrossFibreTension(bool applyCrossFibreTension, double sheetTensionFraction, double sheetNormalTensionFraction)
AbstractContractionCellFactory< DIM > * GetContractionCellFactory()
void SetDeformationAffectsElectrophysiology(bool deformationAffectsConductivity, bool deformationAffectsCellModels)
AbstractContractionCellFactory< DIM > * mpContractionCellFactory
void SetApplyIsotropicCrossFibreTension(bool applyCrossFibreTension, double crossFibreTensionFraction)
void SetContractionCellFactory(AbstractContractionCellFactory< DIM > *pCellFactory)
std::string GetAbsolutePath() const