FEmTool_ProfileMatrix Class Reference

Symmetric Sparse ProfileMatrix useful for 1D Finite Element methods. More...

#include <FEmTool_ProfileMatrix.hxx>

Inheritance diagram for FEmTool_ProfileMatrix:

Public Member Functions
	FEmTool_ProfileMatrix (const TColStd_Array1OfInteger &FirstIndexes)
void	Init (const Standard_Real Value) override
Standard_Real &	ChangeValue (const Standard_Integer I, const Standard_Integer J) override
Standard_Boolean	Decompose () override
	To make a Factorization of <me>
void	Solve (const math_Vector &B, math_Vector &X) const override
	Direct Solve of AX = B.
Standard_Boolean	Prepare () override
	Make Preparation to iterative solve.
void	Solve (const math_Vector &B, const math_Vector &Init, math_Vector &X, math_Vector &Residual, const Standard_Real Tolerance=1.0e-8, const Standard_Integer NbIterations=50) const override
	Iterative solve of AX = B.
void	Multiplied (const math_Vector &X, math_Vector &MX) const override
	returns the product of a SparseMatrix by a vector. An exception is raised if the dimensions are different
Standard_Integer	RowNumber () const override
	returns the row range of a matrix.
Standard_Integer	ColNumber () const override
	returns the column range of the matrix.
Standard_Boolean	IsInProfile (const Standard_Integer i, const Standard_Integer j) const
void	OutM () const
void	OutS () const
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 ()
	Destructor must be virtual.
virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.
Standard_Boolean	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.
Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName.
Standard_Boolean	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.
Standard_Boolean	IsKind (const Standard_CString 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.
Standard_Integer	GetRefCount () const noexcept
	Get the reference counter of this object.
void	IncrementRefCounter () noexcept
	Increments the reference counter of this object.
Standard_Integer	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value.
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

Symmetric Sparse ProfileMatrix useful for 1D Finite Element methods.

Constructor & Destructor Documentation

FEmTool_ProfileMatrix()

FEmTool_ProfileMatrix::FEmTool_ProfileMatrix

(

const TColStd_Array1OfInteger &

FirstIndexes

)

Member Function Documentation

ChangeValue()

Standard_Real & FEmTool_ProfileMatrix::ChangeValue ( const Standard_Integer  I, const Standard_Integer  J  )

overridevirtual

Implements FEmTool_SparseMatrix.

ColNumber()

Standard_Integer FEmTool_ProfileMatrix::ColNumber ( ) const

overridevirtual

returns the column range of the matrix.

Implements FEmTool_SparseMatrix.

Decompose()

Standard_Boolean FEmTool_ProfileMatrix::Decompose ( )

overridevirtual

To make a Factorization of <me>

Implements FEmTool_SparseMatrix.

Init()

void FEmTool_ProfileMatrix::Init ( const Standard_Real  Value )

overridevirtual

Implements FEmTool_SparseMatrix.

IsInProfile()

Standard_Boolean FEmTool_ProfileMatrix::IsInProfile	(	const Standard_Integer	i,
		const Standard_Integer	j
	)		const

Multiplied()

void FEmTool_ProfileMatrix::Multiplied ( const math_Vector &  X, math_Vector &  MX  ) const

overridevirtual

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

Implements FEmTool_SparseMatrix.

OutM()

void FEmTool_ProfileMatrix::OutM

(

)

const

OutS()

void FEmTool_ProfileMatrix::OutS

(

)

const

Prepare()

Standard_Boolean FEmTool_ProfileMatrix::Prepare ( )

overridevirtual

Make Preparation to iterative solve.

Implements FEmTool_SparseMatrix.

RowNumber()

Standard_Integer FEmTool_ProfileMatrix::RowNumber ( ) const

overridevirtual

returns the row range of a matrix.

Implements FEmTool_SparseMatrix.

Solve() [1/2]

void FEmTool_ProfileMatrix::Solve ( const math_Vector &  B, const math_Vector &  Init, math_Vector &  X, math_Vector &  Residual, const Standard_Real  Tolerance = 1.0e-8, const Standard_Integer  NbIterations = 50  ) const

overridevirtual

Iterative solve of AX = B.

Implements FEmTool_SparseMatrix.

Solve() [2/2]

void FEmTool_ProfileMatrix::Solve ( const math_Vector &  B, math_Vector &  X  ) const

overridevirtual

Direct Solve of AX = B.

Implements FEmTool_SparseMatrix.

---

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

• FEmTool_ProfileMatrix.hxx