Open CASCADE Technology  7.4.1.dev
Public Member Functions
FEmTool_SparseMatrix Class Referenceabstract

Sparse Matrix definition. More...

#include <FEmTool_SparseMatrix.hxx>

Inheritance diagram for FEmTool_SparseMatrix:
Inheritance graph
[legend]

Public Member Functions

virtual void Init (const Standard_Real Value)=0
 
virtual Standard_RealChangeValue (const Standard_Integer I, const Standard_Integer J)=0
 
virtual Standard_Boolean Decompose ()=0
 To make a Factorization of <me> More...
 
virtual void Solve (const math_Vector &B, math_Vector &X) const =0
 Direct Solve of AX = B. More...
 
virtual Standard_Boolean Prepare ()=0
 Make Preparation to iterative solve. More...
 
virtual 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 =0
 Iterative solve of AX = B. More...
 
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 More...
 
virtual Standard_Integer RowNumber () const =0
 returns the row range of a matrix. More...
 
virtual Standard_Integer ColNumber () const =0
 returns the column range of the matrix. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
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. More...
 
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. More...
 
Standard_TransientThis () 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. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Additional Inherited Members

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

Detailed Description

Sparse Matrix definition.

Member Function Documentation

◆ ChangeValue()

virtual Standard_Real& FEmTool_SparseMatrix::ChangeValue ( const Standard_Integer  I,
const Standard_Integer  J 
)
pure virtual

Implemented in FEmTool_ProfileMatrix.

◆ ColNumber()

virtual Standard_Integer FEmTool_SparseMatrix::ColNumber ( ) const
pure virtual

returns the column range of the matrix.

Implemented in FEmTool_ProfileMatrix.

◆ Decompose()

virtual Standard_Boolean FEmTool_SparseMatrix::Decompose ( )
pure virtual

To make a Factorization of <me>

Implemented in FEmTool_ProfileMatrix.

◆ Init()

virtual void FEmTool_SparseMatrix::Init ( const Standard_Real  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 Standard_Boolean FEmTool_SparseMatrix::Prepare ( )
pure virtual

Make Preparation to iterative solve.

Implemented in FEmTool_ProfileMatrix.

◆ RowNumber()

virtual Standard_Integer 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,
math_Vector X 
) const
pure virtual

Direct Solve of AX = B.

Implemented in FEmTool_ProfileMatrix.

◆ Solve() [2/2]

virtual void FEmTool_SparseMatrix::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
pure virtual

Iterative solve of AX = B.

Implemented in FEmTool_ProfileMatrix.


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