FEmTool_SparseMatrix Class Reference

Sparse Matrix definition. More...

#include <FEmTool_SparseMatrix.hxx>

Inheritance diagram for FEmTool_SparseMatrix:

Public Member Functions
virtual void	Init (const double Value)=0
virtual double &	ChangeValue (const int I, const int J)=0
virtual bool	Decompose ()=0
	To make a Factorization of <me>
virtual void	Solve (const math_Vector &B, math_Vector &X) const =0
	Direct Solve of AX = B.
virtual bool	Prepare ()=0
	Make Preparation to iterative solve.
virtual void	Solve (const math_Vector &B, const math_Vector &Init, math_Vector &X, math_Vector &Residual, const double Tolerance=1.0e-8, const int NbIterations=50) const =0
	Iterative solve of AX = B.
virtual void	Multiplied (const math_Vector &X, math_Vector &MX) const =0
	returns the product of a SparseMatrix by a vector. An exception is raised if the dimensions are different
virtual int	RowNumber () const =0
	returns the row range of a matrix.
virtual int	ColNumber () const =0
	returns the column range of the matrix.
Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.
	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.
Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.
virtual	~Standard_Transient ()=default
	Destructor must be virtual.
virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.
bool	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.
bool	IsInstance (const char *const theTypeName) const
	Returns a true value if this is an instance of TypeName.
bool	IsKind (const opencascade::handle< Standard_Type > &theType) const
	Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
bool	IsKind (const char *const theTypeName) const
	Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
Standard_Transient *	This () const
	Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
int	GetRefCount () const noexcept
	Get the reference counter of this object.
void	IncrementRefCounter () noexcept
	Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.
int	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.
virtual void	Delete () const
	Memory deallocator for transient classes.

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.
Static Public Member Functions inherited from Standard_Transient
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.
static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.

Detailed Description

Sparse Matrix definition.

Member Function Documentation

ChangeValue()

virtual double & FEmTool_SparseMatrix::ChangeValue ( const int I, const int J )

pure virtual

Implemented in FEmTool_ProfileMatrix.

ColNumber()

virtual int FEmTool_SparseMatrix::ColNumber ( ) const

pure virtual

returns the column range of the matrix.

Implemented in FEmTool_ProfileMatrix.

Decompose()

virtual bool FEmTool_SparseMatrix::Decompose ( )

pure virtual

To make a Factorization of <me>

Implemented in FEmTool_ProfileMatrix.

Init()

virtual void FEmTool_SparseMatrix::Init ( const double Value )

pure virtual

Implemented in FEmTool_ProfileMatrix.

Multiplied()

virtual void FEmTool_SparseMatrix::Multiplied ( const math_Vector & X, math_Vector & MX ) const

pure virtual

returns the product of a SparseMatrix by a vector. An exception is raised if the dimensions are different

Implemented in FEmTool_ProfileMatrix.

Prepare()

virtual bool FEmTool_SparseMatrix::Prepare ( )

pure virtual

Make Preparation to iterative solve.

Implemented in FEmTool_ProfileMatrix.

RowNumber()

virtual int FEmTool_SparseMatrix::RowNumber ( ) const

pure virtual

returns the row range of a matrix.

Implemented in FEmTool_ProfileMatrix.

Solve() [1/2]

virtual void FEmTool_SparseMatrix::Solve ( const math_Vector & B, const math_Vector & Init, math_Vector & X, math_Vector & Residual, const double Tolerance = 1.0e-8, const int NbIterations = 50 ) const

pure virtual

Iterative solve of AX = B.

Implemented in FEmTool_ProfileMatrix.

Solve() [2/2]

virtual void FEmTool_SparseMatrix::Solve ( const math_Vector & B, math_Vector & X ) const

pure virtual

Direct Solve of AX = B.

Implemented in FEmTool_ProfileMatrix.

---

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

• FEmTool_SparseMatrix.hxx