MFEM v4.7.0
Finite element discretization library
Loading...
Searching...
No Matches
mfem::DenseSymmetricMatrix Class Reference

#include <symmat.hpp>

Inheritance diagram for mfem::DenseSymmetricMatrix:
[legend]
Collaboration diagram for mfem::DenseSymmetricMatrix:
[legend]

Public Member Functions

 DenseSymmetricMatrix ()
 
 DenseSymmetricMatrix (int s)
 Creates square matrix of size s.
 
 DenseSymmetricMatrix (real_t *d, int s)
 Construct a DenseSymmetricMatrix using an existing data array.
 
void UseExternalData (real_t *d, int s)
 Change the data array and the size of the DenseSymmetricMatrix.
 
void Reset (real_t *d, int s)
 Change the data array and the size of the DenseSymmetricMatrix.
 
void ClearExternalData ()
 
void Clear ()
 Delete the matrix data array (if owned) and reset the matrix state.
 
void SetSize (int s)
 Change the size of the DenseSymmetricMatrix to s x s.
 
int GetStoredSize () const
 Return the number of stored nonzeros in the matrix.
 
real_tData () const
 Returns the matrix data array.
 
real_tGetData () const
 Returns the matrix data array.
 
Memory< real_t > & GetMemory ()
 
const Memory< real_t > & GetMemory () const
 
bool OwnsData () const
 Return the DenseSymmetricMatrix data (host pointer) ownership flag.
 
real_toperator() (int i, int j)
 Returns reference to a_{ij}.
 
const real_toperator() (int i, int j) const
 Returns constant reference to a_{ij}.
 
virtual real_tElem (int i, int j)
 Returns reference to a_{ij}.
 
virtual const real_tElem (int i, int j) const
 Returns constant reference to a_{ij}.
 
DenseSymmetricMatrixoperator= (real_t c)
 Sets the matrix elements equal to constant c.
 
DenseSymmetricMatrixoperator*= (real_t c)
 
std::size_t MemoryUsage () const
 
const real_tRead (bool on_dev=true) const
 Shortcut for mfem::Read( GetMemory(), TotalSize(), on_dev).
 
const real_tHostRead () const
 Shortcut for mfem::Read(GetMemory(), TotalSize(), false).
 
real_tWrite (bool on_dev=true)
 Shortcut for mfem::Write(GetMemory(), TotalSize(), on_dev).
 
real_tHostWrite ()
 Shortcut for mfem::Write(GetMemory(), TotalSize(), false).
 
real_tReadWrite (bool on_dev=true)
 Shortcut for mfem::ReadWrite(GetMemory(), TotalSize(), on_dev).
 
real_tHostReadWrite ()
 Shortcut for mfem::ReadWrite(GetMemory(), TotalSize(), false).
 
virtual void Mult (const Vector &x, Vector &y) const
 Matrix vector multiplication.
 
virtual MatrixInverseInverse () const
 Returns a pointer to (an approximation) of the matrix inverse.
 
virtual void Print (std::ostream &out=mfem::out, int width_=4) const
 Prints matrix to stream out.
 
virtual ~DenseSymmetricMatrix ()
 Destroys the symmetric matrix.
 
- Public Member Functions inherited from mfem::Matrix
 Matrix (int s)
 Creates a square matrix of size s.
 
 Matrix (int h, int w)
 Creates a matrix of the given height and width.
 
bool IsSquare () const
 Returns whether the matrix is a square matrix.
 
virtual void Finalize (int)
 Finalizes the matrix initialization.
 
virtual ~Matrix ()
 Destroys matrix.
 
- Public Member Functions inherited from mfem::Operator
void InitTVectors (const Operator *Po, const Operator *Ri, const Operator *Pi, Vector &x, Vector &b, Vector &X, Vector &B) const
 Initializes memory for true vectors of linear system.
 
 Operator (int s=0)
 Construct a square Operator with given size s (default 0).
 
 Operator (int h, int w)
 Construct an Operator with the given height (output size) and width (input size).
 
int Height () const
 Get the height (size of output) of the Operator. Synonym with NumRows().
 
int NumRows () const
 Get the number of rows (size of output) of the Operator. Synonym with Height().
 
int Width () const
 Get the width (size of input) of the Operator. Synonym with NumCols().
 
int NumCols () const
 Get the number of columns (size of input) of the Operator. Synonym with Width().
 
virtual MemoryClass GetMemoryClass () const
 Return the MemoryClass preferred by the Operator.
 
