#include <StandardMatrix.hpp>

Inheritance diagram for Nektar::NekMatrix< DataType, StandardMatrixTag >:

Classes
class	iterator_impl

class	Proxy

Public Types
typedef Matrix< DataType >	BaseType

typedef NekMatrix< DataType, StandardMatrixTag >	ThisType

typedef DataType	NumberType

typedef const DataType &	ConstGetValueType

typedef DataType	GetValueType

typedef iterator_impl< const DataType, const ThisType >	const_iterator

typedef iterator_impl< DataType, ThisType >	iterator

Public Member Functions
	NekMatrix ()
	Creates an empty matrix. More...

	NekMatrix (unsigned int rows, unsigned int columns, MatrixStorage policy=eFULL, unsigned int subDiagonals=std::numeric_limits< unsigned int >::max(), unsigned int superDiagonals=std::numeric_limits< unsigned int >::max())
	Creates a rows by columns matrix. More...

	NekMatrix (unsigned int rows, unsigned int columns, MatrixStorage policy, unsigned int subDiagonals, unsigned int superDiagonals, unsigned int capacity)

	NekMatrix (unsigned int rows, unsigned int columns, typename boost::call_traits< DataType >::const_reference initValue, MatrixStorage policy=eFULL, unsigned int subDiagonals=std::numeric_limits< unsigned int >::max(), unsigned int superDiagonals=std::numeric_limits< unsigned int >::max())
	Creates a rows by columns matrix. More...

	NekMatrix (unsigned int rows, unsigned int columns, const DataType *data, MatrixStorage policy=eFULL, unsigned int subDiagonals=std::numeric_limits< unsigned int >::max(), unsigned int superDiagonals=std::numeric_limits< unsigned int >::max())
	Creates a rows by columns matrix. More...

	NekMatrix (unsigned int rows, unsigned int columns, const Array< OneD, const DataType > &d, MatrixStorage policy=eFULL, unsigned int subDiagonals=std::numeric_limits< unsigned int >::max(), unsigned int superDiagonals=std::numeric_limits< unsigned int >::max())
	Creates a rows by columns matrix. More...

	NekMatrix (unsigned int rows, unsigned int columns, const Array< OneD, DataType > &d, PointerWrapper wrapperType=eCopy, MatrixStorage policy=eFULL, unsigned int subDiagonals=std::numeric_limits< unsigned int >::max(), unsigned int superDiagonals=std::numeric_limits< unsigned int >::max())
	Creates a rows by columns matrix. More...

	NekMatrix (const ThisType &rhs)

ThisType &	operator= (const ThisType &rhs)

ThisType &	operator= (const DataType &rhs)
	Fill matrix with scalar. More...

template<typename InnerMatrixType >
ThisType &	operator= (const NekMatrix< InnerMatrixType, ScaledMatrixTag > &rhs)

ConstGetValueType	operator() (unsigned int row, unsigned int column) const
	Returns the element value at the given row and column. More...

ConstGetValueType	operator() (unsigned int row, unsigned int column, char transpose) const
	Returns the element value at the given row and column. More...

unsigned int	GetRequiredStorageSize () const

unsigned int	CalculateIndex (unsigned int row, unsigned int col, const char transpose) const

boost::call_traits< DataType >::const_reference	GetValue (unsigned int row, unsigned int column) const
	Returns the element value at the given row and column. More...

ConstGetValueType	GetValue (unsigned int row, unsigned int column, char transpose) const
	Returns the element value at the given row and column. More...

const Array< OneD, const DataType > &	GetPtr () const

DataType	Scale () const
	Returns the scaling used by this matrix. More...

const DataType *	GetRawPtr () const

iterator	begin ()

iterator	begin (char transpose)

iterator	end ()

iterator	end (char transpose)

const_iterator	begin () const

const_iterator	begin (char transpose) const

const_iterator	end () const

const_iterator	end (char transpose) const

unsigned int	GetStorageSize () const

unsigned int	GetNumberOfSubDiagonals () const

unsigned int	GetNumberOfSuperDiagonals () const

unsigned int	CalculateNumberOfRows () const

bool	operator== (const NekMatrix< DataType, StandardMatrixTag > &rhs) const
	Returns true if the this matrix and rhs are equivalent. More...

PointerWrapper	GetWrapperType () const

std::tuple< unsigned int, unsigned int >	Advance (unsigned int curRow, unsigned int curColumn) const

std::tuple< unsigned int, unsigned int >	Advance (unsigned int curRow, unsigned int curColumn, char transpose) const

void	SetSize (unsigned int rows, unsigned int cols)

Proxy	operator() (unsigned int row, unsigned int column)

Proxy	operator() (unsigned int row, unsigned int column, char transpose)

void	SetValue (unsigned int row, unsigned int column, typename boost::call_traits< DataType >::const_reference d)

void	SetValue (unsigned int row, unsigned int column, typename boost::call_traits< DataType >::const_reference d, char transpose)

Array< OneD, DataType > &	GetPtr ()

DataType *	GetRawPtr ()

DataType	AbsMaxtoMinEigenValueRatio (void)

void	EigenSolve (Array< OneD, DataType > &EigValReal, Array< OneD, DataType > &EigValImag, Array< OneD, DataType > &EigVecs)

void	Invert ()

Array< OneD, DataType > &	GetTempSpace ()

void	SwapTempAndDataBuffers ()

ThisType &	operator*= (const NumberType &s)

NekMatrix< DataType, StandardMatrixTag >	operator- () const

Public Member Functions inherited from Nektar::Matrix< DataType >
	~Matrix () override

void	SetValue (unsigned int row, unsigned int column, typename boost::call_traits< DataType >::const_reference d)

Public Member Functions inherited from Nektar::ConstMatrix< DataType >
virtual	~ConstMatrix ()

boost::call_traits< DataType >::value_type	operator() (unsigned int row, unsigned int column) const

unsigned int	GetStorageSize () const

MatrixStorage	GetType () const

MatrixStorage	GetStorageType () const

unsigned int	GetRows () const

unsigned int	GetTransposedRows (char transpose) const

unsigned int	GetColumns () const

unsigned int	GetTransposedColumns (char transpose) const

const unsigned int *	GetSize () const

void	Transpose ()

char	GetTransposeFlag () const

Static Public Member Functions
static ThisType	CreateWrapper (const ThisType &rhs)

static std::shared_ptr< ThisType >	CreateWrapper (const std::shared_ptr< ThisType > &rhs)

Static Public Member Functions inherited from Nektar::ConstMatrix< DataType >
static unsigned int	CalculateIndex (MatrixStorage type, unsigned int row, unsigned int col, unsigned int numRows, unsigned int numColumns, const char transpose='N', unsigned int numSubDiags=0, unsigned int numSuperDiags=0)

static unsigned int	GetRequiredStorageSize (MatrixStorage type, unsigned int rows, unsigned int columns, unsigned int subDiags=0, unsigned int superDiags=0)

Protected Member Functions
	NekMatrix (const ThisType &rhs, PointerWrapper wrapperType)

Array< OneD, DataType > &	GetData ()

void	RemoveExcessCapacity ()

void	ResizeDataArrayIfNeeded (unsigned int requiredStorageSize)

void	ResizeDataArrayIfNeeded ()

