include/opencascade/FEmTool_SparseMatrix.hxx

0001 // Created on: 1997-10-29
0002 // Created by: Roman BORISOV
0003 // Copyright (c) 1997-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _FEmTool_SparseMatrix_HeaderFile
0018 #define _FEmTool_SparseMatrix_HeaderFile
0019
0020 #include <Standard.hxx>
0021
0022 #include <Standard_Transient.hxx>
0023 #include <Standard_Real.hxx>
0024 #include <Standard_Integer.hxx>
0025 #include <math_Vector.hxx>
0026
0027 class FEmTool_SparseMatrix;
0028 DEFINE_STANDARD_HANDLE(FEmTool_SparseMatrix, Standard_Transient)
0029
0030 //! Sparse Matrix definition
0031 class FEmTool_SparseMatrix : public Standard_Transient
0032 {
0033
0034 public:
0035   Standard_EXPORT virtual void Init(const Standard_Real Value) = 0;
0036
0037   Standard_EXPORT virtual Standard_Real& ChangeValue(const Standard_Integer I,
0038                                                      const Standard_Integer J) = 0;
0039
0040   //! To make a Factorization of <me>
0041   Standard_EXPORT virtual Standard_Boolean Decompose() = 0;
0042
0043   //! Direct Solve of AX = B
0044   Standard_EXPORT virtual void Solve(const math_Vector& B, math_Vector& X) const = 0;
0045
0046   //! Make Preparation to iterative solve
0047   Standard_EXPORT virtual Standard_Boolean Prepare() = 0;
0048
0049   //! Iterative solve  of AX = B
0050   Standard_EXPORT virtual void Solve(const math_Vector&     B,
0051                                      const math_Vector&     Init,
0052                                      math_Vector&           X,
0053                                      math_Vector&           Residual,
0054                                      const Standard_Real    Tolerance    = 1.0e-8,
0055                                      const Standard_Integer NbIterations = 50) const = 0;
0056
0057   //! returns the product of a SparseMatrix by a vector.
0058   //! An exception is raised if the dimensions are different
0059   Standard_EXPORT virtual void Multiplied(const math_Vector& X, math_Vector& MX) const = 0;
0060
0061   //! returns the row range of a matrix.
0062   Standard_EXPORT virtual Standard_Integer RowNumber() const = 0;
0063
0064   //! returns the column range of the matrix.
0065   Standard_EXPORT virtual Standard_Integer ColNumber() const = 0;
0066
0067   DEFINE_STANDARD_RTTIEXT(FEmTool_SparseMatrix, Standard_Transient)
0068
0069 protected:
0070 private:
0071 };
0072
0073 #endif // _FEmTool_SparseMatrix_HeaderFile