An concrete class for dealing with dense serial matrices. More...

#include <DenseSerialMatrixData.h>

Inheritance diagram for AMP::LinearAlgebra::DenseSerialMatrixData:

[legend]

Public Member Functions
template<class TYPE >
void	addValuesByGlobalID (size_t num_rows, size_t num_cols, const size_t rows, const size_t cols, const TYPE *values)
	Add values to those in the matrix.

void	addValuesByGlobalID (size_t num_rows, size_t num_cols, const size_t rows, const size_t cols, const void *values, const typeID &id) override
	Add values to those in the matrix.

virtual size_t	beginCol () const
	Get the global id of first column in diagonal block.

virtual size_t	beginRow () const
	Get the global id of the beginning row.

std::shared_ptr< MatrixData >	cloneMatrixData () const override
	Return a matrix with the same non-zero and distributed structure.

	DenseSerialMatrixData ()=delete

	DenseSerialMatrixData (const DenseSerialMatrixData &)=delete

	DenseSerialMatrixData (std::shared_ptr< MatrixParametersBase > params)
	Constructor.

virtual size_t	endCol () const
	Get the global id of last column in diagonal block.

virtual size_t	endRow () const
	Get the global id of the ending row.

virtual AMP::Utilities::Backend	getBackend () const
	Get the backend.

typeID	getCoeffType () const override
	Return the typeid of the matrix coeffs.

std::vector< size_t >	getColumnIDs (size_t row) const override
	Given a row, retrieve the non-zero column indices of the matrix in compressed format.

virtual AMP_MPI	getComm () const
	Get the comm.

uint64_t	getID () const
	Get a unique id hash for the vector.

std::shared_ptr< Discretization::DOFManager >	getLeftDOFManager () const override
	Get the DOFManager associated with a left vector( For \(\mathbf{y}^T\mathbf{Ax}\), \(\mathbf{y}\) is a left vector )

virtual std::shared_ptr< Variable >	getLeftVariable () const
	Get the variable associated with a left vector ( For \(\mathbf{y}^T\mathbf{Ax}\), \(\mathbf{y}\) is a left vector )

std::shared_ptr< Discretization::DOFManager >	getRightDOFManager () const override
	Get the DOFManager associated with a right vector( For \(\mathbf{y}^T\mathbf{Ax}\), \(\mathbf{x}\) is a right vector )

virtual std::shared_ptr< Variable >	getRightVariable () const
	Get the variable associated with a right vector ( For \(\mathbf{y}^T\mathbf{Ax}\), \(\mathbf{x}\) is a right vector )

void	getRowByGlobalID (size_t row, std::vector< size_t > &cols, std::vector< double > &values) const override
	Retrieve a row of the matrix in compressed format.

template<class TYPE >
void	getValuesByGlobalID (size_t num_rows, size_t num_cols, const size_t rows, const size_t cols, TYPE *values) const
	Get values in the matrix.

void	getValuesByGlobalID (size_t num_rows, size_t num_cols, const size_t rows, const size_t cols, void *values, const typeID &id) const override
	Get values in the matrix.

void	makeConsistent (AMP::LinearAlgebra::ScatterType) override
	Perform communication to ensure values in the matrix are the same across cores.

virtual std::uint16_t	mode () const
	Return CSR mode of the matrix.

size_t	numberColumnIDs (size_t row) const override
	Given a row, retrieve the number of non-zero column indices of the matrix.

size_t	numGlobalColumns () const override
	Get the number of global columns in the matrix.

size_t	numGlobalRows () const override
	Get the number of global rows in the matrix.

size_t	numLocalColumns () const override
	Get the number of local columns in the matrix.

size_t	numLocalRows () const override
	Get the number of local rows in the matrix.

DenseSerialMatrixData &	operator= (const DenseSerialMatrixData &)=delete

virtual void	registerChildObjects (AMP::IO::RestartManager *manager) const
	Register any child objects.

void	removeRange (AMP::Scalar, AMP::Scalar) override
	Remove matrix entries within given range.

virtual void	setBackend (AMP::Utilities::Backend backend)

template<class TYPE >
void	setValuesByGlobalID (size_t num_rows, size_t num_cols, const size_t rows, const size_t cols, const TYPE *values)
	Set values in the matrix.

