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