Chaste  Release::3.4
AbstractUntemplatedParameterisedSystem.hpp
1 /*
2 
3 Copyright (c) 2005-2016, University of Oxford.
4 All rights reserved.
5 
6 University of Oxford means the Chancellor, Masters and Scholars of the
7 University of Oxford, having an administrative office at Wellington
8 Square, Oxford OX1 2JD, UK.
9 
10 This file is part of Chaste.
11 
12 Redistribution and use in source and binary forms, with or without
13 modification, are permitted provided that the following conditions are met:
14  * Redistributions of source code must retain the above copyright notice,
15  this list of conditions and the following disclaimer.
16  * Redistributions in binary form must reproduce the above copyright notice,
17  this list of conditions and the following disclaimer in the documentation
18  and/or other materials provided with the distribution.
19  * Neither the name of the University of Oxford nor the names of its
20  contributors may be used to endorse or promote products derived from this
21  software without specific prior written permission.
22 
23 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
24 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
27 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
29 GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32 OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 
34 */
35 
36 #ifndef ABSTRACTUNTEMPLATEDPARAMETERISEDSYSTEM_HPP_
37 #define ABSTRACTUNTEMPLATEDPARAMETERISEDSYSTEM_HPP_
38 
39 #include <vector>
40 #include <string>
41 #include <boost/shared_ptr.hpp>
42 
43 #include "AbstractOdeSystemInformation.hpp"
44 
54 {
55 public:
61  AbstractUntemplatedParameterisedSystem(unsigned numberOfStateVariables);
62 
65 
69  boost::shared_ptr<const AbstractOdeSystemInformation> GetSystemInformation() const;
70 
74  std::string GetSystemName() const;
75 
76  //
77  // Attribute methods
78  //
79 
83  unsigned GetNumberOfAttributes() const;
84 
89  bool HasAttribute(const std::string& rName) const;
90 
95  double GetAttribute(const std::string& rName) const;
96 
97  //
98  // State variable methods
99  //
100 
106  unsigned GetNumberOfStateVariables() const;
107 
111  const std::vector<std::string>& rGetStateVariableNames() const;
112 
116  const std::vector<std::string>& rGetStateVariableUnits() const;
117 
128  unsigned GetStateVariableIndex(const std::string& rName) const;
129 
138  bool HasStateVariable(const std::string& rName) const;
139 
147  std::string GetStateVariableUnits(unsigned index) const;
148 
152  virtual void ResetToInitialConditions()=0;
153 
154  //
155  // Parameter methods
156  //
157 
161  unsigned GetNumberOfParameters() const;
162 
166  const std::vector<std::string>& rGetParameterNames() const;
167 
171  const std::vector<std::string>& rGetParameterUnits() const;
172 
182  unsigned GetParameterIndex(const std::string& rName) const;
183 
192  bool HasParameter(const std::string& rName) const;
193 
201  std::string GetParameterUnits(unsigned index) const;
202 
203  //
204  // Derived quantity methods
205  //
206 
210  unsigned GetNumberOfDerivedQuantities() const;
211 
215  const std::vector<std::string>& rGetDerivedQuantityNames() const;
216 
220  const std::vector<std::string>& rGetDerivedQuantityUnits() const;
221 
227  unsigned GetDerivedQuantityIndex(const std::string& rName) const;
228 
237  bool HasDerivedQuantity(const std::string& rName) const;
238 
245  std::string GetDerivedQuantityUnits(unsigned index) const;
246 
247  //
248  // "Any variable" methods
249  //
250 
259  unsigned GetAnyVariableIndex(const std::string& rName) const;
260 
270  bool HasAnyVariable(const std::string& rName) const;
271 
279  std::string GetAnyVariableUnits(unsigned index) const;
280 
288  std::string GetAnyVariableUnits(const std::string& rName) const;
289 
290 
291 protected:
294 
301  boost::shared_ptr<AbstractOdeSystemInformation> mpSystemInfo;
302 
303 };
304 
305 
306 #endif /*ABSTRACTUNTEMPLATEDPARAMETERISEDSYSTEM_HPP_*/
const std::vector< std::string > & rGetStateVariableUnits() const
AbstractUntemplatedParameterisedSystem(unsigned numberOfStateVariables)
const std::vector< std::string > & rGetParameterUnits() const
const std::vector< std::string > & rGetStateVariableNames() const
unsigned GetParameterIndex(const std::string &rName) const
unsigned GetAnyVariableIndex(const std::string &rName) const
unsigned GetStateVariableIndex(const std::string &rName) const
boost::shared_ptr< const AbstractOdeSystemInformation > GetSystemInformation() const
const std::vector< std::string > & rGetDerivedQuantityUnits() const
boost::shared_ptr< AbstractOdeSystemInformation > mpSystemInfo
const std::vector< std::string > & rGetDerivedQuantityNames() const
const std::vector< std::string > & rGetParameterNames() const
unsigned GetDerivedQuantityIndex(const std::string &rName) const