Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
Electrodes.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 ELECTRODES_HPP_
37#define ELECTRODES_HPP_
38
39#include <boost/shared_ptr.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
64template<unsigned DIM>
66{
67friend class TestBidomainWithBathProblem;
68friend class TestElectrodes;
69
70private:
74 boost::shared_ptr<BoundaryConditionsContainer<DIM,DIM,2> > mpBoundaryConditionsContainer;
76 double mStartTime;
78 double mEndTime;
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
150public:
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 {
202 }
203};
204
207
208#endif /*ELECTRODES_HPP_*/
gcov doesn't like this file...
#define EXPORT_TEMPLATE_CLASS_SAME_DIMS(CLASS)
double GetSwitchOnTime()
bool SwitchOn(double time)
bool HasGroundedElectrode()
void ComputeElectrodesAreasAndCheckEquality(unsigned index, double lowerValue, double upperValue)
double GetSwitchOffTime()
bool SwitchOff(double time)
double mStartTime
double mLeftElectrodeArea
bool mAreActive
void save(Archive &archive, const unsigned int version) const
void load(Archive &archive, const unsigned int version)
boost::shared_ptr< BoundaryConditionsContainer< DIM, DIM, 2 > > mpBoundaryConditionsContainer
double mRightElectrodeArea
friend class boost::serialization::access
boost::shared_ptr< BoundaryConditionsContainer< DIM, DIM, 2 > > GetBoundaryConditionsContainer()
double mEndTime
AbstractTetrahedralMesh< DIM, DIM > * mpMesh
bool mGroundSecondElectrode