Nektar::FullMatrixFuncs Struct Reference

#include <MatrixFuncs.h>

Static Public Member Functions
static unsigned int	GetRequiredStorageSize (unsigned int rows, unsigned int columns)
static unsigned int	CalculateIndex (unsigned int totalRows, unsigned int totalColumns, unsigned int curRow, unsigned int curColumn)
static std::tuple< unsigned int, unsigned int >	Advance (const unsigned int totalRows, const unsigned int totalColumns, const unsigned int curRow, const unsigned int curColumn)
template<typename DataType >
static void	Invert (unsigned int rows, unsigned int columns, Array< OneD, DataType > &data, const char transpose)
template<typename DataType >
static void	EigenSolve (unsigned int n, const Array< OneD, const DataType > &A, Array< OneD, DataType > &EigValReal, Array< OneD, DataType > &EigValImag, Array< OneD, DataType > &EigVecs)

Detailed Description

Definition at line 76 of file MatrixFuncs.h.

Member Function Documentation

Advance()

std::tuple< unsigned int, unsigned int > Nektar::FullMatrixFuncs::Advance ( const unsigned int  totalRows, const unsigned int  totalColumns, const unsigned int  curRow, const unsigned int  curColumn  )

static

Definition at line 121 of file MatrixFuncs.cpp.

{
    unsigned int nextRow    = curRow;
    unsigned int nextColumn = curColumn;
 
    if (nextRow < totalRows)
    {
        ++nextRow;
    }
 
    if (nextRow >= totalRows)
    {
        nextRow = 0;
        ++nextColumn;
    }
 
    if (nextColumn >= totalColumns)
    {
        nextRow    = std::numeric_limits<unsigned int>::max();
        nextColumn = std::numeric_limits<unsigned int>::max();
    }
 
    return std::tuple<unsigned int, unsigned int>(nextRow, nextColumn);
}

Referenced by Nektar::NekMatrix< DataType, StandardMatrixTag >::Advance(), and Nektar::FullMatrixStoragePolicyUnitTests::BOOST_AUTO_TEST_CASE().

CalculateIndex()

unsigned int Nektar::FullMatrixFuncs::CalculateIndex ( unsigned int  totalRows, unsigned int  totalColumns, unsigned int  curRow, unsigned int  curColumn  )

static

Definition at line 114 of file MatrixFuncs.cpp.

{
    return curColumn * totalRows + curRow;
}

Referenced by Nektar::FullMatrixStoragePolicyUnitTests::BOOST_AUTO_TEST_CASE().

EigenSolve()

template<typename DataType >

static void Nektar::FullMatrixFuncs::EigenSolve ( unsigned int  n, const Array< OneD, const DataType > &  A, Array< OneD, DataType > &  EigValReal, Array< OneD, DataType > &  EigValImag, Array< OneD, DataType > &  EigVecs  )

inlinestatic

Definition at line 160 of file MatrixFuncs.h.

    {
        int lda = n, info = 0;
        DataType dum;
        char uplo = 'N';
 
        if (EigVecs.size() != 0) // calculate Right Eigen Vectors
        {
            int lwork = 4 * lda;
            Array<OneD, DataType> work(4 * lda);
            char lrev = 'V';
            Lapack::DoSgeev(uplo, lrev, lda, A.data(), lda, EigValReal.data(),
                            EigValImag.data(), &dum, 1, EigVecs.data(), lda,
                            &work[0], lwork, info);
        }
        else
        {
            int lwork = 3 * lda;
            Array<OneD, DataType> work(3 * lda);
            char lrev = 'N';
            Lapack::DoSgeev(uplo, lrev, lda, A.data(), lda, EigValReal.data(),
                            EigValImag.data(), &dum, 1, &dum, 1, &work[0],
                            lwork, info);
        }
        ASSERTL0(info == 0, "Info is not zero");
    }

References ASSERTL0, Nektar::Array< OneD, DataType >::data(), Lapack::DoSgeev(), and Nektar::Array< OneD, const DataType >::size().

Referenced by Nektar::NekMatrix< DataType, StandardMatrixTag >::EigenSolve().

GetRequiredStorageSize()

unsigned int Nektar::FullMatrixFuncs::GetRequiredStorageSize ( unsigned int  rows, unsigned int  columns  )

static

Definition at line 108 of file MatrixFuncs.cpp.

{
    return rows * columns;
}

Referenced by Nektar::ConstMatrix< DataType >::GetRequiredStorageSize().

Invert()

template<typename DataType >

static void Nektar::FullMatrixFuncs::Invert ( unsigned int  rows, unsigned int  columns, Array< OneD, DataType > &  data, const char  transpose  )

inlinestatic

Definition at line 91 of file MatrixFuncs.h.

    {
        ASSERTL0(rows == columns, "Only square matrices can be inverted.");
        ASSERTL0(transpose == 'N',
                 "Only untransposed matrices may be inverted.");
 
        int m    = rows;
        int n    = columns;
        int info = 0;
        Array<OneD, int> ipivot(n);
        Array<OneD, DataType> work(n);
 
        if (std::is_floating_point_v<DataType>)
        {
            switch (sizeof(DataType))
            {
                case sizeof(NekDouble):
                    break;
                case sizeof(NekSingle):
                    break;
                default:
                    ASSERTL0(
                        false,
                        "Invert DataType is neither NekDouble nor NekSingle");
                    break;
            }
        }
        else
        {
            ASSERTL0(false,
                     "FullMatrixFuncs::Invert DataType is not floating point");
        }
 
        Lapack::DoSgetrf(m, n, data.data(), m, ipivot.data(), info);
 
        if (info < 0)
        {
            std::string message =
                "ERROR: The " + std::to_string(-info) +
                "th parameter had an illegal parameter for dgetrf";
            ASSERTL0(false, message.c_str());
        }
        else if (info > 0)
        {
            std::string message = "ERROR: Element u_" + std::to_string(info) +
                                  std::to_string(info) + " is 0 from dgetrf";
            ASSERTL0(false, message.c_str());
        }
 
        Lapack::DoSgetri(n, data.data(), n, ipivot.data(), work.data(), n,
                         info);
 
        if (info < 0)
        {
            std::string message =
                "ERROR: The " + std::to_string(-info) +
                "th parameter had an illegal parameter for dgetri";
            ASSERTL0(false, message.c_str());
        }
        else if (info > 0)
        {
            std::string message = "ERROR: Element u_" + std::to_string(info) +
                                  std::to_string(info) + " is 0 from dgetri";
            ASSERTL0(false, message.c_str());
        }
    }

References ASSERTL0, Nektar::Array< OneD, DataType >::data(), Lapack::DoSgetrf(), and Lapack::DoSgetri().

Referenced by Nektar::NekMatrix< DataType, StandardMatrixTag >::Invert().