void	setValuesByGlobalID (size_t num_rows, size_t num_cols, const size_t rows, const size_t cols, const void *values, const typeID &id) override
	Set values in the matrix.

std::shared_ptr< MatrixData >	shared_from_this ()

std::shared_ptr< const MatrixData >	shared_from_this () const

std::shared_ptr< MatrixData >	transpose () const override
	Transpose.

std::string	type () const override
	Return the type of the matrix.

virtual void	writeRestart (int64_t fid) const
	Write restart data to file.

virtual	~DenseSerialMatrixData ()
	Destructor.

Protected Attributes
size_t	d_cols

std::shared_ptr< AMP::Discretization::DOFManager >	d_DOFManagerLeft

std::shared_ptr< AMP::Discretization::DOFManager >	d_DOFManagerRight

uint64_t	d_hash = 0

double *	d_M = nullptr

std::shared_ptr< MatrixParametersBase >	d_pParameters

size_t	d_rows

std::weak_ptr< MatrixData >	weak_ptr_

Friends
class	DenseSerialMatrix

class	DenseSerialMatrixOperations

Detailed Description

An concrete class for dealing with dense serial matrices.

This is a concrete class that stores a dense local matrix. This is not a distributed matrix and requires that the comm is AMP_COMM_SELF.

Definition at line 21 of file DenseSerialMatrixData.h.

Constructor & Destructor Documentation

◆ DenseSerialMatrixData() [1/3]

AMP::LinearAlgebra::DenseSerialMatrixData::DenseSerialMatrixData ( std::shared_ptr< MatrixParametersBase > params )

explicit

Constructor.

Parameters

[in] params Description of the matrix

◆ DenseSerialMatrixData() [2/3]

AMP::LinearAlgebra::DenseSerialMatrixData::DenseSerialMatrixData ( )

delete

◆ DenseSerialMatrixData() [3/3]

AMP::LinearAlgebra::DenseSerialMatrixData::DenseSerialMatrixData ( const DenseSerialMatrixData & )

delete

◆ ~DenseSerialMatrixData()

virtual AMP::LinearAlgebra::DenseSerialMatrixData::~DenseSerialMatrixData ( )

virtual

Destructor.

Member Function Documentation

◆ addValuesByGlobalID() [1/2]

template<class TYPE >

void AMP::LinearAlgebra::MatrixData::addValuesByGlobalID	(	size_t	num_rows,
		size_t	num_cols,
		const size_t *	rows,
		const size_t *	cols,
		const TYPE *	values
	)

inherited

Add values to those in the matrix.

Parameters

[in]	num_rows	The number of rows represented in values
[in]	num_cols	The number of cols represented in values
[in]	rows	The row ids of values
[in]	cols	The column ids of values
[in]	values	The values to add to the matrix (row-major ordering)

This method may fail if the matrix has not allocated a particular (row,col) specified, depending on the actual subclass of matrix used.

◆ addValuesByGlobalID() [2/2]

void AMP::LinearAlgebra::DenseSerialMatrixData::addValuesByGlobalID	(	size_t	num_rows,
		size_t	num_cols,
		const size_t *	rows,
		const size_t *	cols,
		const void *	values,
		const typeID &	id
	)

overridevirtual

Add values to those in the matrix.

Parameters

[in]	num_rows	The number of rows represented in values
[in]	num_cols	The number of cols represented in values
[in]	rows	The row ids of values
[in]	cols	The column ids of values
[in]	values	The values to add to the matrix
[in]	id	typeID of raw data

This method may fail if the matrix has not allocated a particular(row,col) specified, depending on the actual subclass of matrix used.

Implements AMP::LinearAlgebra::MatrixData.

◆ beginCol()

virtual size_t AMP::LinearAlgebra::MatrixData::beginCol ( ) const

virtualinherited

Get the global id of first column in diagonal block.

Returns: beginning global column id

Reimplemented in AMP::LinearAlgebra::CSRMatrixData< Config >.

◆ beginRow()

virtual size_t AMP::LinearAlgebra::MatrixData::beginRow ( ) const

virtualinherited

Get the global id of the beginning row.

Returns: beginning global row id

Reimplemented in AMP::LinearAlgebra::CSRMatrixData< Config >.

