A class used to hold basic parameters for a matrix. More...

#include <MatrixParameters.h>

Inheritance diagram for AMP::LinearAlgebra::MatrixParameters:

[legend]

Public Member Functions
AMP::AMP_MPI &	getComm ()
	Get the communicator for the matrix.

size_t	getGlobalNumberOfColumns () const
	Return the global number of columns.

size_t	getGlobalNumberOfRows () const
	Return the global number of rows.

uint64_t	getID () const
	Get a unique id hash.

std::shared_ptr< CommunicationList >	getLeftCommList ()
	Get the communication list for the left vector.

std::shared_ptr< AMP::Discretization::DOFManager >	getLeftDOFManager ()

std::shared_ptr< Variable >	getLeftVariable () const

size_t	getLocalNumberOfColumns () const
	Return the local number of columns.

size_t	getLocalNumberOfRows () const
	Return the local number of rows.

std::shared_ptr< CommunicationList >	getRightCommList ()
	Get the communication list for the right vector.

std::shared_ptr< AMP::Discretization::DOFManager >	getRightDOFManager ()

std::shared_ptr< Variable >	getRightVariable () const

const std::function< std::vector< size_t >(size_t)> &	getRowFunction () const
	Get the bound function that generates column IDs for each row.

	MatrixParameters ()=delete

	MatrixParameters (int64_t fid, AMP::IO::RestartManager *manager)
	Read restart data from file.

	MatrixParameters (std::shared_ptr< AMP::Discretization::DOFManager > dofLeft, std::shared_ptr< AMP::Discretization::DOFManager > dofRight, const AMP_MPI &comm, AMP::Utilities::Backend backend, const std::function< std::vector< size_t >(size_t)> getRow={})
	Constructor.

	MatrixParameters (std::shared_ptr< AMP::Discretization::DOFManager > dofLeft, std::shared_ptr< AMP::Discretization::DOFManager > dofRight, const AMP_MPI &comm, const std::function< std::vector< size_t >(size_t)> getRow={})
	Constructor.

	MatrixParameters (std::shared_ptr< AMP::Discretization::DOFManager > dofLeft, std::shared_ptr< AMP::Discretization::DOFManager > dofRight, const AMP_MPI &comm, std::shared_ptr< CommunicationList > commListLeft, std::shared_ptr< CommunicationList > commListRight, AMP::Utilities::Backend backend, const std::function< std::vector< size_t >(size_t)> getRow={})
	Constructor.

	MatrixParameters (std::shared_ptr< AMP::Discretization::DOFManager > dofLeft, std::shared_ptr< AMP::Discretization::DOFManager > dofRight, const AMP_MPI &comm, std::shared_ptr< CommunicationList > commListLeft, std::shared_ptr< CommunicationList > commListRight, const std::function< std::vector< size_t >(size_t)> getRow={})
	Constructor.

	MatrixParameters (std::shared_ptr< AMP::Discretization::DOFManager > dofLeft, std::shared_ptr< AMP::Discretization::DOFManager > dofRight, const AMP_MPI &comm, std::shared_ptr< Variable > varLeft, std::shared_ptr< Variable > varRight, AMP::Utilities::Backend backend, const std::function< std::vector< size_t >(size_t)> getRow={})
	Constructor.

	MatrixParameters (std::shared_ptr< AMP::Discretization::DOFManager > dofLeft, std::shared_ptr< AMP::Discretization::DOFManager > dofRight, const AMP_MPI &comm, std::shared_ptr< Variable > varLeft, std::shared_ptr< Variable > varRight, const std::function< std::vector< size_t >(size_t)> getRow={})
	Constructor.

	MatrixParameters (std::shared_ptr< AMP::Discretization::DOFManager > dofLeft, std::shared_ptr< AMP::Discretization::DOFManager > dofRight, const AMP_MPI &comm, std::shared_ptr< Variable > varLeft, std::shared_ptr< Variable > varRight, std::shared_ptr< CommunicationList > commListLeft, std::shared_ptr< CommunicationList > commListRight, AMP::Utilities::Backend backend, const std::function< std::vector< size_t >(size_t)> getRow={})
	Constructor.

	MatrixParameters (std::shared_ptr< AMP::Discretization::DOFManager > dofLeft, std::shared_ptr< AMP::Discretization::DOFManager > dofRight, const AMP_MPI &comm, std::shared_ptr< Variable > varLeft, std::shared_ptr< Variable > varRight, std::shared_ptr< CommunicationList > commListLeft, std::shared_ptr< CommunicationList > commListRight, const std::function< std::vector< size_t >(size_t)> getRow={})
	Constructor.

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

void	setLeftVariable (std::shared_ptr< Variable > var)

void	setRightVariable (std::shared_ptr< Variable > var)

std::string	type () const override
	type of this object

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

virtual	~MatrixParameters ()=default
	Destructor.

Public Attributes
AMP::Utilities::Backend	d_backend = AMP::Utilities::Backend::Serial

uint64_t	d_hash = 0

Protected Member Functions
void	generateCommLists ()

Protected Attributes
AMP_MPI	d_comm

std::shared_ptr< CommunicationList >	d_CommListLeft

std::shared_ptr< CommunicationList >	d_CommListRight

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

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

std::function< std::vector< size_t >(size_t)>	d_getRow
	Function that generates column ids for each row of the matrix.

std::shared_ptr< Variable >	d_VariableLeft

std::shared_ptr< Variable >	d_VariableRight

Detailed Description

A class used to hold basic parameters for a matrix.

Definition at line 15 of file MatrixParameters.h.

Constructor & Destructor Documentation

◆ MatrixParameters() [1/10]

AMP::LinearAlgebra::MatrixParameters::MatrixParameters ( )

delete

◆ MatrixParameters() [2/10]

AMP::LinearAlgebra::MatrixParameters::MatrixParameters	(	std::shared_ptr< AMP::Discretization::DOFManager >	dofLeft,
		std::shared_ptr< AMP::Discretization::DOFManager >	dofRight,
		const AMP_MPI &	comm,
		const std::function< std::vector< size_t >(size_t)>	getRow = `{}`
	)

explicit

Constructor.

Parameters

[in]	dofLeft	The DOFManager for the left vector ( For \(\mathbf{y}^T\mathbf{Ax}\), \(y\) is a left vector )
[in]	dofRight	The DOFManager for the right vector ( For \(\mathbf{y}^T\mathbf{Ax}\), \(x\) is a right vector )
[in]	comm	Communicator for the matrix
[in]	getRow	Function that finds finds column indices of a row in each block

◆ MatrixParameters() [3/10]

AMP::LinearAlgebra::MatrixParameters::MatrixParameters	(	std::shared_ptr< AMP::Discretization::DOFManager >	dofLeft,
		std::shared_ptr< AMP::Discretization::DOFManager >	dofRight,
		const AMP_MPI &	comm,
		AMP::Utilities::Backend	backend,
		const std::function< std::vector< size_t >(size_t)>	getRow = `{}`
	)

explicit

Constructor.

Parameters

[in]	dofLeft	The DOFManager for the left vector ( For \(\mathbf{y}^T\mathbf{Ax}\), \(y\) is a left vector )
[in]	dofRight	The DOFManager for the right vector ( For \(\mathbf{y}^T\mathbf{Ax}\), \(x\) is a right vector )
[in]	comm	Communicator for the matrix
[in]	backend	Acceleration backend for matrix operations
[in]	getRow	Function that finds finds column indices of a row in each block

◆ MatrixParameters() [4/10]

AMP::LinearAlgebra::MatrixParameters::MatrixParameters	(	std::shared_ptr< AMP::Discretization::DOFManager >	dofLeft,
		std::shared_ptr< AMP::Discretization::DOFManager >	dofRight,
		const AMP_MPI &	comm,
		std::shared_ptr< Variable >	varLeft,
		std::shared_ptr< Variable >	varRight,
		const std::function< std::vector< size_t >(size_t)>	getRow = `{}`
	)

explicit

Constructor.

Parameters

[in]	dofLeft	The DOFManager for the left vector ( For \(\mathbf{y}^T\mathbf{Ax}\), \(y\) is a left vector )
[in]	dofRight	The DOFManager for the right vector ( For \(\mathbf{y}^T\mathbf{Ax}\), \(x\) is a right vector )
[in]	comm	Communicator for the matrix
[in]	varLeft	Pointer to left variable
[in]	varRight	Pointer to right variable
[in]	getRow	Function that finds finds column indices of a row in each block

◆ MatrixParameters() [5/10]

AMP::LinearAlgebra::MatrixParameters::MatrixParameters	(	std::shared_ptr< AMP::Discretization::DOFManager >	dofLeft,
		std::shared_ptr< AMP::Discretization::DOFManager >	dofRight,
		const AMP_MPI &	comm,
		std::shared_ptr< Variable >	varLeft,
		std::shared_ptr< Variable >	varRight,
		AMP::Utilities::Backend	backend,
		const std::function< std::vector< size_t >(size_t)>	getRow = `{}`
	)

explicit

Constructor.

Parameters

