include/opencascade/FEmTool_ElementaryCriterion.hxx

0001 // Created on: 1997-09-11
0002 // Created by: Philippe MANGIN
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_ElementaryCriterion_HeaderFile
0018 #define _FEmTool_ElementaryCriterion_HeaderFile
0019
0020 #include <Standard.hxx>
0021
0022 #include <NCollection_Array2.hxx>
0023 #include <NCollection_HArray2.hxx>
0024 #include <Standard_Real.hxx>
0025 #include <Standard_Transient.hxx>
0026 #include <Standard_Integer.hxx>
0027 #include <math_Vector.hxx>
0028 class math_Matrix;
0029
0030 //! defined J Criteria to used in minimisation
0031 class FEmTool_ElementaryCriterion : public Standard_Transient
0032 {
0033
0034 public:
0035   //! Empty constructor
0036   Standard_EXPORT FEmTool_ElementaryCriterion();
0037
0038   //! Set the coefficient of the Element (the Curve)
0039   Standard_EXPORT void Set(const occ::handle<NCollection_HArray2<double>>& Coeff);
0040
0041   //! Set the definition interval of the Element
0042   Standard_EXPORT virtual void Set(const double FirstKnot, const double LastKnot);
0043
0044   //! To know if two dimension are independent.
0045   Standard_EXPORT virtual occ::handle<NCollection_HArray2<int>> DependenceTable() const = 0;
0046
0047   //! To Compute J(E) where E is the current Element
0048   Standard_EXPORT virtual double Value() = 0;
0049
0050   //! To Compute J(E) the coefficients of Hessian matrix of
0051   //! J(E) which are crossed derivatives in dimensions <Dim1>
0052   //! and <Dim2>.
0053   //! If DependenceTable(Dimension1,Dimension2) is False
0054   Standard_EXPORT virtual void Hessian(const int Dim1, const int Dim2, math_Matrix& H) = 0;
0055
0056   //! To Compute the coefficients in the dimension <dim>
0057   //! of the J(E)'s Gradient where E is the current Element
0058   Standard_EXPORT virtual void Gradient(const int Dim, math_Vector& G) = 0;
0059
0060   DEFINE_STANDARD_RTTIEXT(FEmTool_ElementaryCriterion, Standard_Transient)
0061
0062 protected:
0063   occ::handle<NCollection_HArray2<double>> myCoeff;
0064   double                                   myFirst;
0065   double                                   myLast;
0066 };
0067
0068 #endif // _FEmTool_ElementaryCriterion_HeaderFile