boost::call_traits< DataType >::value_type	v_GetValue (unsigned int row, unsigned int column) const override

unsigned int	v_GetStorageSize () const override

void	v_SetValue (unsigned int row, unsigned int column, typename boost::call_traits< DataType >::const_reference d) override

Protected Member Functions inherited from Nektar::Matrix< DataType >
	Matrix (unsigned int rows, unsigned int columns, MatrixStorage policy=eFULL)

	Matrix (const Matrix< DataType > &rhs)

Matrix< DataType > &	operator= (const Matrix< DataType > &rhs)

Matrix< DataType > &	operator= (const ConstMatrix< DataType > &rhs)

Protected Member Functions inherited from Nektar::ConstMatrix< DataType >
	ConstMatrix (unsigned int rows, unsigned int columns, MatrixStorage policy=eFULL)

	ConstMatrix (const ConstMatrix< DataType > &rhs)

ConstMatrix< DataType > &	operator= (const ConstMatrix< DataType > &rhs)

void	Resize (unsigned int rows, unsigned int columns)
	Resets the rows and columns in the array. This method does not update the data storage to match the new row and column counts. More...

void	SetTransposeFlag (char newValue)

char	GetRawTransposeFlag () const

virtual boost::call_traits< DataType >::value_type	v_GetValue (unsigned int row, unsigned int column) const =0

virtual unsigned int	v_GetStorageSize () const =0

virtual void	v_Transpose ()

virtual char	v_GetTransposeFlag () const

Private Member Functions
void	PerformCopyConstruction (const ThisType &rhs)

Private Attributes
Array< OneD, DataType >	m_data

PointerWrapper	m_wrapperType

unsigned int	m_numberOfSuperDiagonals

unsigned int	m_numberOfSubDiagonals

Array< OneD, DataType >	m_tempSpace

Detailed Description

template<typename DataType>
class Nektar::NekMatrix< DataType, StandardMatrixTag >

Standard Matrix.

Parameters

DataType The type stored in each element.

Matrices are stored in column major order to make it easier to interoperate with Blas and Lapack.

Definition at line 55 of file StandardMatrix.hpp.

Member Typedef Documentation

◆ BaseType

template<typename DataType >

typedef Matrix<DataType> Nektar::NekMatrix< DataType, StandardMatrixTag >::BaseType

Definition at line 58 of file StandardMatrix.hpp.

◆ const_iterator

template<typename DataType >

typedef iterator_impl<const DataType, const ThisType> Nektar::NekMatrix< DataType, StandardMatrixTag >::const_iterator

Definition at line 425 of file StandardMatrix.hpp.

◆ ConstGetValueType

template<typename DataType >

typedef const DataType& Nektar::NekMatrix< DataType, StandardMatrixTag >::ConstGetValueType

Definition at line 61 of file StandardMatrix.hpp.

◆ GetValueType

template<typename DataType >

typedef DataType Nektar::NekMatrix< DataType, StandardMatrixTag >::GetValueType

Definition at line 62 of file StandardMatrix.hpp.

◆ iterator

template<typename DataType >

typedef iterator_impl<DataType, ThisType> Nektar::NekMatrix< DataType, StandardMatrixTag >::iterator

Definition at line 426 of file StandardMatrix.hpp.

◆ NumberType

template<typename DataType >

typedef DataType Nektar::NekMatrix< DataType, StandardMatrixTag >::NumberType

Definition at line 60 of file StandardMatrix.hpp.

◆ ThisType

template<typename DataType >

typedef NekMatrix<DataType, StandardMatrixTag> Nektar::NekMatrix< DataType, StandardMatrixTag >::ThisType

Definition at line 59 of file StandardMatrix.hpp.

Constructor & Destructor Documentation

◆ NekMatrix() [1/9]

template<typename DataType >

Nektar::NekMatrix< DataType, StandardMatrixTag >::NekMatrix

Creates an empty matrix.

Definition at line 41 of file StandardMatrix.cpp.

    : Matrix<DataType>(0, 0, eFULL), m_data(), m_wrapperType(eCopy),
      m_numberOfSuperDiagonals(std::numeric_limits<unsigned int>::max()),
      m_numberOfSubDiagonals(std::numeric_limits<unsigned int>::max()),
      m_tempSpace()
{
    m_data = Array<OneD, DataType>(GetRequiredStorageSize());
}

◆ NekMatrix() [2/9]

template<typename DataType >

Nektar::NekMatrix< DataType, StandardMatrixTag >::NekMatrix	(	unsigned int	rows,
		unsigned int	columns,
		MatrixStorage	policy = `eFULL`,
		unsigned int	subDiagonals = `std::numeric_limits<unsigned int>::max()`,
		unsigned int	superDiagonals = `std::numeric_limits<unsigned int>::max()`
	)

Creates a rows by columns matrix.

rows The number of rows in the matrix.

columns The number of columns in the matrix.

Definition at line 51 of file StandardMatrix.cpp.

    : Matrix<DataType>(rows, columns, policy), m_data(), m_wrapperType(eCopy),
      m_numberOfSuperDiagonals(superDiagonals),
      m_numberOfSubDiagonals(subDiagonals), m_tempSpace()
{
    m_data = Array<OneD, DataType>(GetRequiredStorageSize());
}

◆ NekMatrix() [3/9]

template<typename DataType >

Nektar::NekMatrix< DataType, StandardMatrixTag >::NekMatrix	(	unsigned int	rows,
		unsigned int	columns,
		MatrixStorage	policy,
		unsigned int	subDiagonals,
		unsigned int	superDiagonals,
		unsigned int	capacity
	)

Definition at line 64 of file StandardMatrix.cpp.

    : Matrix<DataType>(rows, columns, policy), m_data(), m_wrapperType(eCopy),
      m_numberOfSuperDiagonals(superDiagonals),
      m_numberOfSubDiagonals(subDiagonals), m_tempSpace()
{
    unsigned int requiredStorage = this->GetRequiredStorageSize();
    unsigned int actualSize      = std::max(requiredStorage, capacity);
    m_data                       = Array<OneD, DataType>(actualSize);
}

◆ NekMatrix() [4/9]

template<typename DataType >

Nektar::NekMatrix< DataType, StandardMatrixTag >::NekMatrix	(	unsigned int	rows,
		unsigned int	columns,
		typename boost::call_traits< DataType >::const_reference	initValue,
		MatrixStorage	policy = `eFULL`,
		unsigned int	subDiagonals = `std::numeric_limits<unsigned int>::max()`,
		unsigned int	superDiagonals = `std::numeric_limits<unsigned int>::max()`
	)

Creates a rows by columns matrix.

rows The number of rows in the matrix.

columns The number of columns in the matrix.

initValue The value used to initialize each element.

policySpecificData Data the is specific to the storage type assigned to this matrix. Check MatrixStoragePolicy<StorageType> to see if the StoragePolicy for this matrix has policy specific data.

Definition at line 80 of file StandardMatrix.cpp.

    : Matrix<DataType>(rows, columns, policy), m_data(), m_wrapperType(eCopy),
      m_numberOfSuperDiagonals(superDiagonals),
      m_numberOfSubDiagonals(subDiagonals), m_tempSpace()
{
    m_data = Array<OneD, DataType>(GetRequiredStorageSize());
    std::fill(m_data.begin(), m_data.end(), initValue);
}

