ZeroNetChargeElectrodes.hpp

00001 /*
00002 
00003 Copyright (C) University of Oxford, 2005-2011
00004 
00005 University of Oxford means the Chancellor, Masters and Scholars of the
00006 University of Oxford, having an administrative office at Wellington
00007 Square, Oxford OX1 2JD, UK.
00008 
00009 This file is part of Chaste.
00010 
00011 Chaste is free software: you can redistribute it and/or modify it
00012 under the terms of the GNU Lesser General Public License as published
00013 by the Free Software Foundation, either version 2.1 of the License, or
00014 (at your option) any later version.
00015 
00016 Chaste is distributed in the hope that it will be useful, but WITHOUT
00017 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
00019 License for more details. The offer of Chaste under the terms of the
00020 License is subject to the License being interpreted in accordance with
00021 English Law and subject to any action against the University of Oxford
00022 being under the jurisdiction of the English Courts.
00023 
00024 You should have received a copy of the GNU Lesser General Public License
00025 along with Chaste. If not, see <http://www.gnu.org/licenses/>.
00026 
00027 */
00028 
00029 #ifndef ZERONETCHARGEELECTRODES_HPP_
00030 #define ZERONETCHARGEELECTRODES_HPP_
00031 
00032 #include <boost/shared_ptr.hpp>
00033 #include "ChasteSerialization.hpp"
00034 #include <boost/serialization/split_member.hpp>
00035 #include <boost/serialization/shared_ptr.hpp>
00036 
00037 #include "AbstractTetrahedralMesh.hpp"
00038 #include "DistributedVector.hpp"
00039 #include "ElectrodesStimulusFactory.hpp"
00040 #include "AbstractChasteRegion.hpp"
00041 #include "AbstractStimulusFactory.hpp"
00042 #include "LinearBasisFunction.hpp"
00043 
00052 template<unsigned DIM>
00053 class ZeroNetChargeElectrodes : public ElectrodesStimulusFactory<DIM>
00054 {
00055 
00056 public:
00057 
00068     ZeroNetChargeElectrodes(std::vector<std::pair<AbstractChasteRegion<DIM>*, AbstractChasteRegion<DIM>*> >& rElectrodePairs,
00069                               std::vector<double>& rStimulusMagnitudes,
00070                               std::vector<double>& rDurations,
00071                               std::vector<double>& rPeriods,
00072                               std::vector<double>& rStarts,
00073                               std::vector<double>& rEnds);
00074 
00080     boost::shared_ptr<AbstractStimulusFunction> CreateStimulusForNode(unsigned nodeIndex);
00081 
00085     ~ZeroNetChargeElectrodes();
00086 
00087 };
00088 
00089 #endif /*ZERONETCHARGEELECTRODES_HPP_*/