[in]	dofLeft	The DOFManager for the left vector ( For \(\mathbf{y}^T\mathbf{Ax}\), \(y\) is a left vector )
[in]	dofRight	The DOFManager for the right vector ( For \(\mathbf{y}^T\mathbf{Ax}\), \(x\) is a right vector )
[in]	comm	Communicator for the matrix
[in]	varLeft	Pointer to left variable
[in]	varRight	Pointer to right variable
[in]	backend	Acceleration backend for matrix operations
[in]	getRow	Function that finds finds column indices of a row in each block

◆ MatrixParameters() [6/10]

AMP::LinearAlgebra::MatrixParameters::MatrixParameters	(	std::shared_ptr< AMP::Discretization::DOFManager >	dofLeft,
		std::shared_ptr< AMP::Discretization::DOFManager >	dofRight,
		const AMP_MPI &	comm,
		std::shared_ptr< CommunicationList >	commListLeft,
		std::shared_ptr< CommunicationList >	commListRight,
		const std::function< std::vector< size_t >(size_t)>	getRow = `{}`
	)

explicit

Constructor.

Parameters

[in]	dofLeft	The DOFManager for the left vector ( For \(\mathbf{y}^T\mathbf{Ax}\), \(y\) is a left vector )
[in]	dofRight	The DOFManager for the right vector ( For \(\mathbf{y}^T\mathbf{Ax}\), \(x\) is a right vector )
[in]	comm	Communicator for the matrix
[in]	commListLeft	Communication list for the left vector
[in]	commListRight	Communication list for the right vector
[in]	getRow	Function that finds finds column indices of a row in each block

◆ MatrixParameters() [7/10]

AMP::LinearAlgebra::MatrixParameters::MatrixParameters	(	std::shared_ptr< AMP::Discretization::DOFManager >	dofLeft,
		std::shared_ptr< AMP::Discretization::DOFManager >	dofRight,
		const AMP_MPI &	comm,
		std::shared_ptr< CommunicationList >	commListLeft,
		std::shared_ptr< CommunicationList >	commListRight,
		AMP::Utilities::Backend	backend,
		const std::function< std::vector< size_t >(size_t)>	getRow = `{}`
	)

explicit

Constructor.

Parameters

[in]	dofLeft	The DOFManager for the left vector ( For \(\mathbf{y}^T\mathbf{Ax}\), \(y\) is a left vector )
[in]	dofRight	The DOFManager for the right vector ( For \(\mathbf{y}^T\mathbf{Ax}\), \(x\) is a right vector )
[in]	comm	Communicator for the matrix
[in]	commListLeft	Communication list for the left vector
[in]	commListRight	Communication list for the right vector
[in]	backend	Acceleration backend for matrix operations
[in]	getRow	Function that finds finds column indices of a row in each block

◆ MatrixParameters() [8/10]

AMP::LinearAlgebra::MatrixParameters::MatrixParameters	(	std::shared_ptr< AMP::Discretization::DOFManager >	dofLeft,
		std::shared_ptr< AMP::Discretization::DOFManager >	dofRight,
		const AMP_MPI &	comm,
		std::shared_ptr< Variable >	varLeft,
		std::shared_ptr< Variable >	varRight,
		std::shared_ptr< CommunicationList >	commListLeft,
		std::shared_ptr< CommunicationList >	commListRight,
		const std::function< std::vector< size_t >(size_t)>	getRow = `{}`
	)

explicit

Constructor.

Parameters

[in]	dofLeft	The DOFManager for the left vector ( For \(\mathbf{y}^T\mathbf{Ax}\), \(y\) is a left vector )
[in]	dofRight	The DOFManager for the right vector ( For \(\mathbf{y}^T\mathbf{Ax}\), \(x\) is a right vector )
[in]	comm	Communicator for the matrix
[in]	varLeft	Pointer to left variable
[in]	varRight	Pointer to right variable
[in]	commListLeft	Communication list for the left vector
[in]	commListRight	Communication list for the right vector
[in]	getRow	Function that finds finds column indices of a row in each block

◆ MatrixParameters() [9/10]

AMP::LinearAlgebra::MatrixParameters::MatrixParameters	(	std::shared_ptr< AMP::Discretization::DOFManager >	dofLeft,
		std::shared_ptr< AMP::Discretization::DOFManager >	dofRight,
		const AMP_MPI &	comm,
		std::shared_ptr< Variable >	varLeft,
		std::shared_ptr< Variable >	varRight,
		std::shared_ptr< CommunicationList >	commListLeft,
		std::shared_ptr< CommunicationList >	commListRight,
		AMP::Utilities::Backend	backend,
		const std::function< std::vector< size_t >(size_t)>	getRow = `{}`
	)

