Nektar::DiagonalMatrixFuncs Struct Reference

#include <MatrixFuncs.h>

Static Public Member Functions
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)
static unsigned int	GetRequiredStorageSize (unsigned int rows, unsigned int columns)
static unsigned int	CalculateIndex (unsigned int row, unsigned int col)

Detailed Description

Definition at line 278 of file MatrixFuncs.h.

Member Function Documentation

Advance()

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

static

Definition at line 328 of file MatrixFuncs.cpp.

{
    ASSERTL0(
        curRow == curColumn,
        "Iteration of a diagonal matrix is only valid along the diagonal.");
 
    unsigned int nextRow    = curRow;
    unsigned int nextColumn = curColumn;
 
    if (nextRow < totalRows)
    {
        ++nextRow;
        ++nextColumn;
    }
 
    if (nextRow >= totalRows)
    {
        nextRow    = std::numeric_limits<unsigned int>::max();
        nextColumn = std::numeric_limits<unsigned int>::max();
    }
 
    return std::tuple<unsigned int, unsigned int>(nextRow, nextColumn);
}

References ASSERTL0.

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

CalculateIndex()

unsigned int Nektar::DiagonalMatrixFuncs::CalculateIndex ( unsigned int  row, unsigned int  col  )

static

Definition at line 362 of file MatrixFuncs.cpp.

{
    if (row == col)
    {
        return row;
    }
    else
    {
        return std::numeric_limits<unsigned int>::max();
    }
}

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

GetRequiredStorageSize()

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

static

Definition at line 355 of file MatrixFuncs.cpp.

{
    ASSERTL0(rows == columns, "Diagonal matrices must be square.");
    return rows;
}

References ASSERTL0.

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

Invert()

template<typename DataType >

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

inlinestatic

Definition at line 285 of file MatrixFuncs.h.

    {
        ASSERTL0(rows == columns, "Only square matrices can be inverted.");
        for (unsigned int i = 0; i < rows; ++i)
        {
            data[i] = 1.0 / data[i];
        }
    }

References ASSERTL0.

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