GlobalMatrix.h

Go to the documentation of this file.

///////////////////////////////////////////////////////////////////////////////
//
// File: GlobalMatrix.h
//
// For more information, please see: http://www.nektar.info
//
// The MIT License
//
// Copyright (c) 2006 Division of Applied Mathematics, Brown University (USA),
// Department of Aeronautics, Imperial College London (UK), and Scientific
// Computing and Imaging Institute, University of Utah (USA).
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the "Software"),
// to deal in the Software without restriction, including without limitation
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
// and/or sell copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included
// in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
//
// Description: GlobalMatrix header
//
///////////////////////////////////////////////////////////////////////////////
#ifndef NEKTAR_LIB_MULTIREGIONS_GLOBALMATRIX_H
#define NEKTAR_LIB_MULTIREGIONS_GLOBALMATRIX_H
#include <LibUtilities/LinearAlgebra/SparseMatrixFwd.hpp>
#include <MultiRegions/GlobalMatrixKey.h>
#include <MultiRegions/MultiRegionsDeclspec.h>
 
namespace Nektar::MultiRegions
{
 
/// Represents a matrix of all degrees of freedom.
class GlobalMatrix
{
public:
    typedef NekSparseMatrix<StorageSmvBsr<NekDouble>> DNekSmvBsrMat;
    typedef std::shared_ptr<DNekSmvBsrMat> DNekSmvBsrMatSharedPtr;
 
    /// Construct a new matrix.
    MULTI_REGIONS_EXPORT GlobalMatrix(
        const LibUtilities::SessionReaderSharedPtr &pSession, unsigned int rows,
        unsigned int columns, const COOMatType &cooMat,
        const MatrixStorage &matStorage = eFULL);
 
    MULTI_REGIONS_EXPORT ~GlobalMatrix()
    {
    }
 
    /// Perform a matrix-vector multiply.
    MULTI_REGIONS_EXPORT void Multiply(const Array<OneD, const NekDouble> &in,
                                       Array<OneD, NekDouble> &out);
 
    MULTI_REGIONS_EXPORT unsigned long GetMulCallsCounter() const;
    MULTI_REGIONS_EXPORT unsigned int GetNumNonZeroEntries() const;
 
private:
    /// Pointer to a double-precision Nektar++ sparse matrix.
    DNekSmvBsrMatSharedPtr m_smvbsrmatrix;
 
    unsigned int m_rows;
    Array<OneD, NekDouble> m_tmpin;
    Array<OneD, NekDouble> m_tmpout;
 
    unsigned long m_mulCallsCounter;
 
    bool m_copyOp;
 
    static std::string def;
    static std::string lookupIds[];
};
 
/// Shared pointer to a GlobalMatrix object.
typedef std::shared_ptr<GlobalMatrix> GlobalMatrixSharedPtr;
/// Mapping from global matrix keys to global matrices.
typedef std::map<GlobalMatrixKey, GlobalMatrixSharedPtr> GlobalMatrixMap;
/// Shared pointer to a global matrix map.
typedef std::shared_ptr<GlobalMatrixMap> GlobalMatrixMapShPtr;
 
} // namespace Nektar::MultiRegions
 
#endif