AbstractOdeSystemInformation.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 
00030 #ifndef _ABSTRACTODESYSTEMINFORMATION_HPP_
00031 #define _ABSTRACTODESYSTEMINFORMATION_HPP_
00032 
00033 #include <vector>
00034 #include <string>
00035 #include <stdexcept>
00036 
00052 class AbstractOdeSystemInformation
00053 {
00054 protected:
00055 
00057     std::vector<std::string> mVariableNames;
00058 
00060     std::vector<std::string> mVariableUnits;
00061 
00063     std::vector<std::string> mParameterNames;
00064 
00066     std::vector<std::string> mParameterUnits;
00067 
00069     std::vector<double> mInitialConditions;
00070 
00072     bool mInitialised;
00073 
00079     virtual void Initialise()=0;
00080 
00081 public:
00082 
00086     AbstractOdeSystemInformation();
00087 
00091     virtual ~AbstractOdeSystemInformation();
00092 
00098     void SetInitialConditions(const std::vector<double>& rInitialConditions);
00099 
00106     void SetInitialConditionsComponent(unsigned index, double initialCondition) throw(std::out_of_range);
00107 
00111     std::vector<double> GetInitialConditions() const;
00112 
00116     const std::vector<std::string>& rGetVariableNames() const;
00117 
00121     const std::vector<std::string>& rGetVariableUnits() const;
00122 
00132     unsigned GetStateVariableNumberByName(const std::string& rName) const;
00133 
00141     std::string GetStateVariableUnitsByNumber(unsigned varNumber) const;
00142 
00146     const std::vector<std::string>& rGetParameterNames() const;
00147 
00151     const std::vector<std::string>& rGetParameterUnits() const;
00152 };
00153 
00154 
00155 #endif /*_ABSTRACTODESYSTEMINFORMATION_HPP_*/

Generated by  doxygen 1.6.2