◆ cloneMatrixData()

std::shared_ptr< MatrixData > AMP::LinearAlgebra::DenseSerialMatrixData::cloneMatrixData ( ) const

overridevirtual

Return a matrix with the same non-zero and distributed structure.

Returns: The new matrix

Implements AMP::LinearAlgebra::MatrixData.

◆ endCol()

virtual size_t AMP::LinearAlgebra::MatrixData::endCol ( ) const

virtualinherited

Get the global id of last column in diagonal block.

Returns: ending global column id

Reimplemented in AMP::LinearAlgebra::CSRMatrixData< Config >.

◆ endRow()

virtual size_t AMP::LinearAlgebra::MatrixData::endRow ( ) const

virtualinherited

Get the global id of the ending row.

Returns: ending global row id

Reimplemented in AMP::LinearAlgebra::CSRMatrixData< Config >.

◆ getBackend()

virtual AMP::Utilities::Backend AMP::LinearAlgebra::MatrixData::getBackend ( ) const

inlinevirtualinherited

Get the backend.

Definition at line 268 of file MatrixData.h.

References AMP_ASSERT, and AMP::LinearAlgebra::MatrixData::d_pParameters.

◆ getCoeffType()

typeID AMP::LinearAlgebra::DenseSerialMatrixData::getCoeffType ( ) const

inlineoverridevirtual

Return the typeid of the matrix coeffs.

Implements AMP::LinearAlgebra::MatrixData.

Definition at line 163 of file DenseSerialMatrixData.h.

References type().

◆ getColumnIDs()

std::vector< size_t > AMP::LinearAlgebra::DenseSerialMatrixData::getColumnIDs ( size_t row ) const

overridevirtual

Given a row, retrieve the non-zero column indices of the matrix in compressed format.

Parameters

[in] row Which row

Implements AMP::LinearAlgebra::MatrixData.

◆ getComm()

virtual AMP_MPI AMP::LinearAlgebra::MatrixData::getComm ( ) const

inlinevirtualinherited

Get the comm.

Reimplemented in AMP::LinearAlgebra::NativePetscMatrixData, and AMP::LinearAlgebra::EpetraMatrixData.

Definition at line 261 of file MatrixData.h.

References AMP_ASSERT, and AMP::LinearAlgebra::MatrixData::d_pParameters.

◆ getID()

uint64_t AMP::LinearAlgebra::MatrixData::getID ( ) const

inherited

Get a unique id hash for the vector.

◆ getLeftDOFManager()

std::shared_ptr< Discretization::DOFManager > AMP::LinearAlgebra::DenseSerialMatrixData::getLeftDOFManager ( ) const

overridevirtual

Get the DOFManager associated with a left vector( For \(\mathbf{y}^T\mathbf{Ax}\), \(\mathbf{y}\) is a left vector )

Returns: The DOFManager associated with a left vector

Implements AMP::LinearAlgebra::MatrixData.

◆ getLeftVariable()

virtual std::shared_ptr< Variable > AMP::LinearAlgebra::MatrixData::getLeftVariable ( ) const

inlinevirtualinherited

Get the variable associated with a left vector ( For \(\mathbf{y}^T\mathbf{Ax}\), \(\mathbf{y}\) is a left vector )

Returns: The variable associated with a left vector

Definition at line 215 of file MatrixData.h.

References AMP::LinearAlgebra::MatrixData::d_pParameters.

◆ getRightDOFManager()

std::shared_ptr< Discretization::DOFManager > AMP::LinearAlgebra::DenseSerialMatrixData::getRightDOFManager ( ) const

overridevirtual

Get the DOFManager associated with a right vector( For \(\mathbf{y}^T\mathbf{Ax}\), \(\mathbf{x}\) is a right vector )

Returns: The DOFManager associated with a right vector

Implements AMP::LinearAlgebra::MatrixData.

◆ getRightVariable()

virtual std::shared_ptr< Variable > AMP::LinearAlgebra::MatrixData::getRightVariable ( ) const

inlinevirtualinherited

Get the variable associated with a right vector ( For \(\mathbf{y}^T\mathbf{Ax}\), \(\mathbf{x}\) is a right vector )

Returns: The variable associated with a right vector

Definition at line 205 of file MatrixData.h.

