GeneralPlaneStimulusCellFactory.hpp

00001 /*
00002 
00003 Copyright (C) University of Oxford, 2005-2010
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 GENERALPLANESTIMULUSCELLFACTORY_HPP_
00030 #define GENERALPLANESTIMULUSCELLFACTORY_HPP_
00031 
00032 #include "PlaneStimulusCellFactory.hpp"
00033 
00041 template <class CELL, unsigned ELEMENT_DIM, unsigned SPACE_DIM = ELEMENT_DIM>
00042 class GeneralPlaneStimulusCellFactory : public PlaneStimulusCellFactory<CELL,ELEMENT_DIM,SPACE_DIM>
00043 {
00044 
00045 public:
00061     GeneralPlaneStimulusCellFactory(unsigned numEleAcross, double meshWidth, bool useMeshWidthAsMag=false, double stimulusMagnitude=-1e7, double stimulusDuration=0.5)
00062         : PlaneStimulusCellFactory<CELL,ELEMENT_DIM, SPACE_DIM>(stimulusMagnitude,stimulusDuration) // These values are overridden below anyway.
00063     {
00064         if (useMeshWidthAsMag)
00065         {
00066             #define COVERAGE_IGNORE
00067             this->mpStimulus.reset(new SimpleStimulus(meshWidth, 0.5));
00068             #undef COVERAGE_IGNORE
00069         }
00070         else
00071         {
00072             stimulusMagnitude*=numEleAcross/(64.0);
00073             // ELEMENT_DIM==1 Justification: elements go half size with each refinement
00074             // ELEMENT_DIM==2 Justification: Triangles go quarter size with each refinement, but there are twice as many nodes on boundary
00075             // ELEMENT_DIM==3 Hypothesis: Triangles go eighth size with each refinement, but there are four-times as many nodes on boundary
00076             stimulusMagnitude*=meshWidth/(0.2);
00077 
00078             //std::cout<<"Mag is "<<stimulusMagnitude<<"\n";
00079             this->mpStimulus.reset(new SimpleStimulus(stimulusMagnitude, stimulusDuration));
00080             LOG(1, "Defined a GeneralPlaneStimulusCellFactory<"<<SPACE_DIM<<"> with SimpleStimulus("<<stimulusMagnitude<<","<< stimulusDuration<< ")\n");
00081         }
00082     }
00083 
00084 };
00085 
00086 #endif /*GENERALPLANESTIMULUSCELLFACTORY_HPP_*/

Generated by  doxygen 1.6.2