Nektar++
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
MatrixKey.h
Go to the documentation of this file.
1 ///////////////////////////////////////////////////////////////////////////////
2 //
3 // File MatrixKeys.h
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: Headers for MatrixKey
33 //
34 ///////////////////////////////////////////////////////////////////////////////
35 
36 #ifndef MATRIXKEY_H
37 #define MATRIXKEY_H
38 
42 
43 namespace Nektar
44 {
45  namespace LocalRegions
46  {
47 
49  {
50  public:
52  const LibUtilities::ShapeType shapeType,
53  const StdRegions::StdExpansion &stdExpansion,
57 
58  LOCAL_REGIONS_EXPORT MatrixKey(const MatrixKey& mkey,
59  const StdRegions::MatrixType matrixType);
60 
62 
63  virtual ~MatrixKey()
64  {
65  }
66 
67  /// Used to lookup the create function in NekManager.
68  struct opLess
69  {
70  LOCAL_REGIONS_EXPORT bool operator()(const MatrixKey &lhs, const MatrixKey &rhs) const;
71  };
72 
73  /// Used for finding value given the key in NekManager.
74  LOCAL_REGIONS_EXPORT friend bool operator<(const MatrixKey &lhs, const MatrixKey &rhs);
75  LOCAL_REGIONS_EXPORT friend bool opLess::operator()(const MatrixKey &lhs,
76  const MatrixKey &rhs) const;
77 
79  {
80  return m_metricinfo;
81  }
82 
83  protected:
84  MatrixKey();
85 
87 
88  private:
89  };
90 
91  } // end of namespace
92 } // end of namespace
93 
94 #endif //STDMATRIXKEY_H
95