OCCT3D OCCT 8.0.1
OCCT documentation

Search guides and API reference

Enter at least two characters.

    Open CASCADE Technology Reference Manual 8.0.1
    Law_Function Class Referenceabstract

    Root class for evolution laws. More...

    #include <Law_Function.hxx>

    Inheritance diagram for Law_Function:

    Public Member Functions

    virtual GeomAbs_Shape Continuity () const =0
    virtual int NbIntervals (const GeomAbs_Shape S) const =0
     Returns the number of intervals for continuity . May be one if Continuity(me) >= .
    virtual void Intervals (NCollection_Array1< double > &T, const GeomAbs_Shape S) const =0
     Stores in <T> the parameters bounding the intervals of continuity . The array must provide enough room to accommodate for the parameters, i.e. T.Length() > NbIntervals().
    virtual double Value (const double X)=0
     Returns the value of the function at the point of parameter X.
    virtual void D1 (const double X, double &F, double &D)=0
     Returns the value F and the first derivative D of the function at the point of parameter X.
    virtual void D2 (const double X, double &F, double &D, double &D2)=0
     Returns the value, first and second derivatives at parameter X.
    virtual occ::handle< Law_FunctionTrim (const double PFirst, const double PLast, const double Tol) const =0
     Returns a law equivalent of <me> between parameters <First> and <Last>. <Tol> is used to test for 3d points confusion. It is usfule to determines the derivatives in these values <First> and <Last> if the Law is not Cn.
    virtual void Bounds (double &PFirst, double &PLast)=0
     Returns the parametric bounds of the function.
    Public Member Functions inherited from Standard_Transient
     Standard_Transient ()
     Empty constructor.
     Standard_Transient (const Standard_Transient &)
     Copy constructor – does nothing.
    Standard_Transientoperator= (const Standard_Transient &)
     Assignment operator, needed to avoid copying reference counter.
    virtual ~Standard_Transient ()=default
     Destructor must be virtual.
    virtual const opencascade::handle< Standard_Type > & DynamicType () const
     Returns a type descriptor about this object.
    bool IsInstance (const opencascade::handle< Standard_Type > &theType) const
     Returns a true value if this is an instance of Type.
    bool IsInstance (const char *const theTypeName) const
     Returns a true value if this is an instance of TypeName.
    bool IsKind (const opencascade::handle< Standard_Type > &theType) const
     Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
    bool IsKind (const char *const theTypeName) const
     Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
    Standard_TransientThis () const
     Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
    int GetRefCount () const noexcept
     Get the reference counter of this object.
    void IncrementRefCounter () noexcept
     Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.
    int DecrementRefCounter () noexcept
     Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.
    virtual void Delete () const
     Memory deallocator for transient classes.

    Additional Inherited Members

    typedef void base_type
     Returns a type descriptor about this object.
    static constexpr const char * get_type_name ()
     Returns a type descriptor about this object.
    static const opencascade::handle< Standard_Type > & get_type_descriptor ()
     Returns type descriptor of Standard_Transient class.

    Detailed Description

    Root class for evolution laws.

    Member Function Documentation

    ◆ Bounds()

    virtual void Law_Function::Bounds ( double & PFirst,
    double & PLast )
    pure virtual

    Returns the parametric bounds of the function.

    Implemented in Law_BSpFunc, Law_Composite, Law_Constant, and Law_Linear.

    ◆ Continuity()

    virtual GeomAbs_Shape Law_Function::Continuity ( ) const
    pure virtual

    ◆ D1()

    virtual void Law_Function::D1 ( const double X,
    double & F,
    double & D )
    pure virtual

    Returns the value F and the first derivative D of the function at the point of parameter X.

    Implemented in Law_BSpFunc, Law_Composite, Law_Constant, and Law_Linear.

    ◆ D2()

    virtual void Law_Function::D2 ( const double X,
    double & F,
    double & D,
    double & D2 )
    pure virtual

    Returns the value, first and second derivatives at parameter X.

    Implemented in Law_BSpFunc, Law_Composite, Law_Constant, and Law_Linear.

    ◆ Intervals()

    virtual void Law_Function::Intervals ( NCollection_Array1< double > & T,
    const GeomAbs_Shape S ) const
    pure virtual

    Stores in <T> the parameters bounding the intervals of continuity . The array must provide enough room to accommodate for the parameters, i.e. T.Length() > NbIntervals().

    Implemented in Law_BSpFunc, Law_Composite, Law_Constant, and Law_Linear.

    ◆ NbIntervals()

    virtual int Law_Function::NbIntervals ( const GeomAbs_Shape S) const
    pure virtual

    Returns the number of intervals for continuity . May be one if Continuity(me) >= .

    Implemented in Law_BSpFunc, Law_Composite, Law_Constant, and Law_Linear.

    ◆ Trim()

    virtual occ::handle< Law_Function > Law_Function::Trim ( const double PFirst,
    const double PLast,
    const double Tol ) const
    pure virtual

    Returns a law equivalent of <me> between parameters <First> and <Last>. <Tol> is used to test for 3d points confusion. It is usfule to determines the derivatives in these values <First> and <Last> if the Law is not Cn.

    Implemented in Law_BSpFunc, Law_Composite, Law_Constant, and Law_Linear.

    ◆ Value()

    virtual double Law_Function::Value ( const double X)
    pure virtual

    Returns the value of the function at the point of parameter X.

    Implemented in Law_BSpFunc, Law_Composite, Law_Constant, and Law_Linear.


    The documentation for this class was generated from the following file: