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 <TColStd_HArray2OfReal.hxx>
0023 #include <Standard_Real.hxx>
0024 #include <Standard_Transient.hxx>
0025 #include <TColStd_HArray2OfInteger.hxx>
0026 #include <Standard_Integer.hxx>
0027 #include <math_Vector.hxx>
0028 class math_Matrix;
0029
0030
0031 class FEmTool_ElementaryCriterion;
0032 DEFINE_STANDARD_HANDLE(FEmTool_ElementaryCriterion, Standard_Transient)
0033
0034 //! defined J Criteria to used in minimisation
0035 class FEmTool_ElementaryCriterion : public Standard_Transient
0036 {
0037
0038 public:
0039   //! Empty constructor
0040   Standard_EXPORT FEmTool_ElementaryCriterion();
0041
0042   //! Set the coefficient of the Element (the  Curve)
0043   Standard_EXPORT void Set (const Handle(TColStd_HArray2OfReal)& Coeff);
0044
0045   //! Set the definition interval of the Element
0046   Standard_EXPORT virtual void Set (const Standard_Real FirstKnot, const Standard_Real LastKnot);
0047
0048   //! To know if two dimension are independent.
0049   Standard_EXPORT virtual Handle(TColStd_HArray2OfInteger) DependenceTable() const = 0;
0050
0051   //! To Compute J(E) where E  is the current Element
0052   Standard_EXPORT virtual Standard_Real Value() = 0;
0053
0054   //! To Compute J(E)  the coefficients of Hessian matrix of
0055   //! J(E) which are crossed derivatives in dimensions <Dim1>
0056   //! and  <Dim2>.
0057   //! If DependenceTable(Dimension1,Dimension2) is False
0058   Standard_EXPORT virtual void Hessian (const Standard_Integer Dim1, const Standard_Integer Dim2, math_Matrix& H) = 0;
0059
0060   //! To Compute the  coefficients in the dimension <dim>
0061   //! of  the  J(E)'s  Gradient where E  is  the current  Element
0062   Standard_EXPORT virtual void Gradient (const Standard_Integer Dim, math_Vector& G) = 0;
0063
0064
0065
0066
0067   DEFINE_STANDARD_RTTIEXT(FEmTool_ElementaryCriterion,Standard_Transient)
0068
0069 protected:
0070
0071
0072   Handle(TColStd_HArray2OfReal) myCoeff;
0073   Standard_Real myFirst;
0074   Standard_Real myLast;
0075
0076
0077 private:
0078
0079
0080
0081
0082 };
0083
0084
0085
0086
0087
0088
0089
0090 #endif // _FEmTool_ElementaryCriterion_HeaderFile