Chaste  Release::2018.1
AbstractFeAssemblerCommon.hpp
1 /*
2 
3 Copyright (c) 2005-2018, 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 ABSTRACTFEASSEMBLERCOMMON_HPP_
37 #define ABSTRACTFEASSEMBLERCOMMON_HPP_
38 
39 #include "AbstractFeAssemblerInterface.hpp"
40 #include "ReplicatableVector.hpp"
41 #include "DistributedVector.hpp"
42 #include "HeartEventHandler.hpp"
43 #include "LinearBasisFunction.hpp"
44 #include "PetscTools.hpp"
45 #include "AbstractTetrahedralMesh.hpp"
46 
56 typedef enum InterpolationLevel_
57 {
58  CARDIAC = 0,
59  NORMAL,
60  NONLINEAR
61 } InterpolationLevel;
62 
72 template <unsigned ELEMENT_DIM, unsigned SPACE_DIM, unsigned PROBLEM_DIM, bool CAN_ASSEMBLE_VECTOR, bool CAN_ASSEMBLE_MATRIX, InterpolationLevel INTERPOLATION_LEVEL>
73 class AbstractFeAssemblerCommon : public AbstractFeAssemblerInterface<CAN_ASSEMBLE_VECTOR,CAN_ASSEMBLE_MATRIX>
74 {
75 protected:
81 
88  virtual double GetCurrentSolutionOrGuessValue(unsigned nodeIndex, unsigned indexOfUnknown)
89  {
90  return mCurrentSolutionOrGuessReplicated[ PROBLEM_DIM*nodeIndex + indexOfUnknown];
91  }
92 
99  {}
100 
111  virtual void IncrementInterpolatedQuantities(double phiI, const Node<SPACE_DIM>* pNode)
112  {}
113 
133  virtual void IncrementInterpolatedGradientQuantities(const c_matrix<double, SPACE_DIM, ELEMENT_DIM+1>& rGradPhi, unsigned phiIndex, const Node<SPACE_DIM>* pNode)
134  {}
135 public:
136 
141 
148  void SetCurrentSolution(Vec currentSolution);
149 
154  {
155  }
156 };
157 
158 template <unsigned ELEMENT_DIM, unsigned SPACE_DIM, unsigned PROBLEM_DIM, bool CAN_ASSEMBLE_VECTOR, bool CAN_ASSEMBLE_MATRIX, InterpolationLevel INTERPOLATION_LEVEL>
160  : AbstractFeAssemblerInterface<CAN_ASSEMBLE_VECTOR,CAN_ASSEMBLE_MATRIX>()
161 {
162 }
163 
164 template <unsigned ELEMENT_DIM, unsigned SPACE_DIM, unsigned PROBLEM_DIM, bool CAN_ASSEMBLE_VECTOR, bool CAN_ASSEMBLE_MATRIX, InterpolationLevel INTERPOLATION_LEVEL>
166 {
167  assert(currentSolution != nullptr);
168 
169  // Replicate the current solution and store so can be used in AssembleOnElement
170  HeartEventHandler::BeginEvent(HeartEventHandler::COMMUNICATION);
171  mCurrentSolutionOrGuessReplicated.ReplicatePetscVector(currentSolution);
172  HeartEventHandler::EndEvent(HeartEventHandler::COMMUNICATION);
173 
174  // The AssembleOnElement type methods will determine if a current solution or
175  // current guess exists by looking at the size of the replicated vector, so
176  // check the size is zero if there isn't a current solution.
177  assert(mCurrentSolutionOrGuessReplicated.GetSize() > 0);
178 }
179 
180 
181 #endif /* ABSTRACTFEASSEMBLERCOMMON_HPP_ */
Definition: Node.hpp:58
virtual double GetCurrentSolutionOrGuessValue(unsigned nodeIndex, unsigned indexOfUnknown)
virtual void IncrementInterpolatedGradientQuantities(const c_matrix< double, SPACE_DIM, ELEMENT_DIM+1 > &rGradPhi, unsigned phiIndex, const Node< SPACE_DIM > *pNode)
void SetCurrentSolution(Vec currentSolution)
virtual void IncrementInterpolatedQuantities(double phiI, const Node< SPACE_DIM > *pNode)
ReplicatableVector mCurrentSolutionOrGuessReplicated