Chaste  Release::3.4
ElectroMechanicsProblemDefinition.hpp
1 /*
2 
3 Copyright (c) 2005-2016, University of Oxford.
4 All rights reserved.
5 
6 University of Oxford means the Chancellor, Masters and Scholars of the
7 University of Oxford, having an administrative office at Wellington
8 Square, Oxford OX1 2JD, UK.
9 
10 This file is part of Chaste.
11 
12 Redistribution and use in source and binary forms, with or without
13 modification, 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 
23 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
24 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
27 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
29 GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32 OF 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 
51 template<unsigned DIM>
53 {
54 private:
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 
129 public:
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 
258  {
259  assert(mpContractionCellFactory);
261  }
262 
270  void SetContractionModelOdeTimestep(double timestep)
271  {
272  mContractionModelOdeTimeStep = timestep;
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 
298  {
300  }
301 
307  {
309  }
310 
314  SolverType GetSolverType()
315  {
316  return mSolverType;
317  }
318 
323  {
325  }
326 
331  {
335  }
336 
343  {
346  }
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  }
360  mNumIncrementsForInitialDeformation = numIncrements;
361  }
362 
368  {
370  }
371 
376  {
378  }
379 
384  {
385  return mSheetTensionFraction;
386  }
387 
392  {
394  }
395 
396 
401  virtual void Validate();
402 };
403 
404 #endif // ELECTROMECHANICSPROBLEMDEFINITION_HPP_
ElectroMechanicsProblemDefinition(QuadraticMesh< DIM > &rMesh)
void SetContractionCellFactory(AbstractContractionCellFactory< DIM > *pCellFactory)
AbstractContractionCellFactory< DIM > * mpContractionCellFactory
std::string GetAbsolutePath() const
Definition: FileFinder.cpp:221
AbstractContractionCellFactory< DIM > * GetContractionCellFactory()
#define EXCEPTION(message)
Definition: Exception.hpp:143
void SetContractionModel(ContractionModelName contractionModel, double timestep)
void SetNumIncrementsForInitialDeformation(unsigned numIncrements)
void SetVariableFibreSheetDirectionsFile(const FileFinder &rFibreSheetDirectionsFile, bool definedPerQuadPoint)
void SetApplyAnisotropicCrossFibreTension(bool applyCrossFibreTension, double sheetTensionFraction, double sheetNormalTensionFraction)
void SetDeformationAffectsElectrophysiology(bool deformationAffectsConductivity, bool deformationAffectsCellModels)
void SetApplyIsotropicCrossFibreTension(bool applyCrossFibreTension, double crossFibreTensionFraction)
void SetUseDefaultCardiacMaterialLaw(CompressibilityType compressibilityType)