virtual void MultTranspose (const Vector &x, Vector &y) const
 Action of the transpose operator: y=A^t(x). The default behavior in class Operator is to generate an error.
 
virtual void AddMult (const Vector &x, Vector &y, const real_t a=1.0) const
 Operator application: y+=A(x) (default) or y+=a*A(x).
 
virtual void AddMultTranspose (const Vector &x, Vector &y, const real_t a=1.0) const
 Operator transpose application: y+=A^t(x) (default) or y+=a*A^t(x).
 
virtual void ArrayMult (const Array< const Vector * > &X, Array< Vector * > &Y) const
 Operator application on a matrix: Y=A(X).
 
virtual void ArrayMultTranspose (const Array< const Vector * > &X, Array< Vector * > &Y) const
 Action of the transpose operator on a matrix: Y=A^t(X).
 
virtual void ArrayAddMult (const Array< const Vector * > &X, Array< Vector * > &Y, const real_t a=1.0) const
 Operator application on a matrix: Y+=A(X) (default) or Y+=a*A(X).
 
virtual void ArrayAddMultTranspose (const Array< const Vector * > &X, Array< Vector * > &Y, const real_t a=1.0) const
 Operator transpose application on a matrix: Y+=A^t(X) (default) or Y+=a*A^t(X).
 
virtual OperatorGetGradient (const Vector &x) const
 Evaluate the gradient operator at the point x. The default behavior in class Operator is to generate an error.
 
virtual void AssembleDiagonal (Vector &diag) const
 Computes the diagonal entries into diag. Typically, this operation only makes sense for linear Operators. In some cases, only an approximation of the diagonal is computed.
 
virtual const OperatorGetProlongation () const
 Prolongation operator from linear algebra (linear system) vectors, to input vectors for the operator. NULL means identity.
 
virtual const OperatorGetRestriction () const
 Restriction operator from input vectors for the operator to linear algebra (linear system) vectors. NULL means identity.
 
virtual const OperatorGetOutputProlongation () const
 Prolongation operator from linear algebra (linear system) vectors, to output vectors for the operator. NULL means identity.
 
virtual const OperatorGetOutputRestrictionTranspose () const
 Transpose of GetOutputRestriction, directly available in this form to facilitate matrix-free RAP-type operators.
 
virtual const OperatorGetOutputRestriction () const
 Restriction operator from output vectors for the operator to linear algebra (linear system) vectors. NULL means identity.
 
void FormLinearSystem (const Array< int > &ess_tdof_list, Vector &x, Vector &b, Operator *&A, Vector &X, Vector &B, int copy_interior=0)
 Form a constrained linear system using a matrix-free approach.
 
void FormRectangularLinearSystem (const Array< int > &trial_tdof_list, const Array< int > &test_tdof_list, Vector &x, Vector &b, Operator *&A, Vector &X, Vector &B)
 Form a column-constrained linear system using a matrix-free approach.
 
virtual void RecoverFEMSolution (const Vector &X, const Vector &b, Vector &x)
 Reconstruct a solution vector x (e.g. a GridFunction) from the solution X of a constrained linear system obtained from Operator::FormLinearSystem() or Operator::FormRectangularLinearSystem().
 
void FormSystemOperator (const Array< int > &ess_tdof_list, Operator *&A)
 Return in A a parallel (on truedofs) version of this square operator.
 
void FormRectangularSystemOperator (const Array< int > &trial_tdof_list, const Array< int > &test_tdof_list, Operator *&A)
 Return in A a parallel (on truedofs) version of this rectangular operator (including constraints).
 
void FormDiscreteOperator (Operator *&A)
 Return in A a parallel (on truedofs) version of this rectangular operator.
 
void PrintMatlab (std::ostream &out, int n, int m=0) const
 Prints operator with input size n and output size m in Matlab format.
 
virtual void PrintMatlab (std::ostream &out) const
 Prints operator in Matlab format.
 
virtual ~Operator ()
 Virtual destructor.
 
Type GetType () const
 Return the type ID of the Operator class.
 

Additional Inherited Members

- Public Types inherited from mfem::Operator
enum  DiagonalPolicy { DIAG_ZERO , DIAG_ONE , DIAG_KEEP }
 Defines operator diagonal policy upon elimination of rows and/or columns. More...
 