◆ NekMatrix() [5/9]

template<typename DataType >

Nektar::NekMatrix< DataType, StandardMatrixTag >::NekMatrix	(	unsigned int	rows,
		unsigned int	columns,
		const DataType *	data,
		MatrixStorage	policy = `eFULL`,
		unsigned int	subDiagonals = `std::numeric_limits<unsigned int>::max()`,
		unsigned int	superDiagonals = `std::numeric_limits<unsigned int>::max()`
	)

Creates a rows by columns matrix.

rows The number of rows in the matrix.

columns The number of columns in the matrix.

data An array of data use to initialize the matrix.

policySpecificData Data the is specific to the storage type assigned to this matrix. Check MatrixStoragePolicy<StorageType> to see if the StoragePolicy for this matrix has policy specific data.

Definition at line 94 of file StandardMatrix.cpp.

    : Matrix<DataType>(rows, columns, policy), m_data(), m_wrapperType(eCopy),
      m_numberOfSuperDiagonals(superDiagonals),
      m_numberOfSubDiagonals(subDiagonals), m_tempSpace()
{
    unsigned int size = GetRequiredStorageSize();
    m_data            = Array<OneD, DataType>(size);
    std::copy(data, data + size, m_data.begin());
}

References CellMLToNektar.pycml::copy().

◆ NekMatrix() [6/9]

template<typename DataType >

Nektar::NekMatrix< DataType, StandardMatrixTag >::NekMatrix	(	unsigned int	rows,
		unsigned int	columns,
		const Array< OneD, const DataType > &	d,
		MatrixStorage	policy = `eFULL`,
		unsigned int	subDiagonals = `std::numeric_limits<unsigned int>::max()`,
		unsigned int	superDiagonals = `std::numeric_limits<unsigned int>::max()`
	)

Creates a rows by columns matrix.

rows The number of rows in the matrix.

columns The number of columns in the matrix.

d An array of data used to initialize the matrix. Values from d are copied into the matrix. policySpecificData Data the is specific to the storage type assigned to this matrix. Check MatrixStoragePolicy<StorageType> to see if the StoragePolicy for this matrix has policy specific data.

Definition at line 110 of file StandardMatrix.cpp.

    : Matrix<DataType>(rows, columns, policy), m_data(), m_wrapperType(eCopy),
      m_numberOfSuperDiagonals(superDiagonals),
      m_numberOfSubDiagonals(subDiagonals), m_tempSpace()
{
    m_data = Array<OneD, DataType>(GetRequiredStorageSize());
    CopyArrayN(d, m_data, m_data.size());
}

References Nektar::CopyArrayN(), and Nektar::UnitTests::d().

◆ NekMatrix() [7/9]

template<typename DataType >

Nektar::NekMatrix< DataType, StandardMatrixTag >::NekMatrix	(	unsigned int	rows,
		unsigned int	columns,
		const Array< OneD, DataType > &	d,
		PointerWrapper	wrapperType = `eCopy`,
		MatrixStorage	policy = `eFULL`,
		unsigned int	subDiagonals = `std::numeric_limits<unsigned int>::max()`,
		unsigned int	superDiagonals = `std::numeric_limits<unsigned int>::max()`
	)

Creates a rows by columns matrix.

rows The number of rows in the matrix.

columns The number of columns in the matrix.

d An array of data used to initialize the matrix. If wrapperType is eCopy, then each element is copied from d to the matrix. If wrapperType is eWrapper, then the matrix uses d directly as its matrix data and no copies are made.

policySpecificData Data the is specific to the storage type assigned to this matrix. Check MatrixStoragePolicy<StorageType> to see if the StoragePolicy for this matrix has policy specific data.

Definition at line 123 of file StandardMatrix.cpp.

    : Matrix<DataType>(rows, columns, policy), m_data(),
      m_wrapperType(wrapperType), m_numberOfSuperDiagonals(superDiagonals),
      m_numberOfSubDiagonals(subDiagonals), m_tempSpace()
{
    if (wrapperType == eWrapper)
    {
        m_data = Array<OneD, DataType>(d, eVECTOR_WRAPPER);
    }
    else
    {
        m_data = Array<OneD, DataType>(GetRequiredStorageSize());
        CopyArrayN(d, m_data, m_data.size());
    }
}

References Nektar::CopyArrayN(), Nektar::UnitTests::d(), Nektar::eVECTOR_WRAPPER, and Nektar::eWrapper.

◆ NekMatrix() [8/9]

template<typename DataType >

Nektar::NekMatrix< DataType, StandardMatrixTag >::NekMatrix ( const ThisType & rhs )

Definition at line 143 of file StandardMatrix.cpp.

    : Matrix<DataType>(rhs), m_data(), m_wrapperType(rhs.m_wrapperType),
      m_numberOfSuperDiagonals(rhs.m_numberOfSuperDiagonals),
      m_numberOfSubDiagonals(rhs.m_numberOfSubDiagonals), m_tempSpace()
{
    PerformCopyConstruction(rhs);
}

◆ NekMatrix() [9/9]

template<typename DataType >

Nektar::NekMatrix< DataType, StandardMatrixTag >::NekMatrix	(	const ThisType &	rhs,
		PointerWrapper	wrapperType
	)

protected

Definition at line 499 of file StandardMatrix.cpp.

    : BaseType(rhs), m_data(), m_wrapperType(wrapperType),
      m_numberOfSuperDiagonals(rhs.m_numberOfSuperDiagonals),
      m_numberOfSubDiagonals(rhs.m_numberOfSubDiagonals)
{
    PerformCopyConstruction(rhs);
}

Member Function Documentation

◆ AbsMaxtoMinEigenValueRatio()

template<typename DataType >

DataType Nektar::NekMatrix< DataType, StandardMatrixTag >::AbsMaxtoMinEigenValueRatio ( void )

Definition at line 743 of file StandardMatrix.cpp.

{
    DataType returnval;
    int nvals = this->GetColumns();
    Array<OneD, DataType> EigValReal(nvals);
    Array<OneD, DataType> EigValImag(nvals);
    Array<OneD, DataType> Evecs;
 
    EigenSolve(EigValReal, EigValImag, Evecs);
 
    Vmath::Vmul(nvals, EigValReal, 1, EigValReal, 1, EigValReal, 1);
    Vmath::Vmul(nvals, EigValImag, 1, EigValImag, 1, EigValImag, 1);
    Vmath::Vadd(nvals, EigValReal, 1, EigValImag, 1, EigValReal, 1);
 
    returnval = sqrt(Vmath::Vmax(nvals, EigValReal, 1) /
                     Vmath::Vmin(nvals, EigValReal, 1));
 
    return returnval;
}

References tinysimd::sqrt(), Vmath::Vadd(), Vmath::Vmax(), Vmath::Vmin(), and Vmath::Vmul().

◆ Advance() [1/2]

template<typename DataType >

std::tuple< unsigned int, unsigned int > Nektar::NekMatrix< DataType, StandardMatrixTag >::Advance	(	unsigned int	curRow,
		unsigned int	curColumn
	)		const

Definition at line 420 of file StandardMatrix.cpp.

{
    return Advance(curRow, curColumn, this->GetTransposeFlag());
}

◆ Advance() [2/2]

template<typename DataType >

std::tuple< unsigned int, unsigned int > Nektar::NekMatrix< DataType, StandardMatrixTag >::Advance	(	unsigned int	curRow,
		unsigned int	curColumn,
		char	transpose
	)		const

Definition at line 428 of file StandardMatrix.cpp.

{
    unsigned int numRows    = this->GetTransposedRows(transpose);
    unsigned int numColumns = this->GetTransposedColumns(transpose);
 
    switch (this->GetStorageType())
    {
        case eFULL:
            return FullMatrixFuncs::Advance(numRows, numColumns, curRow,
                                            curColumn);
            break;
        case eDIAGONAL:
            return DiagonalMatrixFuncs::Advance(numRows, numColumns, curRow,
                                                curColumn);
            break;
        case eUPPER_TRIANGULAR:
            return UpperTriangularMatrixFuncs::Advance(numRows, numColumns,
                                                       curRow, curColumn);
            break;
 
        case eLOWER_TRIANGULAR:
            return LowerTriangularMatrixFuncs::Advance(numRows, numColumns,
                                                       curRow, curColumn);
            break;
 
        case eSYMMETRIC:
        case ePOSITIVE_DEFINITE_SYMMETRIC:
            return SymmetricMatrixFuncs::Advance(numRows, numColumns, curRow,
                                                 curColumn);
            break;
        case eBANDED:
            return BandedMatrixFuncs::Advance(numRows, numColumns, curRow,
                                              curColumn);
            break;
        case eSYMMETRIC_BANDED:
        case ePOSITIVE_DEFINITE_SYMMETRIC_BANDED:
            NEKERROR(ErrorUtil::efatal, "Unhandled matrix type");
            break;
        case eUPPER_TRIANGULAR_BANDED:
            NEKERROR(ErrorUtil::efatal, "Unhandled matrix type");
            break;
        case eLOWER_TRIANGULAR_BANDED:
            NEKERROR(ErrorUtil::efatal, "Unhandled matrix type");
            break;
 
        default:
            NEKERROR(ErrorUtil::efatal, "Unhandled matrix type");
    }
    return std::tuple<unsigned int, unsigned int>(curRow, curColumn);
}

References Nektar::BandedMatrixFuncs::Advance(), Nektar::FullMatrixFuncs::Advance(), Nektar::UpperTriangularMatrixFuncs::Advance(), Nektar::SymmetricMatrixFuncs::Advance(), Nektar::DiagonalMatrixFuncs::Advance(), Nektar::LowerTriangularMatrixFuncs::Advance(), Nektar::eBANDED, Nektar::eDIAGONAL, Nektar::ErrorUtil::efatal, Nektar::eFULL, Nektar::eLOWER_TRIANGULAR, Nektar::eLOWER_TRIANGULAR_BANDED, Nektar::ePOSITIVE_DEFINITE_SYMMETRIC, Nektar::ePOSITIVE_DEFINITE_SYMMETRIC_BANDED, Nektar::eSYMMETRIC, Nektar::eSYMMETRIC_BANDED, Nektar::eUPPER_TRIANGULAR, Nektar::eUPPER_TRIANGULAR_BANDED, and NEKERROR.

◆ begin() [1/4]

template<typename DataType >

NekMatrix< DataType, StandardMatrixTag >::iterator Nektar::NekMatrix< DataType, StandardMatrixTag >::begin

Definition at line 700 of file StandardMatrix.cpp.

{
    return begin(this->GetTransposeFlag());
}

Referenced by operator==().

◆ begin() [2/4]

template<typename DataType >

NekMatrix< DataType, StandardMatrixTag >::const_iterator Nektar::NekMatrix< DataType, StandardMatrixTag >::begin

Definition at line 291 of file StandardMatrix.cpp.

{
    return begin(this->GetTransposeFlag());
}

◆ begin() [3/4]

template<typename DataType >

NekMatrix< DataType, StandardMatrixTag >::iterator Nektar::NekMatrix< DataType, StandardMatrixTag >::begin ( char transpose )

Definition at line 707 of file StandardMatrix.cpp.

{
    if (transpose == 'N')
    {
        return iterator(this->GetData().data(),
                        this->GetData().data() + this->GetData().size());
    }
    else
    {
        return iterator(this, transpose);
    }
}

◆ begin() [4/4]

template<typename DataType >

NekMatrix< DataType, StandardMatrixTag >::const_iterator Nektar::NekMatrix< DataType, StandardMatrixTag >::begin ( char transpose ) const

Definition at line 298 of file StandardMatrix.cpp.

{
    if (transpose == 'N')
    {
        return const_iterator(m_data.data(), m_data.data() + m_data.size());
    }
    else
    {
        return const_iterator(this, transpose);
    }
}

◆ CalculateIndex()

template<typename DataType >

unsigned int Nektar::NekMatrix< DataType, StandardMatrixTag >::CalculateIndex	(	unsigned int	row,
		unsigned int	col,
		const char	transpose
	)		const

Definition at line 225 of file StandardMatrix.cpp.

{
    unsigned int numRows    = this->GetSize()[0];
    unsigned int numColumns = this->GetSize()[1];
    return Matrix<DataType>::CalculateIndex(
        this->GetStorageType(), row, col, numRows, numColumns, transpose,
        m_numberOfSubDiagonals, m_numberOfSuperDiagonals);
}

References Nektar::ConstMatrix< DataType >::CalculateIndex().

◆ CalculateNumberOfRows()

template<typename DataType >

unsigned int Nektar::NekMatrix< DataType, StandardMatrixTag >::CalculateNumberOfRows

Definition at line 375 of file StandardMatrix.cpp.

{
    return GetNumberOfSubDiagonals() + GetNumberOfSuperDiagonals() + 1;
}

◆ CreateWrapper() [1/2]

template<typename DataType >

std::shared_ptr< NekMatrix< DataType, StandardMatrixTag > > Nektar::NekMatrix< DataType, StandardMatrixTag >::CreateWrapper ( const std::shared_ptr< ThisType > & rhs )

static

Definition at line 490 of file StandardMatrix.cpp.

{
    return std::shared_ptr<NekMatrix<DataType, StandardMatrixTag>>(
        new NekMatrix<DataType, StandardMatrixTag>(*rhs, eWrapper));
}

References Nektar::eWrapper.

◆ CreateWrapper() [2/2]

template<typename DataType >

NekMatrix< DataType, StandardMatrixTag > Nektar::NekMatrix< DataType, StandardMatrixTag >::CreateWrapper ( const ThisType & rhs )

static

Definition at line 482 of file StandardMatrix.cpp.

{
    return NekMatrix<DataType, StandardMatrixTag>(rhs, eWrapper);
}

References Nektar::eWrapper.

◆ EigenSolve()

template<typename DataType >

void Nektar::NekMatrix< DataType, StandardMatrixTag >::EigenSolve	(	Array< OneD, DataType > &	EigValReal,
		Array< OneD, DataType > &	EigValImag,
		Array< OneD, DataType > &	EigVecs
	)

Definition at line 765 of file StandardMatrix.cpp.

{
    ASSERTL0(this->GetRows() == this->GetColumns(),
             "Only square matrices can be called");
 
    switch (this->GetType())
    {
        case eFULL:
            FullMatrixFuncs::EigenSolve(this->GetRows(), this->GetData(),
                                        EigValReal, EigValImag, EigVecs);
            break;
        case eDIAGONAL:
            Vmath::Vcopy(this->GetRows(), &(this->GetData())[0], 1,
                         &EigValReal[0], 1);
            Vmath::Zero(this->GetRows(), &EigValImag[0], 1);
            break;
        case eUPPER_TRIANGULAR:
        case eLOWER_TRIANGULAR:
        case eSYMMETRIC:
        case eBANDED:
        case eSYMMETRIC_BANDED:
        case eUPPER_TRIANGULAR_BANDED:
        case eLOWER_TRIANGULAR_BANDED:
            NEKERROR(ErrorUtil::efatal, "Unhandled matrix type");
            break;
 
        default:
            NEKERROR(ErrorUtil::efatal, "Unhandled matrix type");
    }
}

References ASSERTL0, Nektar::eBANDED, Nektar::eDIAGONAL, Nektar::ErrorUtil::efatal, Nektar::eFULL, Nektar::FullMatrixFuncs::EigenSolve(), Nektar::eLOWER_TRIANGULAR, Nektar::eLOWER_TRIANGULAR_BANDED, Nektar::eSYMMETRIC, Nektar::eSYMMETRIC_BANDED, Nektar::eUPPER_TRIANGULAR, Nektar::eUPPER_TRIANGULAR_BANDED, NEKERROR, Vmath::Vcopy(), and Vmath::Zero().

◆ end() [1/4]

template<typename DataType >

NekMatrix< DataType, StandardMatrixTag >::iterator Nektar::NekMatrix< DataType, StandardMatrixTag >::end

Definition at line 722 of file StandardMatrix.cpp.

{
    return end(this->GetTransposeFlag());
}

◆ end() [2/4]

template<typename DataType >

NekMatrix< DataType, StandardMatrixTag >::const_iterator Nektar::NekMatrix< DataType, StandardMatrixTag >::end

Definition at line 312 of file StandardMatrix.cpp.

{
    return end(this->GetTransposeFlag());
}

◆ end() [3/4]

template<typename DataType >

NekMatrix< DataType, StandardMatrixTag >::iterator Nektar::NekMatrix< DataType, StandardMatrixTag >::end ( char transpose )

Definition at line 729 of file StandardMatrix.cpp.

{
    if (transpose == 'N')
    {
        return iterator(this->GetData().data(),
                        this->GetData().data() + this->GetData().size(), true);
    }
    else
    {
        return iterator(this, transpose, true);
    }
}

◆ end() [4/4]

template<typename DataType >

NekMatrix< DataType, StandardMatrixTag >::const_iterator Nektar::NekMatrix< DataType, StandardMatrixTag >::end ( char transpose ) const

Definition at line 319 of file StandardMatrix.cpp.

{
    if (transpose == 'N')
    {
        return const_iterator(m_data.data(), m_data.data() + m_data.size(),
                              true);
    }
    else
    {
        return const_iterator(this, transpose, true);
    }
}

◆ GetData()

template<typename DataType >

Array< OneD, DataType > & Nektar::NekMatrix< DataType, StandardMatrixTag >::GetData

protected

Definition at line 510 of file StandardMatrix.cpp.

{
    return m_data;
}

◆ GetNumberOfSubDiagonals()

template<typename DataType >

unsigned int Nektar::NekMatrix< DataType, StandardMatrixTag >::GetNumberOfSubDiagonals

Definition at line 339 of file StandardMatrix.cpp.

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

Referenced by Nektar::Transpose().

◆ GetNumberOfSuperDiagonals()

template<typename DataType >

unsigned int Nektar::NekMatrix< DataType, StandardMatrixTag >::GetNumberOfSuperDiagonals

Definition at line 357 of file StandardMatrix.cpp.

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

Referenced by Nektar::Transpose().

◆ GetPtr() [1/2]

template<typename DataType >

Array< OneD, DataType > & Nektar::NekMatrix< DataType, StandardMatrixTag >::GetPtr

Definition at line 687 of file StandardMatrix.cpp.

{
    return this->GetData();
}

◆ GetPtr() [2/2]

template<typename DataType >

const Array< OneD, const DataType > & Nektar::NekMatrix< DataType, StandardMatrixTag >::GetPtr

Definition at line 272 of file StandardMatrix.cpp.

{
    return m_data;
}

Referenced by Nektar::Transpose().

◆ GetRawPtr() [1/2]

template<typename DataType >

DataType * Nektar::NekMatrix< DataType, StandardMatrixTag >::GetRawPtr

Definition at line 693 of file StandardMatrix.cpp.

{
    return this->GetData().data();
}

◆ GetRawPtr() [2/2]

template<typename DataType >

const DataType * Nektar::NekMatrix< DataType, StandardMatrixTag >::GetRawPtr

Definition at line 284 of file StandardMatrix.cpp.

{
    return m_data.data();
}

Referenced by Nektar::NekMultiplyLowerTriangularMatrix(), and Nektar::NekMultiplyUpperTriangularMatrix().

◆ GetRequiredStorageSize()

template<typename DataType >

unsigned int Nektar::NekMatrix< DataType, StandardMatrixTag >::GetRequiredStorageSize

Definition at line 216 of file StandardMatrix.cpp.

{
    return Matrix<DataType>::GetRequiredStorageSize(
        this->GetStorageType(), this->GetRows(), this->GetColumns(),
        this->GetNumberOfSubDiagonals(), this->GetNumberOfSuperDiagonals());
}

References Nektar::ConstMatrix< DataType >::GetRequiredStorageSize().

◆ GetStorageSize()

template<typename DataType >

unsigned int Nektar::NekMatrix< DataType, StandardMatrixTag >::GetStorageSize

Definition at line 333 of file StandardMatrix.cpp.

{
    return m_data.size();
}

◆ GetTempSpace()

template<typename DataType >

Array< OneD, DataType > & Nektar::NekMatrix< DataType, StandardMatrixTag >::GetTempSpace

Definition at line 841 of file StandardMatrix.cpp.

{
    if (m_tempSpace.capacity() == 0)
    {
        m_tempSpace = Array<OneD, DataType>(this->GetData().capacity());
    }
    return m_tempSpace;
}

◆ GetValue() [1/2]

template<typename DataType >

boost::call_traits< DataType >::const_reference Nektar::NekMatrix< DataType, StandardMatrixTag >::GetValue	(	unsigned int	row,
		unsigned int	column
	)		const

Returns the element value at the given row and column.

Definition at line 237 of file StandardMatrix.cpp.

{
    ASSERTL2(row < this->GetRows(),
             std::string("Row ") + std::to_string(row) +
                 std::string(" requested in a matrix with a maximum of ") +
                 std::to_string(this->GetRows()) + std::string(" rows"));
    ASSERTL2(column < this->GetColumns(),
             std::string("Column ") + std::to_string(column) +
                 std::string(" requested in a matrix with a maximum of ") +
                 std::to_string(this->GetColumns()) + std::string(" columns"));
 
    return GetValue(row, column, this->GetTransposeFlag());
}

References ASSERTL2.

◆ GetValue() [2/2]

template<typename DataType >

NekMatrix< DataType, StandardMatrixTag >::ConstGetValueType Nektar::NekMatrix< DataType, StandardMatrixTag >::GetValue	(	unsigned int	row,
		unsigned int	column,
		char	transpose
	)		const

Returns the element value at the given row and column.

row The element's row.

column The element's column.

transpose If transpose = 'N', then the return value is element [row, column]. If transpose = 'T', then the return value is element [column, row].

Definition at line 254 of file StandardMatrix.cpp.

{
    static DataType defaultReturnValue;
    unsigned int index = CalculateIndex(row, column, transpose);
    if (index != std::numeric_limits<unsigned int>::max())
    {
        return m_data[index];
    }
    else
    {
        return defaultReturnValue;
    }
}

◆ GetWrapperType()

template<typename DataType >

PointerWrapper Nektar::NekMatrix< DataType, StandardMatrixTag >::GetWrapperType

Definition at line 413 of file StandardMatrix.cpp.

{
    return m_wrapperType;
}

◆ Invert()

template<typename DataType >

void Nektar::NekMatrix< DataType, StandardMatrixTag >::Invert

Definition at line 799 of file StandardMatrix.cpp.

{
    ASSERTL0(this->GetRows() == this->GetColumns(),
             "Only square matrices can be inverted.");
    ASSERTL0(this->GetTransposeFlag() == 'N',
             "Only untransposed matrices may be inverted.");
 
    switch (this->GetType())
    {
        case eFULL:
            FullMatrixFuncs::Invert(this->GetRows(), this->GetColumns(),
                                    this->GetData(), this->GetTransposeFlag());
            break;
        case eDIAGONAL:
            DiagonalMatrixFuncs::Invert(this->GetRows(), this->GetColumns(),
                                        this->GetData());
            break;
        case eSYMMETRIC:
            SymmetricMatrixFuncs::Invert(this->GetRows(), this->GetColumns(),
                                         this->GetData());
            break;
        case eUPPER_TRIANGULAR:
        case eLOWER_TRIANGULAR:
        case eBANDED:
            NEKERROR(ErrorUtil::efatal, "Unhandled matrix type");
            break;
        case eSYMMETRIC_BANDED:
            NEKERROR(ErrorUtil::efatal, "Unhandled matrix type");
            break;
        case eUPPER_TRIANGULAR_BANDED:
            NEKERROR(ErrorUtil::efatal, "Unhandled matrix type");
            break;
        case eLOWER_TRIANGULAR_BANDED:
            NEKERROR(ErrorUtil::efatal, "Unhandled matrix type");
            break;
 
        default:
            NEKERROR(ErrorUtil::efatal, "Unhandled matrix type");
    }
}

References ASSERTL0, Nektar::eBANDED, Nektar::eDIAGONAL, Nektar::ErrorUtil::efatal, Nektar::eFULL, Nektar::eLOWER_TRIANGULAR, Nektar::eLOWER_TRIANGULAR_BANDED, Nektar::eSYMMETRIC, Nektar::eSYMMETRIC_BANDED, Nektar::eUPPER_TRIANGULAR, Nektar::eUPPER_TRIANGULAR_BANDED, Nektar::SymmetricMatrixFuncs::Invert(), Nektar::DiagonalMatrixFuncs::Invert(), Nektar::FullMatrixFuncs::Invert(), and NEKERROR.

◆ operator()() [1/4]

template<typename DataType >

NekMatrix< DataType, StandardMatrixTag >::Proxy Nektar::NekMatrix< DataType, StandardMatrixTag >::operator()	(	unsigned int	row,
		unsigned int	column
	)

Definition at line 620 of file StandardMatrix.cpp.

{
    ASSERTL2(row < this->GetRows(),
             std::string("Row ") + std::to_string(row) +
                 std::string(" requested in a matrix with a maximum of ") +
                 std::to_string(this->GetRows()) + std::string(" rows"));
    ASSERTL2(column < this->GetColumns(),
             std::string("Column ") + std::to_string(column) +
                 std::string(" requested in a matrix with a maximum of ") +
                 std::to_string(this->GetColumns()) + std::string(" columns"));
 
    return (*this)(row, column, this->GetTransposeFlag());
}

References ASSERTL2.

◆ operator()() [2/4]

template<typename DataType >

NekMatrix< DataType, StandardMatrixTag >::ConstGetValueType Nektar::NekMatrix< DataType, StandardMatrixTag >::operator()	(	unsigned int	row,
		unsigned int	column
	)		const

Returns the element value at the given row and column.

Definition at line 191 of file StandardMatrix.cpp.

{
    ASSERTL2(row < this->GetRows(),
             std::string("Row ") + std::to_string(row) +
                 std::string(" requested in a matrix with a maximum of ") +
                 std::to_string(this->GetRows()) + std::string(" rows"));
    ASSERTL2(column < this->GetColumns(),
             std::string("Column ") + std::to_string(column) +
                 std::string(" requested in a matrix with a maximum of ") +
                 std::to_string(this->GetColumns()) + std::string(" columns"));
 
    return this->GetValue(row, column, this->GetTransposeFlag());
}

References ASSERTL2.

◆ operator()() [3/4]

template<typename DataType >

NekMatrix< DataType, StandardMatrixTag >::Proxy Nektar::NekMatrix< DataType, StandardMatrixTag >::operator()	(	unsigned int	row,
		unsigned int	column,
		char	transpose
	)

Definition at line 637 of file StandardMatrix.cpp.

{
    unsigned int index = this->CalculateIndex(row, column, transpose);
    if (index != std::numeric_limits<unsigned int>::max())
    {
        return Proxy(this->GetData()[index]);
    }
    else
    {
        return Proxy();
    }
}

◆ operator()() [4/4]

template<typename DataType >

NekMatrix< DataType, StandardMatrixTag >::ConstGetValueType Nektar::NekMatrix< DataType, StandardMatrixTag >::operator()	(	unsigned int	row,
		unsigned int	column,
		char	transpose
	)		const

Returns the element value at the given row and column.

row The element's row.

column The element's column.

transpose If transpose = 'N', then the return value is element [row, column]. If transpose = 'T', then the return value is element [column, row].

Definition at line 208 of file StandardMatrix.cpp.

{
    return this->GetValue(row, column, transpose);
}

◆ operator*=()

template<typename DataType >

NekMatrix< DataType, StandardMatrixTag > & Nektar::NekMatrix< DataType, StandardMatrixTag >::operator*= ( const NumberType & s )

Definition at line 867 of file StandardMatrix.cpp.

{
    for (unsigned int i = 0; i < this->GetPtr().size(); ++i)
    {
        this->GetPtr()[i] *= s;
    }
    return *this;
}

◆ operator-()

template<typename DataType >

NekMatrix< DataType, StandardMatrixTag > Nektar::NekMatrix< DataType, StandardMatrixTag >::operator-

Definition at line 858 of file StandardMatrix.cpp.

{
    NekMatrix<DataType, StandardMatrixTag> result(*this);
    NegateInPlace(result);
    return result;
}

References Nektar::NegateInPlace().

◆ operator=() [1/3]

template<typename DataType >

NekMatrix< DataType, StandardMatrixTag > & Nektar::NekMatrix< DataType, StandardMatrixTag >::operator= ( const DataType & rhs )

Fill matrix with scalar.

Definition at line 178 of file StandardMatrix.cpp.