explicit

Constructor.

Parameters

[in]	dofLeft	The DOFManager for the left vector ( For \(\mathbf{y}^T\mathbf{Ax}\), \(y\) is a left vector )
[in]	dofRight	The DOFManager for the right vector ( For \(\mathbf{y}^T\mathbf{Ax}\), \(x\) is a right vector )
[in]	comm	Communicator for the matrix
[in]	varLeft	Pointer to left variable
[in]	varRight	Pointer to right variable
[in]	commListLeft	Communication list for the left vector
[in]	commListRight	Communication list for the right vector
[in]	backend	Acceleration backend for matrix operations
[in]	getRow	Function that finds finds column indices of a row in each block

◆ ~MatrixParameters()

virtual AMP::LinearAlgebra::MatrixParameters::~MatrixParameters ( )

virtualdefault

Destructor.

◆ MatrixParameters() [10/10]

AMP::LinearAlgebra::MatrixParameters::MatrixParameters	(	int64_t	fid,
		AMP::IO::RestartManager *	manager
	)

Read restart data from file.

Parameters

fid	File identifier to write
manager	Restart manager

Member Function Documentation

◆ generateCommLists()

void AMP::LinearAlgebra::MatrixParameters::generateCommLists ( )

protected

◆ getComm()

AMP::AMP_MPI & AMP::LinearAlgebra::MatrixParametersBase::getComm ( )

inlineinherited

Get the communicator for the matrix.

Definition at line 90 of file MatrixParametersBase.h.

References AMP::LinearAlgebra::MatrixParametersBase::d_comm.

◆ getGlobalNumberOfColumns()

size_t AMP::LinearAlgebra::MatrixParameters::getGlobalNumberOfColumns ( ) const

Return the global number of columns.

◆ getGlobalNumberOfRows()

size_t AMP::LinearAlgebra::MatrixParameters::getGlobalNumberOfRows ( ) const

Return the global number of rows.

◆ getID()

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

inlineinherited

Get a unique id hash.

Definition at line 84 of file MatrixParametersBase.h.

References AMP::LinearAlgebra::MatrixParametersBase::d_hash.

◆ getLeftCommList()

std::shared_ptr< CommunicationList > AMP::LinearAlgebra::MatrixParameters::getLeftCommList ( )

Get the communication list for the left vector.

◆ getLeftDOFManager()

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

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

◆ getLeftVariable()

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

inlineinherited

Definition at line 96 of file MatrixParametersBase.h.

References AMP::LinearAlgebra::MatrixParametersBase::d_VariableLeft.

◆ getLocalNumberOfColumns()

size_t AMP::LinearAlgebra::MatrixParameters::getLocalNumberOfColumns ( ) const

Return the local number of columns.

◆ getLocalNumberOfRows()

size_t AMP::LinearAlgebra::MatrixParameters::getLocalNumberOfRows ( ) const

Return the local number of rows.

◆ getRightCommList()

std::shared_ptr< CommunicationList > AMP::LinearAlgebra::MatrixParameters::getRightCommList ( )

Get the communication list for the right vector.

◆ getRightDOFManager()

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

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

◆ getRightVariable()

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

inlineinherited

Definition at line 98 of file MatrixParametersBase.h.

References AMP::LinearAlgebra::MatrixParametersBase::d_VariableRight.

◆ getRowFunction()

const std::function< std::vector< size_t >(size_t)> & AMP::LinearAlgebra::MatrixParameters::getRowFunction ( ) const

inline

Get the bound function that generates column IDs for each row.

Definition at line 181 of file MatrixParameters.h.

References d_getRow.

◆ registerChildObjects()

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

overridevirtual

Register any child objects.

This function will register child objects with the manager

Parameters

manager Restart manager

Reimplemented from AMP::LinearAlgebra::MatrixParametersBase.

◆ setLeftVariable()

void AMP::LinearAlgebra::MatrixParametersBase::setLeftVariable ( std::shared_ptr< Variable > var )

inlineinherited

Definition at line 92 of file MatrixParametersBase.h.

References AMP::LinearAlgebra::MatrixParametersBase::d_VariableLeft.

◆ setRightVariable()

void AMP::LinearAlgebra::MatrixParametersBase::setRightVariable ( std::shared_ptr< Variable > var )

inlineinherited

Definition at line 94 of file MatrixParametersBase.h.

References AMP::LinearAlgebra::MatrixParametersBase::d_VariableRight.

◆ type()

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

inlineoverridevirtual

type of this object

Reimplemented from AMP::LinearAlgebra::MatrixParametersBase.

Definition at line 197 of file MatrixParameters.h.

