Nektar::BandedMatrixFuncs Struct Reference

#include <MatrixFuncs.h>

Static Public Member Functions
static unsigned int	GetRequiredStorageSize (unsigned int totalRows, unsigned int totalColumns, unsigned int subDiags, unsigned int superDiags)
	Calculates and returns the storage size required. More...
static unsigned int	CalculateNumberOfDiags (unsigned int totalRows, unsigned int diags)
static unsigned int	CalculateNumberOfRows (unsigned int totalRows, unsigned int subDiags, unsigned int superDiags)
static unsigned int	CalculateIndex (unsigned int totalRows, unsigned int totalColumns, unsigned int row, unsigned int column, unsigned int sub, unsigned int super)
static std::tuple< unsigned int, unsigned int >	Advance (const unsigned int totalRows, const unsigned int totalColumns, const unsigned int curRow, const unsigned int curColumn)

Detailed Description

Definition at line 48 of file MatrixFuncs.h.

Member Function Documentation

Advance()

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

static

Definition at line 100 of file MatrixFuncs.cpp.

{
    boost::ignore_unused(totalRows, totalColumns);
    unsigned int nextRow    = curRow;
    unsigned int nextColumn = curColumn;
 
    return std::tuple<unsigned int, unsigned int>(nextRow, nextColumn);
}

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

CalculateIndex()

unsigned int Nektar::BandedMatrixFuncs::CalculateIndex ( unsigned int  totalRows, unsigned int  totalColumns, unsigned int  row, unsigned int  column, unsigned int  sub, unsigned int  super  )

static

Definition at line 77 of file MatrixFuncs.cpp.

{
    boost::ignore_unused(totalColumns);
    if ((column <= row &&
         (row - column) <= CalculateNumberOfDiags(totalRows, sub)) ||
        (column > row &&
         (column - row) <= CalculateNumberOfDiags(totalRows, super)))
    {
        unsigned int elementRow =
            CalculateNumberOfDiags(totalRows, super) + row - column;
        unsigned int elementColumn = column;
 
        return elementRow +
               elementColumn * CalculateNumberOfRows(totalRows, sub, super);
    }
    else
    {
        return std::numeric_limits<unsigned int>::max();
    }
}

References CalculateNumberOfDiags(), and CalculateNumberOfRows().

Referenced by Nektar::BandedMatrixStoragePolicyUnitTests::BOOST_AUTO_TEST_CASE(), and Nektar::ConstMatrix< DataType >::CalculateIndex().

CalculateNumberOfDiags()

unsigned int Nektar::BandedMatrixFuncs::CalculateNumberOfDiags ( unsigned int  totalRows, unsigned int  diags  )

static

Definition at line 52 of file MatrixFuncs.cpp.

{
    if (diags != std::numeric_limits<unsigned int>::max())
    {
        return diags;
    }
    else if (totalRows > 0)
    {
        return totalRows - 1;
    }
    else
    {
        return 0;
    }
}

Referenced by CalculateIndex(), and CalculateNumberOfRows().

CalculateNumberOfRows()

unsigned int Nektar::BandedMatrixFuncs::CalculateNumberOfRows ( unsigned int  totalRows, unsigned int  subDiags, unsigned int  superDiags  )

static

Definition at line 69 of file MatrixFuncs.cpp.

{
    return CalculateNumberOfDiags(totalRows, subDiags) +
           CalculateNumberOfDiags(totalRows, superDiags) + 1;
}

References CalculateNumberOfDiags().

Referenced by Nektar::BandedMatrixStoragePolicyUnitTests::BOOST_AUTO_TEST_CASE(), CalculateIndex(), and GetRequiredStorageSize().

GetRequiredStorageSize()

unsigned int Nektar::BandedMatrixFuncs::GetRequiredStorageSize ( unsigned int  totalRows, unsigned int  totalColumns, unsigned int  subDiags, unsigned int  superDiags  )

static

Calculates and returns the storage size required.

This method assumes that the matrix will be used with LU factorizationa and allocates additional storage as appropriate.

Definition at line 44 of file MatrixFuncs.cpp.

{
    return CalculateNumberOfRows(totalRows, subDiags, superDiags) *
           totalColumns;
}

References CalculateNumberOfRows().

Referenced by Nektar::BandedMatrixStoragePolicyUnitTests::BOOST_AUTO_TEST_CASE(), Nektar::LinearSystem::FactorMatrix(), and Nektar::ConstMatrix< DataType >::GetRequiredStorageSize().