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

#include <RawCSRMatrixParameters.h>

Inheritance diagram for AMP::LinearAlgebra::RawCSRMatrixParameters< Config >:

Classes
struct	RawCSRLocalMatrixParameters

Public Types
using	gidx_t = typename Config::gidx_t

using	lidx_t = typename Config::lidx_t

using	scalar_t = typename Config::scalar_t

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

uint64_t	getID () const
	Get a unique id hash.

std::shared_ptr< Variable >	getLeftVariable () const

std::shared_ptr< Variable >	getRightVariable () const

	RawCSRMatrixParameters ()=delete

	RawCSRMatrixParameters (gidx_t first_row, gidx_t last_row, gidx_t first_col, gidx_t last_col, const RawCSRLocalMatrixParameters &diag, const RawCSRLocalMatrixParameters &off_diag, const AMP_MPI &comm)
	Constructor.

	RawCSRMatrixParameters (gidx_t first_row, gidx_t last_row, gidx_t first_col, gidx_t last_col, const RawCSRLocalMatrixParameters &diag, const RawCSRLocalMatrixParameters &off_diag, const AMP_MPI &comm, AMP::Utilities::Backend backend)
	Constructor.

	RawCSRMatrixParameters (gidx_t first_row, gidx_t last_row, gidx_t first_col, gidx_t last_col, const RawCSRLocalMatrixParameters &diag, const RawCSRLocalMatrixParameters &off_diag, const AMP_MPI &comm, std::shared_ptr< Variable > var_left, std::shared_ptr< Variable > var_right)
	Constructor.

	RawCSRMatrixParameters (gidx_t first_row, gidx_t last_row, gidx_t first_col, gidx_t last_col, const RawCSRLocalMatrixParameters &diag, const RawCSRLocalMatrixParameters &off_diag, const AMP_MPI &comm, std::shared_ptr< Variable > var_left, std::shared_ptr< Variable > var_right, AMP::Utilities::Backend backend)
	Constructor.

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

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	~RawCSRMatrixParameters ()=default
	Destructor.

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

RawCSRLocalMatrixParameters	d_diag

gidx_t	d_first_col

gidx_t	d_first_row

uint64_t	d_hash = 0

gidx_t	d_last_col

gidx_t	d_last_row

RawCSRLocalMatrixParameters	d_off_diag

Protected Attributes
AMP_MPI	d_comm

std::shared_ptr< Variable >	d_VariableLeft

std::shared_ptr< Variable >	d_VariableRight

Detailed Description

template<typename Config>
class AMP::LinearAlgebra::RawCSRMatrixParameters< Config >

A class used to hold basic parameters for a matrix.

Definition at line 13 of file RawCSRMatrixParameters.h.

Member Typedef Documentation

◆ gidx_t

template<typename Config >

using AMP::LinearAlgebra::RawCSRMatrixParameters< Config >::gidx_t = typename Config::gidx_t

Definition at line 16 of file RawCSRMatrixParameters.h.

◆ lidx_t

template<typename Config >

using AMP::LinearAlgebra::RawCSRMatrixParameters< Config >::lidx_t = typename Config::lidx_t

Definition at line 17 of file RawCSRMatrixParameters.h.

◆ scalar_t

template<typename Config >

using AMP::LinearAlgebra::RawCSRMatrixParameters< Config >::scalar_t = typename Config::scalar_t

Definition at line 18 of file RawCSRMatrixParameters.h.

Constructor & Destructor Documentation

◆ RawCSRMatrixParameters() [1/6]

template<typename Config >

AMP::LinearAlgebra::RawCSRMatrixParameters< Config >::RawCSRMatrixParameters ( )

delete

◆ RawCSRMatrixParameters() [2/6]

template<typename Config >

AMP::LinearAlgebra::RawCSRMatrixParameters< Config >::RawCSRMatrixParameters	(	gidx_t	first_row,
		gidx_t	last_row,
		gidx_t	first_col,
		gidx_t	last_col,
		const RawCSRLocalMatrixParameters &	diag,
		const RawCSRLocalMatrixParameters &	off_diag,
		const AMP_MPI &	comm
	)

inlineexplicit

Constructor.

Parameters

[in]	first_row	Index for first row
[in]	last_row	Index for last row
[in]	first_col	Index for first col
[in]	last_col	Index for last col
[in]	diag	Parameters for diag block
[in]	off_diag	Parameters for offd block
[in]	comm	Communicator for the matrix

Definition at line 41 of file RawCSRMatrixParameters.h.

◆ RawCSRMatrixParameters() [3/6]

template<typename Config >

AMP::LinearAlgebra::RawCSRMatrixParameters< Config >::RawCSRMatrixParameters	(	gidx_t	first_row,
		gidx_t	last_row,
		gidx_t	first_col,
		gidx_t	last_col,
		const RawCSRLocalMatrixParameters &	diag,
		const RawCSRLocalMatrixParameters &	off_diag,
		const AMP_MPI &	comm,
		AMP::Utilities::Backend	backend
	)

inlineexplicit

Constructor.

Parameters

[in]	first_row	Index for first row
[in]	last_row	Index for last row
[in]	first_col	Index for first col
[in]	last_col	Index for last col
[in]	diag	Parameters for diag block
[in]	off_diag	Parameters for offd block
[in]	comm	Communicator for the matrix
[in]	backend	Acceleration backend for matrix operations

Definition at line 68 of file RawCSRMatrixParameters.h.

◆ RawCSRMatrixParameters() [4/6]

template<typename Config >