{
    unsigned int requiredStorageSize = GetRequiredStorageSize();
 
    DataType *lhs_array = m_data.data();
 
    Vmath::Fill(requiredStorageSize, rhs, lhs_array, 1);
 
    return *this;
}

References Vmath::Fill().

◆ operator=() [2/3]

template<typename DataType >

template<typename InnerMatrixType >

ThisType & Nektar::NekMatrix< DataType, StandardMatrixTag >::operator= ( const NekMatrix< InnerMatrixType, ScaledMatrixTag > & rhs )

inline

Definition at line 312 of file StandardMatrix.hpp.

    {
        BaseType::operator       =(rhs);
        m_numberOfSubDiagonals   = rhs.GetNumberOfSubDiagonals();
        m_numberOfSuperDiagonals = rhs.GetNumberOfSuperDiagonals();
 
        ResizeDataArrayIfNeeded();
 
        unsigned int requiredStorageSize = GetRequiredStorageSize();
        DataType scale                   = rhs.Scale();
 
        DataType *lhs_array       = m_data.data();
        const DataType *rhs_array = rhs.GetRawPtr();
 
        for (unsigned int i = 0; i < requiredStorageSize; ++i)
        {
            lhs_array[i] = scale * rhs_array[i];
        }
 
        return *this;
    }

◆ operator=() [3/3]

template<typename DataType >

NekMatrix< DataType, StandardMatrixTag > & Nektar::NekMatrix< DataType, StandardMatrixTag >::operator= ( const ThisType & rhs )

Definition at line 154 of file StandardMatrix.cpp.

{
    if (this == &rhs)
    {
        return *this;
    }
 
    Matrix<DataType>::operator=(rhs);
    m_numberOfSubDiagonals    = rhs.m_numberOfSubDiagonals;
    m_numberOfSuperDiagonals  = rhs.m_numberOfSuperDiagonals;
 
    ResizeDataArrayIfNeeded();
 
    unsigned int requiredStorageSize = GetRequiredStorageSize();
    std::copy(rhs.m_data.data(), rhs.m_data.data() + requiredStorageSize,
              m_data.data());
 
    return *this;
}

References CellMLToNektar.pycml::copy(), Nektar::Array< OneD, DataType >::data(), m_data, m_numberOfSubDiagonals, m_numberOfSuperDiagonals, and Nektar::Matrix< DataType >::operator=().

◆ operator==()

template<typename DataType >

bool Nektar::NekMatrix< DataType, StandardMatrixTag >::operator== ( const NekMatrix< DataType, StandardMatrixTag > & rhs ) const

Returns true if the this matrix and rhs are equivalent.

Two matrices are equivalent if they have the same size and each element is the same.

Definition at line 382 of file StandardMatrix.cpp.

{
    if (this->GetRows() != rhs.GetRows() ||
        this->GetColumns() != rhs.GetColumns())
    {
        return false;
    }
 
    if (this->GetTransposeFlag() == rhs.GetTransposeFlag())
    {
        return std::equal(begin(), end(), rhs.begin());
    }
    else
    {
        for (unsigned int i = 0; i < this->GetRows(); ++i)
        {
            for (unsigned int j = 0; j < this->GetColumns(); ++j)
            {
                if ((*this)(i, j) != rhs(i, j))
                {
                    return false;
                }
            }
        }
    }
 
    return true;
}

References begin(), Nektar::ConstMatrix< DataType >::GetColumns(), Nektar::ConstMatrix< DataType >::GetRows(), and Nektar::ConstMatrix< DataType >::GetTransposeFlag().

◆ PerformCopyConstruction()

template<typename DataType >

void Nektar::NekMatrix< DataType, StandardMatrixTag >::PerformCopyConstruction ( const ThisType & rhs )

private

Definition at line 566 of file StandardMatrix.cpp.

{
    if (m_wrapperType == eWrapper)
    {
        m_data = rhs.m_data;
    }
    else
    {
        m_data = Array<OneD, DataType>(GetRequiredStorageSize());
        CopyArrayN(rhs.m_data, m_data, m_data.size());
    }
}

References Nektar::CopyArrayN(), Nektar::eWrapper, m_data, and Nektar::Array< OneD, const DataType >::size().

◆ RemoveExcessCapacity()

template<typename DataType >

void Nektar::NekMatrix< DataType, StandardMatrixTag >::RemoveExcessCapacity

protected

Definition at line 516 of file StandardMatrix.cpp.

{
    if (m_wrapperType == eCopy)
    {
        unsigned int requiredStorageSize = GetRequiredStorageSize();
        if (m_data.size() > requiredStorageSize)
        {
            Array<OneD, DataType> newArray(requiredStorageSize);
            CopyArrayN(m_data, newArray, requiredStorageSize);
            m_data = newArray;
        }
    }
    else if (m_wrapperType == eWrapper)
    {
        ASSERTL0(true, "Can't call RemoveExcessCapacity on a wrapped matrix.");
    }
}

References ASSERTL0, Nektar::CopyArrayN(), Nektar::eCopy, and Nektar::eWrapper.

◆ ResizeDataArrayIfNeeded() [1/2]

template<typename DataType >

void Nektar::NekMatrix< DataType, StandardMatrixTag >::ResizeDataArrayIfNeeded

protected

Definition at line 559 of file StandardMatrix.cpp.

{
    unsigned int requiredStorageSize = GetRequiredStorageSize();
    ResizeDataArrayIfNeeded(requiredStorageSize);
}

◆ ResizeDataArrayIfNeeded() [2/2]

template<typename DataType >

void Nektar::NekMatrix< DataType, StandardMatrixTag >::ResizeDataArrayIfNeeded ( unsigned int requiredStorageSize )

protected

Definition at line 535 of file StandardMatrix.cpp.

{
    if (m_wrapperType == eCopy)
    {
        if (m_data.size() < requiredStorageSize)
        {
            Array<OneD, DataType> newData(requiredStorageSize);
            std::copy(m_data.data(), m_data.data() + m_data.size(),
                      newData.data());
            m_data = newData;
        }
    }
    else if (m_wrapperType == eWrapper)
    {
        // If the current matrix is wrapped, then just copy over the top,
        // but the sizes of the two matrices must be the same.
        ASSERTL0(
            m_data.size() >= requiredStorageSize,
            "Wrapped NekMatrices must have the same dimension in operator=");
    }
}

References ASSERTL0, CellMLToNektar.pycml::copy(), Nektar::Array< OneD, DataType >::data(), Nektar::eCopy, and Nektar::eWrapper.

◆ Scale()

template<typename DataType >

DataType Nektar::NekMatrix< DataType, StandardMatrixTag >::Scale

Returns the scaling used by this matrix.

Since this matrix is not a scaled matrix, this method always returns 1.

Definition at line 278 of file StandardMatrix.cpp.

{
    return DataType(1);
}

◆ SetSize()

template<typename DataType >

void Nektar::NekMatrix< DataType, StandardMatrixTag >::SetSize	(	unsigned int	rows,
		unsigned int	cols
	)

Definition at line 603 of file StandardMatrix.cpp.

