Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
AbstractLookupTableCollection.hpp
1/*
2
3Copyright (c) 2005-2024, University of Oxford.
4All rights reserved.
5
6University of Oxford means the Chancellor, Masters and Scholars of the
7University of Oxford, having an administrative office at Wellington
8Square, Oxford OX1 2JD, UK.
9
10This file is part of Chaste.
11
12Redistribution and use in source and binary forms, with or without
13modification, 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
23THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
24AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
27LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
29GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33
34*/
35
36#ifndef ABSTRACTLOOKUPTABLECOLLECTION_HPP_
37#define ABSTRACTLOOKUPTABLECOLLECTION_HPP_
38
39#include <string>
40#include <vector>
41
42#include "GenericEventHandler.hpp"
43
50{
51public:
56
60 std::vector<std::string> GetKeyingVariableNames() const;
61
67 unsigned GetNumberOfTables(const std::string& rKeyingVariableName) const;
68
77 void GetTableProperties(const std::string& rKeyingVariableName, double& rMin, double& rStep, double& rMax) const;
78
87 void SetTableProperties(const std::string& rKeyingVariableName, double min, double step, double max);
88
96 void SetTimestep(double dt);
97
101 virtual void RegenerateTables()=0;
102
112 virtual void FreeMemory()=0;
113
116
120 class EventHandler : public GenericEventHandler<1, EventHandler>
121 {
122 public:
124 static const char* EventName[1];
125
127 typedef enum
128 {
129 GENERATE_TABLES=0
130 } EventType;
131 };
132
133protected:
139 unsigned GetTableIndex(const std::string& rKeyingVariableName) const;
140
142 std::vector<std::string> mKeyingVariableNames;
143
145 std::vector<unsigned> mNumberOfTables;
146
148 std::vector<double> mTableSteps;
149
151 std::vector<double> mTableStepInverses;
152
154 std::vector<double> mTableMins;
155
157 std::vector<double> mTableMaxs;
158
160 std::vector<bool> mNeedsRegeneration;
161
163 double mDt;
164};
165
166#endif // ABSTRACTLOOKUPTABLECOLLECTION_HPP_
unsigned GetTableIndex(const std::string &rKeyingVariableName) const
virtual void RegenerateTables()=0
std::vector< std::string > GetKeyingVariableNames() const
unsigned GetNumberOfTables(const std::string &rKeyingVariableName) const
void SetTableProperties(const std::string &rKeyingVariableName, double min, double step, double max)
void GetTableProperties(const std::string &rKeyingVariableName, double &rMin, double &rStep, double &rMax) const