include/opencascade/Extrema_FuncPSNorm.hxx

0001 // Created on: 1991-07-24
0002 // Created by: Michel CHAUVAT
0003 // Copyright (c) 1991-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 _Extrema_FunctPSNorm_HeaderFile
0018 #define _Extrema_FunctPSNorm_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022
0023 #include <gp_Pnt.hxx>
0024 #include <TColStd_SequenceOfReal.hxx>
0025 #include <Extrema_SequenceOfPOnSurf.hxx>
0026 #include <Standard_Boolean.hxx>
0027 #include <math_FunctionSetWithDerivatives.hxx>
0028 #include <math_Vector.hxx>
0029
0030 class Adaptor3d_Surface;
0031 class math_Matrix;
0032 class Extrema_POnSurf;
0033
0034
0035
0036 //! Functional for search of extremum of the distance between point P and
0037 //! surface S, starting from approximate solution (u0, v0).
0038 //!
0039 //! The class inherits math_FunctionSetWithDerivatives and thus is intended
0040 //! for use in math_FunctionSetRoot algorithm .
0041 //!
0042 //! Denoting derivatives of the surface S(u,v) by u and v, respectively, as
0043 //! Su and Sv, the two functions to be nullified are:
0044 //!
0045 //! F1(u,v) = (S - P) * Su
0046 //! F2(u,v) = (S - P) * Sv
0047 //!
0048 //! The derivatives of the functional are:
0049 //!
0050 //! Duf1(u,v) = Su^2    + (S-P) * Suu;
0051 //! Dvf1(u,v) = Su * Sv + (S-P) * Suv
0052 //! Duf2(u,v) = Sv * Su + (S-P) * Suv = Dvf1
0053 //! Dvf2(u,v) = Sv^2    + (S-P) * Svv
0054 //!
0055 //! Here * denotes scalar product, and ^2 is square power.
0056 class Extrema_FuncPSNorm  : public math_FunctionSetWithDerivatives
0057 {
0058 public:
0059
0060   DEFINE_STANDARD_ALLOC
0061
0062
0063   Standard_EXPORT Extrema_FuncPSNorm();
0064
0065   Standard_EXPORT Extrema_FuncPSNorm(const gp_Pnt& P, const Adaptor3d_Surface& S);
0066
0067   //! sets the field mysurf of the function.
0068   Standard_EXPORT void Initialize (const Adaptor3d_Surface& S);
0069
0070   //! sets the field mysurf of the function.
0071   Standard_EXPORT void SetPoint (const gp_Pnt& P);
0072
0073   Standard_EXPORT Standard_Integer NbVariables() const Standard_OVERRIDE;
0074
0075   Standard_EXPORT Standard_Integer NbEquations() const Standard_OVERRIDE;
0076
0077   //! Calculate Fi(U,V).
0078   Standard_EXPORT Standard_Boolean Value (const math_Vector& UV, math_Vector& F) Standard_OVERRIDE;
0079
0080   //! Calculate Fi'(U,V).
0081   Standard_EXPORT Standard_Boolean Derivatives (const math_Vector& UV, math_Matrix& DF) Standard_OVERRIDE;
0082
0083   //! Calculate Fi(U,V) and Fi'(U,V).
0084   Standard_EXPORT Standard_Boolean Values (const math_Vector& UV, math_Vector& F, math_Matrix& DF) Standard_OVERRIDE;
0085
0086   //! Save the found extremum.
0087   Standard_EXPORT virtual Standard_Integer GetStateNumber() Standard_OVERRIDE;
0088
0089   //! Return the number of found extrema.
0090   Standard_EXPORT Standard_Integer NbExt() const;
0091
0092   //! Return the value of the Nth distance.
0093   Standard_EXPORT Standard_Real SquareDistance (const Standard_Integer N) const;
0094
0095   //! Returns the Nth extremum.
0096   Standard_EXPORT const Extrema_POnSurf& Point (const Standard_Integer N) const;
0097
0098 private:
0099
0100   gp_Pnt myP;
0101   const Adaptor3d_Surface* myS;
0102   Standard_Real myU;
0103   Standard_Real myV;
0104   gp_Pnt myPs;
0105   TColStd_SequenceOfReal mySqDist;
0106   Extrema_SequenceOfPOnSurf myPoint;
0107   Standard_Boolean myPinit;
0108   Standard_Boolean mySinit;
0109 };
0110 #endif // _Extrema_FunctPSNorm_HeaderFile