Chaste  Release::3.4
AbstractLookupTableCollection.cpp
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 #include "AbstractLookupTableCollection.hpp"
37 
38 #include <cmath>
39 
41  : mDt(0.0)
42 {
43 }
44 
46 {
47  return mKeyingVariableNames;
48 }
49 
50 unsigned AbstractLookupTableCollection::GetNumberOfTables(const std::string& rKeyingVariableName) const
51 {
52  return mNumberOfTables[GetTableIndex(rKeyingVariableName)];
53 }
54 
55 void AbstractLookupTableCollection::GetTableProperties(const std::string& rKeyingVariableName, double& rMin, double& rStep, double& rMax) const
56 {
57  unsigned i = GetTableIndex(rKeyingVariableName);
58  rMin = mTableMins[i];
59  rStep = mTableSteps[i];
60  rMax = mTableMaxs[i];
61 }
62 
63 void AbstractLookupTableCollection::SetTableProperties(const std::string& rKeyingVariableName, double min, double step, double max)
64 {
65  // Check inputs
66  unsigned num_steps = (unsigned) ((max-min)/step+0.5);
68  if (fabs(max - min - num_steps*step) > 1e-10)
69  {
70  EXCEPTION("Table step size does not divide range between table limits.");
71  }
72  // Set state
73  unsigned i = GetTableIndex(rKeyingVariableName);
74  if ((min != mTableMins[i]) || (step != mTableSteps[i]) || (max != mTableMaxs[i]))
75  {
76  mNeedsRegeneration[i] = true;
77  }
78  mTableMins[i] = min;
79  mTableSteps[i] = step;
80  mTableStepInverses[i] = 1/step;
81  mTableMaxs[i] = max;
82 }
83 
85 {
86  if (mDt != dt)
87  {
88  mNeedsRegeneration.assign(mNeedsRegeneration.size(), true);
89  }
90  mDt = dt;
91 }
92 
93 unsigned AbstractLookupTableCollection::GetTableIndex(const std::string& rKeyingVariableName) const
94 {
95  unsigned i=0;
96  for (; i<mKeyingVariableNames.size(); i++)
97  {
98  if (mKeyingVariableNames[i] == rKeyingVariableName)
99  {
100  break;
101  }
102  }
103  if (i == mKeyingVariableNames.size())
104  {
105  EXCEPTION("Lookup table keying variable '" + rKeyingVariableName + "' does not exist.");
106  }
107  return i;
108 }
109 
111 {
112 }
113 
114 const char* AbstractLookupTableCollection::EventHandler::EventName[] = {"GenTables"};
unsigned GetTableIndex(const std::string &rKeyingVariableName) const
#define EXCEPTION(message)
Definition: Exception.hpp:143
void GetTableProperties(const std::string &rKeyingVariableName, double &rMin, double &rStep, double &rMax) const
unsigned GetNumberOfTables(const std::string &rKeyingVariableName) const
std::vector< std::string > mKeyingVariableNames
std::vector< std::string > GetKeyingVariableNames() const
void SetTableProperties(const std::string &rKeyingVariableName, double min, double step, double max)