AMP::LinearAlgebra::RawCSRMatrixParameters< Config >::RawCSRMatrixParameters	(	gidx_t	first_row,
		gidx_t	last_row,
		gidx_t	first_col,
		gidx_t	last_col,
		const RawCSRLocalMatrixParameters &	diag,
		const RawCSRLocalMatrixParameters &	off_diag,
		const AMP_MPI &	comm,
		std::shared_ptr< Variable >	var_left,
		std::shared_ptr< Variable >	var_right
	)

inlineexplicit

Constructor.

Parameters

[in]	first_row	Index for first row
[in]	last_row	Index for last row
[in]	first_col	Index for first col
[in]	last_col	Index for last col
[in]	diag	Parameters for diag block
[in]	off_diag	Parameters for offd block
[in]	comm	Communicator for the matrix
[in]	var_left	Variable for left vector
[in]	var_right	Variable for right vector

Definition at line 97 of file RawCSRMatrixParameters.h.

◆ RawCSRMatrixParameters() [5/6]

template<typename Config >

AMP::LinearAlgebra::RawCSRMatrixParameters< Config >::RawCSRMatrixParameters	(	gidx_t	first_row,
		gidx_t	last_row,
		gidx_t	first_col,
		gidx_t	last_col,
		const RawCSRLocalMatrixParameters &	diag,
		const RawCSRLocalMatrixParameters &	off_diag,
		const AMP_MPI &	comm,
		std::shared_ptr< Variable >	var_left,
		std::shared_ptr< Variable >	var_right,
		AMP::Utilities::Backend	backend
	)

inlineexplicit

Constructor.

Parameters

[in]	first_row	Index for first row
[in]	last_row	Index for last row
[in]	first_col	Index for first col
[in]	last_col	Index for last col
[in]	diag	Parameters for diag block
[in]	off_diag	Parameters for offd block
[in]	comm	Communicator for the matrix
[in]	var_left	Variable for left vector
[in]	var_right	Variable for right vector
[in]	backend	Acceleration backend for matrix operations

Definition at line 128 of file RawCSRMatrixParameters.h.

◆ ~RawCSRMatrixParameters()

template<typename Config >

virtual AMP::LinearAlgebra::RawCSRMatrixParameters< Config >::~RawCSRMatrixParameters ( )

virtualdefault

Destructor.

◆ RawCSRMatrixParameters() [6/6]

template<typename Config >

AMP::LinearAlgebra::RawCSRMatrixParameters< Config >::RawCSRMatrixParameters	(	int64_t	fid,
		AMP::IO::RestartManager *	manager
	)

Read restart data from file.

Parameters

fid	File identifier to write
manager	Restart manager

Member Function Documentation

◆ 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.

◆ 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.

◆ 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.

◆ 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.

◆ registerChildObjects()

template<typename Config >

void AMP::LinearAlgebra::RawCSRMatrixParameters< Config >::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()

template<typename Config >

std::string AMP::LinearAlgebra::RawCSRMatrixParameters< Config >::type ( ) const

inlineoverridevirtual

type of this object

Reimplemented from AMP::LinearAlgebra::MatrixParametersBase.

Definition at line 151 of file RawCSRMatrixParameters.h.

◆ writeRestart()

template<typename Config >

void AMP::LinearAlgebra::RawCSRMatrixParameters< Config >::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_diag

template<typename Config >

RawCSRLocalMatrixParameters AMP::LinearAlgebra::RawCSRMatrixParameters< Config >::d_diag

Definition at line 182 of file RawCSRMatrixParameters.h.

◆ d_first_col

template<typename Config >

gidx_t AMP::LinearAlgebra::RawCSRMatrixParameters< Config >::d_first_col

Definition at line 179 of file RawCSRMatrixParameters.h.

◆ d_first_row

template<typename Config >

gidx_t AMP::LinearAlgebra::RawCSRMatrixParameters< Config >::d_first_row

Definition at line 177 of file RawCSRMatrixParameters.h.

◆ 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_last_col

template<typename Config >

gidx_t AMP::LinearAlgebra::RawCSRMatrixParameters< Config >::d_last_col

Definition at line 180 of file RawCSRMatrixParameters.h.

◆ d_last_row

template<typename Config >

gidx_t AMP::LinearAlgebra::RawCSRMatrixParameters< Config >::d_last_row

Definition at line 178 of file RawCSRMatrixParameters.h.

◆ d_off_diag

template<typename Config >

RawCSRLocalMatrixParameters AMP::LinearAlgebra::RawCSRMatrixParameters< Config >::d_off_diag

Definition at line 182 of file RawCSRMatrixParameters.h.

◆ 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/RawCSRMatrixParameters.h

Classes

Public Types

Public Member Functions

Public Attributes

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ gidx_t

◆ lidx_t

◆ scalar_t

Constructor & Destructor Documentation

◆ RawCSRMatrixParameters() [1/6]

◆ RawCSRMatrixParameters() [2/6]

◆ RawCSRMatrixParameters() [3/6]

◆ RawCSRMatrixParameters() [4/6]

◆ RawCSRMatrixParameters() [5/6]

◆ ~RawCSRMatrixParameters()

◆ RawCSRMatrixParameters() [6/6]

Member Function Documentation

◆ getComm()

◆ getID()

◆ getLeftVariable()

◆ getRightVariable()

◆ registerChildObjects()

◆ setLeftVariable()

◆ setRightVariable()

◆ type()

◆ writeRestart()

Member Data Documentation

◆ d_backend

◆ d_comm

◆ d_diag

◆ d_first_col

◆ d_first_row

◆ d_hash

◆ d_last_col

◆ d_last_row

◆ d_off_diag

◆ d_VariableLeft

◆ d_VariableRight