{
    this->Resize(rows, cols);
 
    // Some places in Nektar++ access the matrix data array and
    // use size() to see how big it is.  When using
    // expression templates, the data array's capacity is often larger
    // than the actual number of elements, so this statement is
    // required to report the correct number of elements.
    this->GetData().ChangeSize(this->GetRequiredStorageSize());
    ASSERTL0(this->GetRequiredStorageSize() <= this->GetData().size(),
             "Can't resize matrices if there is not enough capacity.");
}

References ASSERTL0.

Referenced by Nektar::Multiply().

◆ SetValue() [1/2]

template<typename DataType >

void Nektar::NekMatrix< DataType, StandardMatrixTag >::SetValue	(	unsigned int	row,
		unsigned int	column,
		typename boost::call_traits< DataType >::const_reference	d
	)

Definition at line 653 of file StandardMatrix.cpp.

{
    ASSERTL2(row < this->GetRows(),
             std::string("Row ") + std::to_string(row) +
                 std::string(" requested in a matrix with a maximum of ") +
                 std::to_string(this->GetRows()) + std::string(" rows"));
    ASSERTL2(column < this->GetColumns(),
             std::string("Column ") + std::to_string(column) +
                 std::string(" requested in a matrix with a maximum of ") +
                 std::to_string(this->GetColumns()) + std::string(" columns"));
    SetValue(row, column, d, this->GetTransposeFlag());
}

References ASSERTL2, and Nektar::UnitTests::d().

◆ SetValue() [2/2]

template<typename DataType >

void Nektar::NekMatrix< DataType, StandardMatrixTag >::SetValue	(	unsigned int	row,
		unsigned int	column,
		typename boost::call_traits< DataType >::const_reference	d,
		char	transpose
	)

Definition at line 669 of file StandardMatrix.cpp.

{
    unsigned int index = this->CalculateIndex(row, column, transpose);
    if (index != std::numeric_limits<unsigned int>::max())
    {
        this->GetData()[index] = d;
    }
    else
    {
        NEKERROR(
            ErrorUtil::efatal,
            "Can't assign values into zeroed elements of a special array.");
    }
}

References Nektar::UnitTests::d(), Nektar::ErrorUtil::efatal, and NEKERROR.

◆ SwapTempAndDataBuffers()

template<typename DataType >

void Nektar::NekMatrix< DataType, StandardMatrixTag >::SwapTempAndDataBuffers

Definition at line 851 of file StandardMatrix.cpp.

{
    std::swap(m_tempSpace, this->GetData());
}

◆ v_GetStorageSize()

template<typename DataType >

unsigned int Nektar::NekMatrix< DataType, StandardMatrixTag >::v_GetStorageSize

overrideprotectedvirtual

Implements Nektar::ConstMatrix< DataType >.

Definition at line 589 of file StandardMatrix.cpp.

{
    return NekMatrix<DataType, StandardMatrixTag>::GetStorageSize();
}

◆ v_GetValue()

template<typename DataType >

boost::call_traits< DataType >::value_type Nektar::NekMatrix< DataType, StandardMatrixTag >::v_GetValue	(	unsigned int	row,
		unsigned int	column
	)		const

overrideprotectedvirtual

Implements Nektar::ConstMatrix< DataType >.

Definition at line 582 of file StandardMatrix.cpp.

{
    return NekMatrix<DataType, StandardMatrixTag>::operator()(row, column);
}

◆ v_SetValue()

template<typename DataType >

void Nektar::NekMatrix< DataType, StandardMatrixTag >::v_SetValue	(	unsigned int	row,
		unsigned int	column,
		typename boost::call_traits< DataType >::const_reference	d
	)

overrideprotectedvirtual

Implements Nektar::Matrix< DataType >.

Definition at line 595 of file StandardMatrix.cpp.

{
    return NekMatrix<DataType, StandardMatrixTag>::SetValue(row, column, d);
}

References Nektar::UnitTests::d().

Member Data Documentation

◆ m_data

template<typename DataType >

Array<OneD, DataType> Nektar::NekMatrix< DataType, StandardMatrixTag >::m_data

private

Definition at line 540 of file StandardMatrix.hpp.

Referenced by operator=(), and PerformCopyConstruction().

◆ m_numberOfSubDiagonals

template<typename DataType >

unsigned int Nektar::NekMatrix< DataType, StandardMatrixTag >::m_numberOfSubDiagonals

private

Definition at line 545 of file StandardMatrix.hpp.

Referenced by operator=().

◆ m_numberOfSuperDiagonals

template<typename DataType >

unsigned int Nektar::NekMatrix< DataType, StandardMatrixTag >::m_numberOfSuperDiagonals

private

Definition at line 544 of file StandardMatrix.hpp.

Referenced by operator=().

◆ m_tempSpace

template<typename DataType >

Array<OneD, DataType> Nektar::NekMatrix< DataType, StandardMatrixTag >::m_tempSpace

private

Definition at line 548 of file StandardMatrix.hpp.

◆ m_wrapperType

template<typename DataType >

PointerWrapper Nektar::NekMatrix< DataType, StandardMatrixTag >::m_wrapperType

private

Definition at line 541 of file StandardMatrix.hpp.

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ BaseType

◆ const_iterator

◆ ConstGetValueType

◆ GetValueType

◆ iterator

◆ NumberType

◆ ThisType

Constructor & Destructor Documentation

◆ NekMatrix() [1/9]

◆ NekMatrix() [2/9]

◆ NekMatrix() [3/9]

◆ NekMatrix() [4/9]

◆ NekMatrix() [5/9]

◆ NekMatrix() [6/9]

◆ NekMatrix() [7/9]

◆ NekMatrix() [8/9]

◆ NekMatrix() [9/9]

Member Function Documentation

◆ AbsMaxtoMinEigenValueRatio()

◆ Advance() [1/2]

◆ Advance() [2/2]

◆ begin() [1/4]

◆ begin() [2/4]

◆ begin() [3/4]

◆ begin() [4/4]

◆ CalculateIndex()

◆ CalculateNumberOfRows()

◆ CreateWrapper() [1/2]

◆ CreateWrapper() [2/2]

◆ EigenSolve()

◆ end() [1/4]

◆ end() [2/4]

◆ end() [3/4]

◆ end() [4/4]

◆ GetData()

◆ GetNumberOfSubDiagonals()

◆ GetNumberOfSuperDiagonals()

◆ GetPtr() [1/2]

◆ GetPtr() [2/2]

◆ GetRawPtr() [1/2]

◆ GetRawPtr() [2/2]

◆ GetRequiredStorageSize()

◆ GetStorageSize()

◆ GetTempSpace()

◆ GetValue() [1/2]

◆ GetValue() [2/2]

◆ GetWrapperType()

◆ Invert()

◆ operator()() [1/4]

◆ operator()() [2/4]

◆ operator()() [3/4]

◆ operator()() [4/4]

◆ operator*=()

◆ operator-()

◆ operator=() [1/3]

◆ operator=() [2/3]

◆ operator=() [3/3]

◆ operator==()

◆ PerformCopyConstruction()

◆ RemoveExcessCapacity()

◆ ResizeDataArrayIfNeeded() [1/2]

◆ ResizeDataArrayIfNeeded() [2/2]

◆ Scale()

◆ SetSize()

◆ SetValue() [1/2]

◆ SetValue() [2/2]

◆ SwapTempAndDataBuffers()

◆ v_GetStorageSize()

◆ v_GetValue()

◆ v_SetValue()

Member Data Documentation