include/opencascade/FairCurve_EnergyOfMVC.hxx

0001 // Created on: 1996-04-01
0002 // Created by: Philippe MANGIN
0003 // Copyright (c) 1996-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 _FairCurve_EnergyOfMVC_HeaderFile
0018 #define _FairCurve_EnergyOfMVC_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <FairCurve_BattenLaw.hxx>
0025 #include <FairCurve_DistributionOfTension.hxx>
0026 #include <FairCurve_DistributionOfSagging.hxx>
0027 #include <FairCurve_DistributionOfJerk.hxx>
0028 #include <FairCurve_AnalysisCode.hxx>
0029 #include <FairCurve_Energy.hxx>
0030 #include <Standard_Integer.hxx>
0031 #include <TColStd_HArray1OfReal.hxx>
0032 #include <TColgp_HArray1OfPnt2d.hxx>
0033 #include <math_Vector.hxx>
0034
0035 // resolve name collisions with X11 headers
0036 #ifdef Status
0037   #undef Status
0038 #endif
0039
0040 //! Energy Criterium to minimize in MinimalVariationCurve.
0041 class FairCurve_EnergyOfMVC  : public FairCurve_Energy
0042 {
0043 public:
0044
0045   DEFINE_STANDARD_ALLOC
0046
0047
0048   //! Angles corresspond to the Ox axis
0049   Standard_EXPORT FairCurve_EnergyOfMVC(const Standard_Integer BSplOrder, const Handle(TColStd_HArray1OfReal)& FlatKnots, const Handle(TColgp_HArray1OfPnt2d)& Poles, const Standard_Integer ContrOrder1, const Standard_Integer ContrOrder2, const FairCurve_BattenLaw& Law, const Standard_Real PhysicalRatio, const Standard_Real LengthSliding, const Standard_Boolean FreeSliding = Standard_True, const Standard_Real Angle1 = 0, const Standard_Real Angle2 = 0, const Standard_Real Curvature1 = 0, const Standard_Real Curvature2 = 0);
0050
0051   //! return  the  lengthSliding = P1P2 + Sliding
0052     Standard_Real LengthSliding() const;
0053
0054   //! return  the status
0055     FairCurve_AnalysisCode Status() const;
0056
0057   //! compute the variables <X> which correspond with the field <MyPoles>
0058   Standard_EXPORT virtual Standard_Boolean Variable (math_Vector& X) const Standard_OVERRIDE;
0059
0060
0061
0062
0063 protected:
0064
0065
0066   //! compute  the  poles which correspond with the variable X
0067   Standard_EXPORT virtual void ComputePoles (const math_Vector& X) Standard_OVERRIDE;
0068
0069   //! compute the energy in intermediat format
0070   Standard_EXPORT virtual Standard_Boolean Compute (const Standard_Integer DerivativeOrder, math_Vector& Result) Standard_OVERRIDE;
0071
0072
0073
0074
0075 private:
0076
0077
0078
0079   Standard_Real MyLengthSliding;
0080   Standard_Real OriginalSliding;
0081   FairCurve_BattenLaw MyBattenLaw;
0082   Standard_Real MyPhysicalRatio;
0083   FairCurve_DistributionOfTension MyTension;
0084   FairCurve_DistributionOfSagging MySagging;
0085   FairCurve_DistributionOfJerk MyJerk;
0086   FairCurve_AnalysisCode MyStatus;
0087
0088
0089 };
0090
0091
0092 #include <FairCurve_EnergyOfMVC.lxx>
0093
0094
0095
0096
0097
0098 #endif // _FairCurve_EnergyOfMVC_HeaderFile