doxygen-releases/release_3.1/ZeroNetChargeElectrodes_8hpp_source.html

00001 /*
00002
00003 Copyright (c) 2005-2012, University of Oxford.
00004 All rights reserved.
00005
00006 University of Oxford means the Chancellor, Masters and Scholars of the
00007 University of Oxford, having an administrative office at Wellington
00008 Square, Oxford OX1 2JD, UK.
00009
00010 This file is part of Chaste.
00011
00012 Redistribution and use in source and binary forms, with or without
00013 modification, are permitted provided that the following conditions are met:
00014  * Redistributions of source code must retain the above copyright notice,
00015    this list of conditions and the following disclaimer.
00016  * Redistributions in binary form must reproduce the above copyright notice,
00017    this list of conditions and the following disclaimer in the documentation
00018    and/or other materials provided with the distribution.
00019  * Neither the name of the University of Oxford nor the names of its
00020    contributors may be used to endorse or promote products derived from this
00021    software without specific prior written permission.
00022
00023 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00024 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00025 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00026 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
00027 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
00028 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
00029 GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
00030 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
00031 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
00032 OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00033
00034 */
00035
00036 #ifndef ZERONETCHARGEELECTRODES_HPP_
00037 #define ZERONETCHARGEELECTRODES_HPP_
00038
00039 #include <boost/shared_ptr.hpp>
00040 #include "ChasteSerialization.hpp"
00041 #include <boost/serialization/split_member.hpp>
00042 #include <boost/serialization/shared_ptr.hpp>
00043
00044 #include "AbstractTetrahedralMesh.hpp"
00045 #include "DistributedVector.hpp"
00046 #include "ElectrodesStimulusFactory.hpp"
00047 #include "AbstractChasteRegion.hpp"
00048 #include "AbstractStimulusFactory.hpp"
00049 #include "LinearBasisFunction.hpp"
00050
00059 template<unsigned DIM>
00060 class ZeroNetChargeElectrodes : public ElectrodesStimulusFactory<DIM>
00061 {
00062
00063 public:
00064
00075     ZeroNetChargeElectrodes(std::vector<std::pair<AbstractChasteRegion<DIM>*, AbstractChasteRegion<DIM>*> >& rElectrodePairs,
00076                               std::vector<double>& rStimulusMagnitudes,
00077                               std::vector<double>& rDurations,
00078                               std::vector<double>& rPeriods,
00079                               std::vector<double>& rStarts,
00080                               std::vector<double>& rEnds);
00081
00087     boost::shared_ptr<AbstractStimulusFunction> CreateStimulusForNode(unsigned nodeIndex);
00088
00092     ~ZeroNetChargeElectrodes();
00093
00094 };
00095
00096 #endif /*ZERONETCHARGEELECTRODES_HPP_*/