Nektar::SymmetricMatrixFuncs Struct Reference

#include <MatrixFuncs.h>

Inheritance diagram for Nektar::SymmetricMatrixFuncs:

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

Additional Inherited Members
Static Private Member Functions inherited from Nektar::TriangularMatrixFuncs
static unsigned int	GetRequiredStorageSize (unsigned int rows, unsigned int columns)

Detailed Description

Definition at line 222 of file MatrixFuncs.h.

Member Function Documentation

Advance()

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

static

Definition at line 289 of file MatrixFuncs.cpp.

{
    ASSERTL1(totalRows == totalColumns, "Symmetric matrices must be square.");
    ASSERTL1(curRow < totalRows,
             "Attemping to iterate through an element on row " +
                 std::to_string(curRow) + " of a (" +
                 std::to_string(totalRows) + ", " +
                 std::to_string(totalColumns) + " symmetric matrix.");
    ASSERTL1(curColumn < totalColumns,
             "Attemping to iterate through an element on row " +
                 std::to_string(curColumn) + " of a (" +
                 std::to_string(totalRows) + ", " +
                 std::to_string(totalColumns) + " symmetric matrix.");
 
    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);
}

References ASSERTL1.

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

CalculateIndex()

unsigned int Nektar::SymmetricMatrixFuncs::CalculateIndex ( unsigned int  curRow, unsigned int  curColumn  )

static

Definition at line 276 of file MatrixFuncs.cpp.

{
    if (curRow <= curColumn)
    {
        return curRow + curColumn * (curColumn + 1) / 2;
    }
    else
    {
        return curColumn + curRow * (curRow + 1) / 2;
    }
}

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

GetRequiredStorageSize()

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

static

Definition at line 192 of file MatrixFuncs.cpp.

{
    ASSERTL0(rows == columns, "Triangular matrices must be square.");
    return rows * (rows + 1) / 2;
}

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

Invert()

template<typename DataType >

static void Nektar::SymmetricMatrixFuncs::Invert ( unsigned int  rows, unsigned int  columns, Array< OneD, DataType > &  data  )

inlinestatic

Definition at line 230 of file MatrixFuncs.h.

    {
        ASSERTL0(rows == columns, "Only square matrices can be inverted.");
 
        int n    = columns;
        int info = 0;
        Array<OneD, int> ipivot(n);
        Array<OneD, DataType> work(n);
 
        Lapack::DoSsptrf('U', n, data.get(), ipivot.get(), info);
 
        if (info < 0)
        {
            std::string message =
                "ERROR: The " + std::to_string(-info) +
                "th parameter had an illegal parameter for dsptrf";
            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 dsptrf";
            ASSERTL0(false, message.c_str());
        }
 
        Lapack::DoSsptri('U', n, data.get(), ipivot.get(), work.get(), info);
 
        if (info < 0)
        {
            std::string message =
                "ERROR: The " + std::to_string(-info) +
                "th parameter had an illegal parameter for dsptri";
            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 dsptri";
            ASSERTL0(false, message.c_str());
        }
    }

References ASSERTL0, Lapack::DoSsptrf(), Lapack::DoSsptri(), and Nektar::Array< OneD, DataType >::get().

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