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 00030 #ifndef ABSTRACTSTIMULUSFACTORY_HPP_ 00031 #define ABSTRACTSTIMULUSFACTORY_HPP_ 00032 00033 #include <boost/shared_ptr.hpp> 00034 00035 #include "AbstractStimulusFunction.hpp" 00036 #include "AbstractTetrahedralMesh.hpp" 00037 #include "AbstractIvpOdeSolver.hpp" 00038 #include "ZeroStimulus.hpp" 00039 #include "AbstractChasteRegion.hpp" 00040 #include "BoundaryConditionsContainer.hpp" 00041 #include "Node.hpp" 00042 00052 template<unsigned ELEMENT_DIM, unsigned SPACE_DIM = ELEMENT_DIM> 00053 class AbstractStimulusFactory 00054 { 00055 protected: 00056 00060 AbstractTetrahedralMesh<ELEMENT_DIM,SPACE_DIM>* mpMesh; 00061 00063 std::vector<AbstractChasteRegion<SPACE_DIM>* > mGroundedRegions; 00064 00065 public: 00066 00075 virtual boost::shared_ptr<AbstractStimulusFunction> CreateStimulusForNode(unsigned nodeIndex); 00076 00080 virtual unsigned GetNumberOfCells(); 00081 00088 virtual void SetCompatibleExtracellularStimulus(); 00089 00093 AbstractStimulusFactory(); 00094 00098 virtual ~AbstractStimulusFactory(); 00099 00103 void SetMesh(AbstractTetrahedralMesh<ELEMENT_DIM,SPACE_DIM>* pMesh); 00104 00108 AbstractTetrahedralMesh<ELEMENT_DIM,SPACE_DIM>* GetMesh(); 00109 00110 // /* 00111 // * Allow specification of a chaste region where nodes have extracellular potential grounded 00112 // * 00113 // * @param pRegion the region to be grounded. 00114 // */ 00115 // void SetRegionToBeGrounded(AbstractChasteRegion<SPACE_DIM>* pRegion); 00116 00121 std::vector<AbstractChasteRegion<SPACE_DIM>* > GetRegionsToBeGrounded(); 00122 }; 00123 00124 #endif /*ABSTRACTSTIMULUSFACTORY_HPP_*/ 00125