References AMP::LinearAlgebra::MatrixData::d_pParameters.

◆ getRowByGlobalID()

void AMP::LinearAlgebra::DenseSerialMatrixData::getRowByGlobalID	(	size_t	row,
		std::vector< size_t > &	cols,
		std::vector< double > &	values
	)		const

overridevirtual

Retrieve a row of the matrix in compressed format.

Parameters

[in]	row	Which row
[out]	cols	The column ids of the returned values
[out]	values	The values in the row

Implements AMP::LinearAlgebra::MatrixData.

◆ getValuesByGlobalID() [1/2]

template<class TYPE >

void AMP::LinearAlgebra::MatrixData::getValuesByGlobalID	(	size_t	num_rows,
		size_t	num_cols,
		const size_t *	rows,
		const size_t *	cols,
		TYPE *	values
	)		const

inherited

Get values in the matrix.

Parameters

[in]	num_rows	The number of rows represented in values
[in]	num_cols	The number of cols represented in values
[in]	rows	The row ids of values
[in]	cols	The column ids of values
[out]	values	The values to get from the matrix (row-major ordering)

This method will return zero for any entries that have not been allocated or are not ghosts on the current processor.

◆ getValuesByGlobalID() [2/2]

void AMP::LinearAlgebra::DenseSerialMatrixData::getValuesByGlobalID	(	size_t	num_rows,
		size_t	num_cols,
		const size_t *	rows,
		const size_t *	cols,
		void *	values,
		const typeID &	id
	)		const

overridevirtual

Get values in the matrix.

Parameters

[in]	num_rows	The number of rows represented in values
[in]	num_cols	The number of cols represented in values
[in]	rows	The row ids of values
[in]	cols	The column ids of values
[in]	values	The values to get from the matrix (row-major ordering)
[in]	id	typeID of raw data

This method will return zero for any entries that have not been allocated or are not ghosts on the current processor.

Implements AMP::LinearAlgebra::MatrixData.

◆ makeConsistent()

void AMP::LinearAlgebra::DenseSerialMatrixData::makeConsistent ( AMP::LinearAlgebra::ScatterType )

inlineoverridevirtual

Perform communication to ensure values in the matrix are the same across cores.

Implements AMP::LinearAlgebra::MatrixData.

Definition at line 125 of file DenseSerialMatrixData.h.

◆ mode()

virtual std::uint16_t AMP::LinearAlgebra::MatrixData::mode ( ) const

inlinevirtualinherited

Return CSR mode of the matrix.

Reimplemented in AMP::LinearAlgebra::CSRMatrixData< Config >.

Definition at line 57 of file MatrixData.h.

◆ numberColumnIDs()

size_t AMP::LinearAlgebra::DenseSerialMatrixData::numberColumnIDs ( size_t row ) const

overridevirtual

Given a row, retrieve the number of non-zero column indices of the matrix.

Parameters

[in] row Which row

Implements AMP::LinearAlgebra::MatrixData.

◆ numGlobalColumns()

size_t AMP::LinearAlgebra::DenseSerialMatrixData::numGlobalColumns ( ) const

inlineoverridevirtual

Get the number of global columns in the matrix.

Returns: The number of global columns

Reimplemented from AMP::LinearAlgebra::MatrixData.

Definition at line 159 of file DenseSerialMatrixData.h.

References d_cols.

◆ numGlobalRows()

size_t AMP::LinearAlgebra::DenseSerialMatrixData::numGlobalRows ( ) const

inlineoverridevirtual

Get the number of global rows in the matrix.

Returns: The number of global rows

Reimplemented from AMP::LinearAlgebra::MatrixData.

Definition at line 149 of file DenseSerialMatrixData.h.

References d_rows.

◆ numLocalColumns()

size_t AMP::LinearAlgebra::DenseSerialMatrixData::numLocalColumns ( ) const

inlineoverridevirtual

Get the number of local columns in the matrix.

Returns: The number of local columns

Reimplemented from AMP::LinearAlgebra::MatrixData.

Definition at line 154 of file DenseSerialMatrixData.h.

References d_cols.

◆ numLocalRows()

size_t AMP::LinearAlgebra::DenseSerialMatrixData::numLocalRows ( ) const

inlineoverridevirtual