enum  Type {
  ANY_TYPE , MFEM_SPARSEMAT , Hypre_ParCSR , PETSC_MATAIJ ,
  PETSC_MATIS , PETSC_MATSHELL , PETSC_MATNEST , PETSC_MATHYPRE ,
  PETSC_MATGENERIC , Complex_Operator , MFEM_ComplexSparseMat , Complex_Hypre_ParCSR ,
  Complex_DenseMat , MFEM_Block_Matrix , MFEM_Block_Operator
}
 Enumeration defining IDs for some classes derived from Operator. More...
 
- Protected Member Functions inherited from mfem::Operator
void FormConstrainedSystemOperator (const Array< int > &ess_tdof_list, ConstrainedOperator *&Aout)
 see FormSystemOperator()
 
void FormRectangularConstrainedSystemOperator (const Array< int > &trial_tdof_list, const Array< int > &test_tdof_list, RectangularConstrainedOperator *&Aout)
 see FormRectangularSystemOperator()
 
OperatorSetupRAP (const Operator *Pi, const Operator *Po)
 Returns RAP Operator of this, using input/output Prolongation matrices Pi corresponds to "P", Po corresponds to "Rt".
 
- Protected Attributes inherited from mfem::Operator
int height
 Dimension of the output / number of rows in the matrix.
 
int width
 Dimension of the input / number of columns in the matrix.
 

Detailed Description

Dense symmetric matrix storing the upper triangular part. This class so far has little functionality beyond storage.

Definition at line 24 of file symmat.hpp.

Constructor & Destructor Documentation

◆ DenseSymmetricMatrix() [1/3]

mfem::DenseSymmetricMatrix::DenseSymmetricMatrix ( )

Default constructor for DenseSymmetricMatrix. Sets data = NULL and height = width = 0.

Definition at line 20 of file symmat.cpp.

◆ DenseSymmetricMatrix() [2/3]

mfem::DenseSymmetricMatrix::DenseSymmetricMatrix ( int s)
explicit

Creates square matrix of size s.

Definition at line 22 of file symmat.cpp.

◆ DenseSymmetricMatrix() [3/3]

mfem::DenseSymmetricMatrix::DenseSymmetricMatrix ( real_t * d,
int s )
inline

Construct a DenseSymmetricMatrix using an existing data array.

The DenseSymmetricMatrix does not assume ownership of the data array, i.e. it will not delete the array.

Definition at line 41 of file symmat.hpp.

◆ ~DenseSymmetricMatrix()

mfem::DenseSymmetricMatrix::~DenseSymmetricMatrix ( )
virtual

Destroys the symmetric matrix.

Definition at line 97 of file symmat.cpp.

Member Function Documentation

◆ Clear()

void mfem::DenseSymmetricMatrix::Clear ( )
inline

Delete the matrix data array (if owned) and reset the matrix state.

Definition at line 66 of file symmat.hpp.

◆ ClearExternalData()

void mfem::DenseSymmetricMatrix::ClearExternalData ( )
inline

Clear the data array and the dimensions of the DenseSymmetricMatrix. This method should not be used with DenseSymmetricMatrix that owns its current data array.

Definition at line 63 of file symmat.hpp.

◆ Data()

real_t * mfem::DenseSymmetricMatrix::Data ( ) const
inline

Returns the matrix data array.

Definition at line 76 of file symmat.hpp.

◆ Elem() [1/2]

real_t & mfem::DenseSymmetricMatrix::Elem ( int i,
int j )
virtual

Returns reference to a_{ij}.

Implements mfem::Matrix.

Definition at line 61 of file symmat.cpp.

◆ Elem() [2/2]

const real_t & mfem::DenseSymmetricMatrix::Elem ( int i,
int j ) const
virtual

Returns constant reference to a_{ij}.

Implements mfem::Matrix.

Definition at line 66 of file symmat.cpp.

◆ GetData()

real_t * mfem::DenseSymmetricMatrix::GetData ( ) const
inline

Returns the matrix data array.

Definition at line 80 of file symmat.hpp.

◆ GetMemory() [1/2]

Memory< real_t > & mfem::DenseSymmetricMatrix::GetMemory ( )
inline

Definition at line 82 of file symmat.hpp.

◆ GetMemory() [2/2]

const Memory< real_t > & mfem::DenseSymmetricMatrix::GetMemory ( ) const
inline

Definition at line 83 of file symmat.hpp.

◆ GetStoredSize()

int mfem::DenseSymmetricMatrix::GetStoredSize ( ) const
inline

Return the number of stored nonzeros in the matrix.

Definition at line 73 of file symmat.hpp.

