GlobalLinSysKey.h

Go to the documentation of this file.

///////////////////////////////////////////////////////////////////////////////
//
// File: GlobalLinSysKey.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: Headers for GlobalLinSysKey
//
///////////////////////////////////////////////////////////////////////////////
 
#ifndef NEKTAR_LIBS_MULTIREGIONS_GLOBALLINSYSKEY_H
#define NEKTAR_LIBS_MULTIREGIONS_GLOBALLINSYSKEY_H
#include <MultiRegions/GlobalMatrixKey.h>
#include <MultiRegions/MultiRegions.hpp>
#include <MultiRegions/MultiRegionsDeclspec.h>
 
namespace Nektar::MultiRegions
{
 
typedef std::map<StdRegions::ConstFactorType, Array<OneD, NekDouble>>
    VarFactorsMap;
static VarFactorsMap NullVarFactorsMap;
 
/// Describe a linear system.
class GlobalLinSysKey : public GlobalMatrixKey
{
public:
    MULTI_REGIONS_EXPORT GlobalLinSysKey(
        const StdRegions::MatrixType matrixType,
        const AssemblyMapSharedPtr &locToGloMap = NullAssemblyMapSharedPtr,
        const StdRegions::ConstFactorMap &factors =
            StdRegions::NullConstFactorMap,
        const StdRegions::VarCoeffMap &varCoeffs = StdRegions::NullVarCoeffMap,
        const VarFactorsMap &varFactos           = NullVarFactorsMap);
 
    /// Copy constructor.
    MULTI_REGIONS_EXPORT GlobalLinSysKey(const GlobalLinSysKey &key);
 
    /// Destructor.
    MULTI_REGIONS_EXPORT ~GlobalLinSysKey() override;
 
    /// Less-than operator for GlobalLinSysKey comparison.
    MULTI_REGIONS_EXPORT friend bool operator<(const GlobalLinSysKey &lhs,
                                               const GlobalLinSysKey &rhs);
 
    /// Return the associated solution type.
    inline GlobalSysSolnType GetGlobalSysSolnType() const;
 
    MULTI_REGIONS_EXPORT int GetNVarFactors() const;
 
    MULTI_REGIONS_EXPORT const Array<OneD, const NekDouble> &GetVarFactors(
        const StdRegions::ConstFactorType &coeff) const;
 
    MULTI_REGIONS_EXPORT const VarFactorsMap &GetVarFactors() const;
 
protected:
    /// Store the solution type associated with the linear system. This
    /// may be none, full matrix, static condensation or multi-level
    /// static condensation.
    GlobalSysSolnType m_solnType;
    VarFactorsMap m_varFactors;
    std::vector<std::size_t> m_varFactors_hashes;
 
private:
};
 
/// Writes information about the object to a given stream.
MULTI_REGIONS_EXPORT std::ostream &operator<<(std::ostream &os,
                                              const GlobalLinSysKey &rhs);
 
inline GlobalSysSolnType GlobalLinSysKey::GetGlobalSysSolnType() const
{
    return m_solnType;
}
 
inline int GlobalLinSysKey::GetNVarFactors() const
{
    return m_varFactors.size();
}
 
inline const Array<OneD, const NekDouble> &GlobalLinSysKey::GetVarFactors(
    const StdRegions::ConstFactorType &factor) const
{
    ASSERTL1(m_varFactors.count(factor) > 0, "factor not found");
    VarFactorsMap::const_iterator found = m_varFactors.find(factor);
    return (*found).second;
}
 
inline const VarFactorsMap &GlobalLinSysKey::GetVarFactors() const
{
    return m_varFactors;
}
} // namespace Nektar::MultiRegions
 
#endif