AbstractLookupTableCollection.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 ABSTRACTLOOKUPTABLECOLLECTION_HPP_
00030 #define ABSTRACTLOOKUPTABLECOLLECTION_HPP_
00031 
00032 #include <string>
00033 #include <vector>
00034 
00035 #include "GenericEventHandler.hpp"
00036 
00042 class AbstractLookupTableCollection
00043 {
00044 public:
00048     AbstractLookupTableCollection();
00049 
00053     std::vector<std::string> GetKeyingVariableNames() const;
00054 
00060     unsigned GetNumberOfTables(const std::string& rKeyingVariableName) const;
00061 
00070     void GetTableProperties(const std::string& rKeyingVariableName, double& rMin, double& rStep, double& rMax) const;
00071 
00080     void SetTableProperties(const std::string& rKeyingVariableName, double min, double step, double max);
00081 
00089     void SetTimestep(double dt);
00090 
00094     virtual void RegenerateTables()=0;
00095 
00097     virtual ~AbstractLookupTableCollection();
00098 
00102     class EventHandler : public GenericEventHandler<1, EventHandler>
00103     {
00104     public:
00106         static const char* EventName[1];
00107 
00109         typedef enum
00110         {
00111             GENERATE_TABLES=0
00112         } EventType;
00113     };
00114 
00115 protected:
00121     unsigned GetTableIndex(const std::string& rKeyingVariableName) const;
00122 
00124     std::vector<std::string> mKeyingVariableNames;
00125 
00127     std::vector<unsigned> mNumberOfTables;
00128 
00130     std::vector<double> mTableSteps;
00131 
00133     std::vector<double> mTableStepInverses;
00134 
00136     std::vector<double> mTableMins;
00137 
00139     std::vector<double> mTableMaxs;
00140 
00142     std::vector<bool> mNeedsRegeneration;
00143 
00145     double mDt;
00146 };
00147 
00148 #endif // ABSTRACTLOOKUPTABLECOLLECTION_HPP_

Generated on Tue May 31 14:31:41 2011 for Chaste by  doxygen 1.5.5