◆ writeRestart()

void AMP::LinearAlgebra::MatrixParameters::writeRestart ( int64_t fid ) const

overridevirtual

Write restart data to file.

This function will write the mesh to an HDF5 file

Parameters

fid	File identifier to write

Reimplemented from AMP::LinearAlgebra::MatrixParametersBase.

Member Data Documentation

◆ d_backend

AMP::Utilities::Backend AMP::LinearAlgebra::MatrixParametersBase::d_backend = AMP::Utilities::Backend::Serial

inherited

Definition at line 136 of file MatrixParametersBase.h.

◆ d_comm

AMP_MPI AMP::LinearAlgebra::MatrixParametersBase::d_comm

protectedinherited

Definition at line 124 of file MatrixParametersBase.h.

Referenced by AMP::LinearAlgebra::MatrixParametersBase::getComm().

◆ d_CommListLeft

std::shared_ptr<CommunicationList> AMP::LinearAlgebra::MatrixParameters::d_CommListLeft

protected

The communication list of a left vector ( For \(\mathbf{y}^T\mathbf{Ax}\), \(y\) is a left vector )

Definition at line 233 of file MatrixParameters.h.

◆ d_CommListRight

std::shared_ptr<CommunicationList> AMP::LinearAlgebra::MatrixParameters::d_CommListRight

protected

The communication list of a right vector ( For \(\mathbf{y}^T\mathbf{Ax}\), \(x\) is a right vector )

Definition at line 237 of file MatrixParameters.h.

◆ d_DOFManagerLeft

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

protected

Definition at line 226 of file MatrixParameters.h.

◆ d_DOFManagerRight

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

protected

Definition at line 229 of file MatrixParameters.h.

◆ d_getRow

std::function<std::vector<size_t>( size_t )> AMP::LinearAlgebra::MatrixParameters::d_getRow

protected

Function that generates column ids for each row of the matrix.

Definition at line 240 of file MatrixParameters.h.

Referenced by getRowFunction().

◆ d_hash

uint64_t AMP::LinearAlgebra::MatrixParametersBase::d_hash = 0

inherited

Definition at line 139 of file MatrixParametersBase.h.

Referenced by AMP::LinearAlgebra::MatrixParametersBase::getID().

◆ d_VariableLeft

std::shared_ptr<Variable> AMP::LinearAlgebra::MatrixParametersBase::d_VariableLeft

protectedinherited

The variable for the left vector ( For \(\mathbf{y}^T\mathbf{Ax}\), \(y\) is a left vector )

Definition at line 128 of file MatrixParametersBase.h.

Referenced by AMP::LinearAlgebra::MatrixParametersBase::getLeftVariable(), and AMP::LinearAlgebra::MatrixParametersBase::setLeftVariable().

◆ d_VariableRight

std::shared_ptr<Variable> AMP::LinearAlgebra::MatrixParametersBase::d_VariableRight

protectedinherited

The variable for the right vector ( For \(\mathbf{y}^T\mathbf{Ax}\), \(x\) is a right vector )

Definition at line 132 of file MatrixParametersBase.h.

Referenced by AMP::LinearAlgebra::MatrixParametersBase::getRightVariable(), and AMP::LinearAlgebra::MatrixParametersBase::setRightVariable().

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

src/matrices/MatrixParameters.h

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MatrixParameters() [1/10]

◆ MatrixParameters() [2/10]

◆ MatrixParameters() [3/10]

◆ MatrixParameters() [4/10]

◆ MatrixParameters() [5/10]

◆ MatrixParameters() [6/10]

◆ MatrixParameters() [7/10]

◆ MatrixParameters() [8/10]

◆ MatrixParameters() [9/10]

◆ ~MatrixParameters()

◆ MatrixParameters() [10/10]

Member Function Documentation

◆ generateCommLists()

◆ getComm()

◆ getGlobalNumberOfColumns()

◆ getGlobalNumberOfRows()

◆ getID()

◆ getLeftCommList()

◆ getLeftDOFManager()

◆ getLeftVariable()

◆ getLocalNumberOfColumns()

◆ getLocalNumberOfRows()

◆ getRightCommList()

◆ getRightDOFManager()

◆ getRightVariable()

◆ getRowFunction()

◆ registerChildObjects()

◆ setLeftVariable()

◆ setRightVariable()

◆ type()

◆ writeRestart()

Member Data Documentation

◆ d_backend

◆ d_comm

◆ d_CommListLeft

◆ d_CommListRight

◆ d_DOFManagerLeft

◆ d_DOFManagerRight

◆ d_getRow

◆ d_hash

◆ d_VariableLeft

◆ d_VariableRight