BaseMatrix Class Reference

#include <BaseMatrix.hpp>

Inheritance diagram for BaseMatrix:

[legend]

List of all members.

Public Types
enum	Type { doubleHashedMatrix, sparseMatrix, unAssembled }
Public Member Functions
virtual void	reset ()=0
virtual void	getDiagonal (BaseVector &X) const =0
	used to get the diagonal of the Matrix and stores it in the vector X.
virtual void	transposedTimesX (const BaseVector &X, BaseVector &Z) const =0
	Computes z = A*x+y.
virtual void	timesX (const BaseVector &X, BaseVector &Z) const =0
	Computes z = A*x.
const size_t &	size () const
const BaseMatrix::Type &	type () const
	BaseMatrix (const BaseMatrix::Type t, const size_t &size=0)
	BaseMatrix (const BaseMatrix &B)
virtual	~BaseMatrix ()
Protected Attributes
BaseMatrix::Type	__type
size_t	__size

---

Detailed Description

Definition at line 27 of file BaseMatrix.hpp.

---

Member Enumeration Documentation

enum BaseMatrix::Type

Enumerator:

doubleHashedMatrix
sparseMatrix
unAssembled

Definition at line 30 of file BaseMatrix.hpp.

            {
    doubleHashedMatrix,
    sparseMatrix,
#ifdef    HAVE_PETSC
    petscMatrix,
#endif // HAVE_PETSC
    unAssembled
  };

---

Constructor & Destructor Documentation

BaseMatrix::BaseMatrix	(	const BaseMatrix::Type	t,
		const size_t &	size = 0
	)			[inline]

Definition at line 72 of file BaseMatrix.hpp.

    : __type(t),
      __size(size)
  {
    ;
  }

BaseMatrix::BaseMatrix

(

const BaseMatrix &

B

)

[inline]

Definition at line 80 of file BaseMatrix.hpp.

    : __type(B.__type),
      __size(B.__size)
  {
    ;
  }

virtual BaseMatrix::~BaseMatrix

(

)

[inline, virtual]

Definition at line 87 of file BaseMatrix.hpp.

  {
    ;
  }

---

Member Function Documentation

virtual void BaseMatrix::reset

(

)

[pure virtual]

Sets the matrix to zero

Implemented in DoubleHashedMatrix, SparseMatrix, and UnAssembledMatrix.

Referenced by SpectralLegendreDiscretizationConform::getMultiDiagonal().

virtual void BaseMatrix::getDiagonal

(

BaseVector &

X

)

const [pure virtual]

used to get the diagonal of the Matrix and stores it in the vector X.

Implemented in DoubleHashedMatrix, SparseMatrix, and UnAssembledMatrix.

Referenced by DiagPrecond::initializes().

virtual void BaseMatrix::transposedTimesX	(	const BaseVector &	X,
		BaseVector &	Z
	)			const [pure virtual]

Computes z = A*x+y.

Implemented in DoubleHashedMatrix, SparseMatrix, and UnAssembledMatrix.

virtual void BaseMatrix::timesX	(	const BaseVector &	X,
		BaseVector &	Z
	)			const [pure virtual]

Computes z = A*x.

Implemented in DoubleHashedMatrix, SparseMatrix, and UnAssembledMatrix.

const size_t& BaseMatrix::size

(

)

const [inline]

Definition at line 62 of file BaseMatrix.hpp.

References __size.

Referenced by IncompleteCholeskiFactorization::computes(), SparseMatrix::copyProfile(), SparseMatrix::getDiagonal(), IncompleteCholeskiFactorization::initializes(), DiagPrecond::initializes(), SparseMatrix::operator()(), and SparseMatrix::transposedTimesX().

  {
    return __size; 
  }

const BaseMatrix::Type& BaseMatrix::type

(

)

const [inline]

Definition at line 67 of file BaseMatrix.hpp.

References __type.

Referenced by FEMDiscretization< Structured3DMesh, TypeOfDiscretization >::assembleMatrix(), IncompleteCholeskiFactorization::IncompleteCholeskiFactorization(), and KrylovSolverDim().

  {
    return __type; 
  }

---

Member Data Documentation

BaseMatrix::Type BaseMatrix::__type [protected]

Definition at line 40 of file BaseMatrix.hpp.

Referenced by type().

size_t BaseMatrix::__size [protected]

Definition at line 42 of file BaseMatrix.hpp.

Referenced by SparseMatrix::copyProfile(), SparseMatrix::line(), SparseMatrix::operator*(), SparseMatrix::reset(), size(), SparseMatrix::SparseMatrix(), and SparseMatrix::transposedTimesX().

---

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

• BaseMatrix.hpp