Chaste  Release::3.4
Electrodes.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 ELECTRODES_HPP_
37 #define ELECTRODES_HPP_
38 
39 #include <boost/shared_ptr.hpp>
40 #include "ChasteSerialization.hpp"
41 #include <boost/serialization/split_member.hpp>
42 #include <boost/serialization/shared_ptr.hpp>
43 
44 #include "AbstractTetrahedralMesh.hpp"
45 #include "DistributedVector.hpp"
46 #include "BoundaryConditionsContainer.hpp"
47 #include "ConstBoundaryCondition.hpp"
48 
64 template<unsigned DIM>
66 {
67 friend class TestBidomainWithBathProblem;
68 friend class TestElectrodes;
69 
70 private:
74  boost::shared_ptr<BoundaryConditionsContainer<DIM,DIM,2> > mpBoundaryConditionsContainer;
76  double mStartTime;
78  double mEndTime;
80  bool mAreActive;
87 
90 
93 
103  void ComputeElectrodesAreasAndCheckEquality(unsigned index, double lowerValue, double upperValue);
104 
113  template<class Archive>
114  void save(Archive & archive, const unsigned int version) const
115  {
116  archive & mGroundSecondElectrode;
117  archive & mStartTime;
118  archive & mEndTime;
119  archive & mAreActive;
120  archive & mpMesh;
122  }
129  template<class Archive>
130  void load(Archive & archive, const unsigned int version)
131  {
132  archive & mGroundSecondElectrode;
133  archive & mStartTime;
134  archive & mEndTime;
135  archive & mAreActive;
136  archive & mpMesh;
137 
140  // Allow the new object to load itself from the archive.
142  }
143  BOOST_SERIALIZATION_SPLIT_MEMBER()
144 
145 
149 
150 public:
151 
152 
159  Electrodes(AbstractTetrahedralMesh<DIM,DIM>& rMesh); // implemented in cpp
160 
166  boost::shared_ptr<BoundaryConditionsContainer<DIM,DIM,2> > GetBoundaryConditionsContainer();
167 
175  bool SwitchOff(double time);
176 
184  bool SwitchOn(double time);
185 
188  {
189  return mStartTime;
190  }
191 
194  {
195  return mEndTime;
196  }
197 
200  {
201  return mGroundSecondElectrode;
202  }
203 };
204 
207 
208 #endif /*ELECTRODES_HPP_*/
bool mGroundSecondElectrode
Definition: Electrodes.hpp:72
double mEndTime
Definition: Electrodes.hpp:78
double mLeftElectrodeArea
Definition: Electrodes.hpp:89
void save(Archive &archive, const unsigned int version) const
Definition: Electrodes.hpp:114
boost::shared_ptr< BoundaryConditionsContainer< DIM, DIM, 2 > > mpBoundaryConditionsContainer
Definition: Electrodes.hpp:74
AbstractTetrahedralMesh< DIM, DIM > * mpMesh
Definition: Electrodes.hpp:86
static Archive * Get(void)
friend class boost::serialization::access
Definition: Electrodes.hpp:106
boost::shared_ptr< BoundaryConditionsContainer< DIM, DIM, 2 > > GetBoundaryConditionsContainer()
Definition: Electrodes.cpp:135
#define EXPORT_TEMPLATE_CLASS_SAME_DIMS(CLASS)
double GetSwitchOnTime()
Definition: Electrodes.hpp:187
bool mAreActive
Definition: Electrodes.hpp:80
double GetSwitchOffTime()
Definition: Electrodes.hpp:193
void load(Archive &archive, const unsigned int version)
Definition: Electrodes.hpp:130
bool HasGroundedElectrode()
Definition: Electrodes.hpp:199
double mStartTime
Definition: Electrodes.hpp:76
double mRightElectrodeArea
Definition: Electrodes.hpp:92
bool SwitchOn(double time)
Definition: Electrodes.cpp:158
void ComputeElectrodesAreasAndCheckEquality(unsigned index, double lowerValue, double upperValue)
Definition: Electrodes.cpp:173
bool SwitchOff(double time)
Definition: Electrodes.cpp:143