Get the number of local rows in the matrix.

Returns: The number of local rows

Reimplemented from AMP::LinearAlgebra::MatrixData.

Definition at line 144 of file DenseSerialMatrixData.h.

References d_rows.

◆ operator=()

DenseSerialMatrixData & AMP::LinearAlgebra::DenseSerialMatrixData::operator= ( const DenseSerialMatrixData & )

delete

◆ registerChildObjects()

virtual void AMP::LinearAlgebra::MatrixData::registerChildObjects ( AMP::IO::RestartManager * manager ) const

virtualinherited

Register any child objects.

This function will register child objects with the manager

Parameters

manager Restart manager

Reimplemented in AMP::LinearAlgebra::CSRMatrixData< Config >.

◆ removeRange()

void AMP::LinearAlgebra::DenseSerialMatrixData::removeRange	(	AMP::Scalar	bnd_lo,
		AMP::Scalar	bnd_up
	)

inlineoverridevirtual

Remove matrix entries within given range.

Implements AMP::LinearAlgebra::MatrixData.

Definition at line 47 of file DenseSerialMatrixData.h.

References AMP_ERROR.

◆ setBackend()

virtual void AMP::LinearAlgebra::MatrixData::setBackend ( AMP::Utilities::Backend backend )

inlinevirtualinherited

Definition at line 274 of file MatrixData.h.

References AMP_ASSERT, and AMP::LinearAlgebra::MatrixData::d_pParameters.

◆ setValuesByGlobalID() [1/2]

template<class TYPE >

void AMP::LinearAlgebra::MatrixData::setValuesByGlobalID	(	size_t	num_rows,
		size_t	num_cols,
		const size_t *	rows,
		const size_t *	cols,
		const TYPE *	values
	)

inherited

Set values in the matrix.

Parameters

[in]	num_rows	The number of rows represented in values
[in]	num_cols	The number of cols represented in values
[in]	rows	The row ids of values
[in]	cols	The column ids of values
[in]	values	The values to set to the matrix (row-major ordering)

This method may fail if the matrix has not allocated a particular (row,col) specified, depending on the actual subclass of matrix used.

◆ setValuesByGlobalID() [2/2]

void AMP::LinearAlgebra::DenseSerialMatrixData::setValuesByGlobalID	(	size_t	num_rows,
		size_t	num_cols,
		const size_t *	rows,
		const size_t *	cols,
		const void *	values,
		const typeID &	id
	)

overridevirtual

Set values in the matrix.

Parameters

[in]	num_rows	The number of rows represented in values
[in]	num_cols	The number of cols represented in values
[in]	rows	The row ids of values
[in]	cols	The column ids of values
[in]	values	The values to set to the matrix
[in]	id	typeID of raw data

This method may fail if the matrix has not allocated a particular(row,col) specified, depending on the actual subclass of matrix used.

Implements AMP::LinearAlgebra::MatrixData.

◆ shared_from_this() [1/2]

std::shared_ptr< MatrixData > AMP::enable_shared_from_this< MatrixData >::shared_from_this ( )

inlineinherited

Definition at line 28 of file enable_shared_from_this.h.

◆ shared_from_this() [2/2]

std::shared_ptr< const MatrixData > AMP::enable_shared_from_this< MatrixData >::shared_from_this ( ) const

inlineinherited

Definition at line 46 of file enable_shared_from_this.h.

◆ transpose()

std::shared_ptr< MatrixData > AMP::LinearAlgebra::DenseSerialMatrixData::transpose ( ) const

overridevirtual

Transpose.

Implements AMP::LinearAlgebra::MatrixData.

◆ type()

std::string AMP::LinearAlgebra::DenseSerialMatrixData::type ( ) const

inlineoverridevirtual

Return the type of the matrix.

Implements AMP::LinearAlgebra::MatrixData.

Definition at line 38 of file DenseSerialMatrixData.h.

Referenced by getCoeffType().

◆ writeRestart()

virtual void AMP::LinearAlgebra::MatrixData::writeRestart ( int64_t fid ) const

virtualinherited

Write restart data to file.

This function will write the mesh to an HDF5 file

Parameters

fid	File identifier to write

Reimplemented in AMP::LinearAlgebra::CSRMatrixData< Config >.

