Nektar++
GlobalMatrix.h
Go to the documentation of this file.
1 ///////////////////////////////////////////////////////////////////////////////
2 //
3 // File: GlobalMatrix.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: GlobalMatrix header
33 //
34 ///////////////////////////////////////////////////////////////////////////////
35 #ifndef NEKTAR_LIB_MULTIREGIONS_GLOBALMATRIX_H
36 #define NEKTAR_LIB_MULTIREGIONS_GLOBALMATRIX_H
40 
41 namespace Nektar
42 {
43  namespace MultiRegions
44  {
45 
46  /// Represents a matrix of all degrees of freedom.
48  {
49  public:
51  typedef boost::shared_ptr<DNekSmvBsrMat> DNekSmvBsrMatSharedPtr;
52 
53  /// Construct a new matrix.
56  unsigned int rows,
57  unsigned int columns,
58  const COOMatType &cooMat,
59  const MatrixStorage& matStorage = eFULL);
60 
62 
63 
64  /// Perform a matrix-vector multiply.
68 
69  MULTI_REGIONS_EXPORT const unsigned long GetMulCallsCounter() const;
70  MULTI_REGIONS_EXPORT const unsigned int GetNumNonZeroEntries() const;
71 
72  private:
73  /// Pointer to a double-precision Nektar++ sparse matrix.
74  DNekSmvBsrMatSharedPtr m_smvbsrmatrix;
75 
76  unsigned int m_rows;
79 
80  unsigned long m_mulCallsCounter;
81 
82  bool m_copyOp;
83 
84  static std::string def;
85  static std::string lookupIds[];
86  };
87 
88  /// Shared pointer to a GlobalMatrix object.
89  typedef boost::shared_ptr<GlobalMatrix> GlobalMatrixSharedPtr;
90  /// Mapping from global matrix keys to global matrices.
91  typedef map<GlobalMatrixKey,GlobalMatrixSharedPtr> GlobalMatrixMap;
92  /// Shared pointer to a global matrix map.
93  typedef boost::shared_ptr<GlobalMatrixMap> GlobalMatrixMapShPtr;
94 
95  } //end of namespace
96 } //end of namespace
97 
98 #endif
std::map< CoordType, NekDouble > COOMatType
Array< OneD, NekDouble > m_tmpout
Definition: GlobalMatrix.h:78
const unsigned int GetNumNonZeroEntries() const
#define MULTI_REGIONS_EXPORT
static std::string lookupIds[]
Definition: GlobalMatrix.h:85
const unsigned long GetMulCallsCounter() const
boost::shared_ptr< GlobalMatrix > GlobalMatrixSharedPtr
Shared pointer to a GlobalMatrix object.
Definition: GlobalMatrix.h:89
boost::shared_ptr< SessionReader > SessionReaderSharedPtr
Definition: MeshPartition.h:50
map< GlobalMatrixKey, GlobalMatrixSharedPtr > GlobalMatrixMap
Mapping from global matrix keys to global matrices.
Definition: GlobalMatrix.h:91
void Multiply(const Array< OneD, const NekDouble > &in, Array< OneD, NekDouble > &out)
Perform a matrix-vector multiply.
GlobalMatrix(const LibUtilities::SessionReaderSharedPtr &pSession, unsigned int rows, unsigned int columns, const COOMatType &cooMat, const MatrixStorage &matStorage=eFULL)
Construct a new matrix.
Represents a matrix of all degrees of freedom.
Definition: GlobalMatrix.h:47
Array< OneD, NekDouble > m_tmpin
Definition: GlobalMatrix.h:77
boost::shared_ptr< GlobalMatrixMap > GlobalMatrixMapShPtr
Shared pointer to a global matrix map.
Definition: GlobalMatrix.h:93
boost::shared_ptr< DNekSmvBsrMat > DNekSmvBsrMatSharedPtr
Definition: GlobalMatrix.h:51
NekSparseMatrix< StorageSmvBsr< NekDouble > > DNekSmvBsrMat
Definition: GlobalMatrix.h:50
DNekSmvBsrMatSharedPtr m_smvbsrmatrix
Pointer to a double-precision Nektar++ sparse matrix.
Definition: GlobalMatrix.h:74