◆ HostRead()

const real_t * mfem::DenseSymmetricMatrix::HostRead ( ) const
inline

Shortcut for mfem::Read(GetMemory(), TotalSize(), false).

Definition at line 112 of file symmat.hpp.

◆ HostReadWrite()

real_t * mfem::DenseSymmetricMatrix::HostReadWrite ( )
inline

Shortcut for mfem::ReadWrite(GetMemory(), TotalSize(), false).

Definition at line 128 of file symmat.hpp.

◆ HostWrite()

real_t * mfem::DenseSymmetricMatrix::HostWrite ( )
inline

Shortcut for mfem::Write(GetMemory(), TotalSize(), false).

Definition at line 120 of file symmat.hpp.

◆ Inverse()

MatrixInverse * mfem::DenseSymmetricMatrix::Inverse ( ) const
virtual

Returns a pointer to (an approximation) of the matrix inverse.

Implements mfem::Matrix.

Definition at line 86 of file symmat.cpp.

◆ MemoryUsage()

std::size_t mfem::DenseSymmetricMatrix::MemoryUsage ( ) const
inline

Definition at line 105 of file symmat.hpp.

◆ Mult()

void mfem::DenseSymmetricMatrix::Mult ( const Vector & x,
Vector & y ) const
virtual

Matrix vector multiplication.

Implements mfem::Operator.

Definition at line 81 of file symmat.cpp.

◆ operator()() [1/2]

real_t & mfem::DenseSymmetricMatrix::operator() ( int i,
int j )
inline

Returns reference to a_{ij}.

Definition at line 150 of file symmat.hpp.

◆ operator()() [2/2]

const real_t & mfem::DenseSymmetricMatrix::operator() ( int i,
int j ) const
inline

Returns constant reference to a_{ij}.

Definition at line 163 of file symmat.hpp.

◆ operator*=()

DenseSymmetricMatrix & mfem::DenseSymmetricMatrix::operator*= ( real_t c)

Definition at line 71 of file symmat.cpp.

◆ operator=()

DenseSymmetricMatrix & mfem::DenseSymmetricMatrix::operator= ( real_t c)

Sets the matrix elements equal to constant c.

Definition at line 51 of file symmat.cpp.

◆ OwnsData()

bool mfem::DenseSymmetricMatrix::OwnsData ( ) const
inline

Return the DenseSymmetricMatrix data (host pointer) ownership flag.

Definition at line 86 of file symmat.hpp.

◆ Print()

void mfem::DenseSymmetricMatrix::Print ( std::ostream & out = mfem::out,
int width_ = 4 ) const
virtual

Prints matrix to stream out.

Reimplemented from mfem::Matrix.

Definition at line 92 of file symmat.cpp.

◆ Read()

const real_t * mfem::DenseSymmetricMatrix::Read ( bool on_dev = true) const
inline

Shortcut for mfem::Read( GetMemory(), TotalSize(), on_dev).

Definition at line 108 of file symmat.hpp.

◆ ReadWrite()

real_t * mfem::DenseSymmetricMatrix::ReadWrite ( bool on_dev = true)
inline

Shortcut for mfem::ReadWrite(GetMemory(), TotalSize(), on_dev).

Definition at line 124 of file symmat.hpp.

◆ Reset()

void mfem::DenseSymmetricMatrix::Reset ( real_t * d,
int s )
inline

Change the data array and the size of the DenseSymmetricMatrix.

The DenseSymmetricMatrix does not assume ownership of the data array, i.e. it will not delete the new array d. This method will delete the current data array, if owned.

Definition at line 58 of file symmat.hpp.

◆ SetSize()

void mfem::DenseSymmetricMatrix::SetSize ( int s)

Change the size of the DenseSymmetricMatrix to s x s.

Definition at line 32 of file symmat.cpp.

◆ UseExternalData()

void mfem::DenseSymmetricMatrix::UseExternalData ( real_t * d,
int s )
inline

Change the data array and the size of the DenseSymmetricMatrix.

The DenseSymmetricMatrix does not assume ownership of the data array, i.e. it will not delete the data array d. This method should not be used with DenseSymmetricMatrix that owns its current data array.

Definition at line 48 of file symmat.hpp.

◆ Write()

real_t * mfem::DenseSymmetricMatrix::Write ( bool on_dev = true)
inline

Shortcut for mfem::Write(GetMemory(), TotalSize(), on_dev).

Definition at line 116 of file symmat.hpp.


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