Friends And Related Symbol Documentation

◆ DenseSerialMatrix

friend class DenseSerialMatrix

friend

Definition at line 179 of file DenseSerialMatrixData.h.

◆ DenseSerialMatrixOperations

friend class DenseSerialMatrixOperations

friend

Definition at line 180 of file DenseSerialMatrixData.h.

Member Data Documentation

◆ d_cols

size_t AMP::LinearAlgebra::DenseSerialMatrixData::d_cols

protected

Definition at line 176 of file DenseSerialMatrixData.h.

Referenced by numGlobalColumns(), and numLocalColumns().

◆ d_DOFManagerLeft

std::shared_ptr<AMP::Discretization::DOFManager> AMP::LinearAlgebra::DenseSerialMatrixData::d_DOFManagerLeft

protected

Definition at line 171 of file DenseSerialMatrixData.h.

◆ d_DOFManagerRight

std::shared_ptr<AMP::Discretization::DOFManager> AMP::LinearAlgebra::DenseSerialMatrixData::d_DOFManagerRight

protected

Definition at line 172 of file DenseSerialMatrixData.h.

◆ d_hash

uint64_t AMP::LinearAlgebra::MatrixData::d_hash = 0

protectedinherited

Definition at line 311 of file MatrixData.h.

◆ d_M

double* AMP::LinearAlgebra::DenseSerialMatrixData::d_M = nullptr

protected

Definition at line 177 of file DenseSerialMatrixData.h.

◆ d_pParameters

std::shared_ptr<MatrixParametersBase> AMP::LinearAlgebra::MatrixData::d_pParameters

protectedinherited

Definition at line 308 of file MatrixData.h.

Referenced by AMP::LinearAlgebra::MatrixData::getBackend(), AMP::LinearAlgebra::MatrixData::getComm(), AMP::LinearAlgebra::MatrixData::getLeftVariable(), AMP::LinearAlgebra::MatrixData::getRightVariable(), and AMP::LinearAlgebra::MatrixData::setBackend().

◆ d_rows

size_t AMP::LinearAlgebra::DenseSerialMatrixData::d_rows

protected

Definition at line 175 of file DenseSerialMatrixData.h.

Referenced by numGlobalRows(), and numLocalRows().

◆ weak_ptr_

std::weak_ptr<MatrixData > AMP::enable_shared_from_this< MatrixData >::weak_ptr_

mutableprotectedinherited

Definition at line 69 of file enable_shared_from_this.h.

The documentation for this class was generated from the following file:

src/matrices/data/DenseSerialMatrixData.h

Public Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ DenseSerialMatrixData() [1/3]

◆ DenseSerialMatrixData() [2/3]

◆ DenseSerialMatrixData() [3/3]

◆ ~DenseSerialMatrixData()

Member Function Documentation

◆ addValuesByGlobalID() [1/2]

◆ addValuesByGlobalID() [2/2]

◆ beginCol()

◆ beginRow()

◆ cloneMatrixData()

◆ endCol()

◆ endRow()

◆ getBackend()

◆ getCoeffType()

◆ getColumnIDs()

◆ getComm()

◆ getID()

◆ getLeftDOFManager()

◆ getLeftVariable()

◆ getRightDOFManager()

◆ getRightVariable()

◆ getRowByGlobalID()

◆ getValuesByGlobalID() [1/2]

◆ getValuesByGlobalID() [2/2]

◆ makeConsistent()

◆ mode()

◆ numberColumnIDs()

◆ numGlobalColumns()

◆ numGlobalRows()

◆ numLocalColumns()

◆ numLocalRows()

◆ operator=()

◆ registerChildObjects()

◆ removeRange()

◆ setBackend()

◆ setValuesByGlobalID() [1/2]

◆ setValuesByGlobalID() [2/2]

◆ shared_from_this() [1/2]

◆ shared_from_this() [2/2]

◆ transpose()

◆ type()

◆ writeRestart()

Friends And Related Symbol Documentation

◆ DenseSerialMatrix

◆ DenseSerialMatrixOperations

Member Data Documentation

◆ d_cols

◆ d_DOFManagerLeft

◆ d_DOFManagerRight

◆ d_hash

◆ d_M

◆ d_pParameters

◆ d_rows

◆ weak_ptr_