Nektar++
Equation.cpp
Go to the documentation of this file.
1 ////////////////////////////////////////////////////////////////////////////////
2 //
3 // File: Equation.cpp
4 //
5 // For more information, please see: http://www.nektar.info/
6 //
7 // The MIT License
8 //
9 // Copyright (c) 2006 Division of Applied Mathematics, Brown University (USA),
10 // Department of Aeronautics, Imperial College London (UK), and Scientific
11 // Computing and Imaging Institute, University of Utah (USA).
12 //
13 // License for the specific language governing rights and limitations under
14 // Permission is hereby granted, free of charge, to any person obtaining a
15 // copy of this software and associated documentation files (the "Software"),
16 // to deal in the Software without restriction, including without limitation
17 // the rights to use, copy, modify, merge, publish, distribute, sublicense,
18 // and/or sell copies of the Software, and to permit persons to whom the
19 // Software is furnished to do so, subject to the following conditions:
20 //
21 // The above copyright notice and this permission notice shall be included
22 // in all copies or substantial portions of the Software.
23 //
24 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
25 // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
26 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
27 // THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
28 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
29 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
30 // DEALINGS IN THE SOFTWARE.
31 //
32 // Description: Wrapper to ExpressionEvaluator class
33 //
34 ////////////////////////////////////////////////////////////////////////////////
35 #ifndef NEKTAR_SPATIALDOMAINS_EQUATION_CPP
36 #define NEKTAR_SPATIALDOMAINS_EQUATION_CPP
37 
39 
40 namespace Nektar
41 {
42  namespace LibUtilities
43  {
44  /** @class Equation
45  * This class stores a string form of a symbolic expression
46  * to be evaluated e.g. for the boundary conditions, the unique
47  * numeric ID of that expression and a reference to the unique
48  * static instance of AnalyticExpressionEvaluator.
49  *
50  * The scenario is that for multiple copies of
51  * Equation class holding their symbolic expressions in the
52  * std::string form, there is a unique instance of
53  * AnalyticExpressionEvaluator which holds a set of pre-processed
54  * symbolic expressions in the form of sequential containers of
55  * execution functors, ready for fast evaluation.
56  *
57  * AnalyticExpressionEvaluator also keeps all constants
58  * and parameters specified in an XML file. There should be
59  * only one copy of Equation class per each symbolic expression
60  * specified in XML file, modulo possible bugs. Classes Equation
61  * and AnalyticExpressionEvaluator live symbiotic in a sense that the
62  * expression id stored in Equation class is generated by
63  * AnalyticExpressionEvaluator which holds ordered container of
64  * pre-processed expressions.
65  *
66  */
67 
68  /// \todo refactor this class: change its name and move implementation
69  /// to this file
70 
71  // LibUtilities::AnalyticExpressionEvaluator Equation::m_evaluator;
72  }
73 }
74 
75 #endif //NEKTAR_SPATIALDOMAINS_EQUATION_CPP