chrono::ChFunctionFillet3 Class Reference

Description

Cubic fillet function.

Cubic polynomial y(x) that smoothly connects two points with given start and end derivatives.

#include <ChFunctionFillet3.h>

Inheritance diagram for chrono::ChFunctionFillet3:
Collaboration diagram for chrono::ChFunctionFillet3:

Public Member Functions

 ChFunctionFillet3 (const ChFunctionFillet3 &other)
 
virtual ChFunctionFillet3Clone () const override
 "Virtual" copy constructor (covariant return type).
 
virtual Type GetType () const override
 Return the unique function type identifier.
 
virtual double GetVal (double x) const override
 Return the function output for input x. More...
 
virtual double GetDer (double x) const override
 Return the first derivative of the function. More...
 
virtual double GetDer2 (double x) const override
 Return the second derivative of the function. More...
 
void SetWidth (double width)
 
double GetWidth ()
 
void Setup ()
 Setup the function after parameter changes. More...
 
void SetStartVal (double val_start)
 Set the initial value of the function.
 
void SetEndVal (double val_end)
 Set the end value of the function.
 
void SetStartDer (double der_start)
 Set the initial derivative of the function.
 
void SetEndDer (double der_end)
 Set the end derivative of the function.
 
double GetStartVal ()
 Get the initial value of the function.
 
double GetEndVal ()
 Get the end value of the function.
 
double GetStartDer ()
 Get the initial derivative of the function.
 
double GetEndDer ()
 Get the end derivative of the function.
 
virtual void ArchiveOut (ChArchiveOut &archive_out) override
 Method to allow serialization of transient data to archives.
 
virtual void ArchiveIn (ChArchiveIn &archive_in) override
 Method to allow de-serialization of transient data from archives.
 
- Public Member Functions inherited from chrono::ChFunction
 ChFunction (const ChFunction &other)
 
virtual double GetDer3 (double x) const
 Return the third derivative of the function. More...
 
virtual double GetDerN (double x, int der_order) const
 Return the Nth derivative of the function (up to 3rd derivative). More...
 
virtual double GetWeight (double x) const
 Return the weight of the function (useful for applications where you need to mix different weighted ChFunctions)
 
virtual void Update (double x)
 Update could be implemented by children classes, ex. to launch callbacks.
 
virtual double GetMax (double xmin, double xmax, double sampling_step, int der_order) const
 Estimate the maximum of the function (or its der_order derivative) in the range [xmin, xmax], using sampling method.
 
virtual double GetMin (double xmin, double xmax, double sampling_step, int der_order) const
 Estimate the minimum of the function (or its der_order derivative) in the range [xmin, xmax], using sampling method.
 
virtual double GetMean (double xmin, double xmax, double sampling_step, int der_order) const
 Estimate the mean of the function (or its der_order derivative) in the range [xmin, xmax], using sampling method.
 
virtual double GetSquaredMean (double xmin, double xmax, double sampling_step, int der_order) const
 Estimate the squared mean of the function (or its der_order derivative) in the range [xmin, xmax], using sampling method.
 
virtual double GetIntegral (double xmin, double xmax, double sampling_step, int der_order) const
 Estimate the integral of the function (or its der_order derivative) over the range [xmin, xmax], using sampling method.
 
virtual double GetPositiveAccelerationCoeff () const
 Computes the positive acceleration coefficient (inherited classes should override this).
 
virtual double GetNegativeAccelerationCoeff () const
 Compute the negative acceleration coefficient (inherited classes should override this).
 
virtual double GetVelocityCoefficient () const
 Compute the velocity coefficient (inherited classes must override this).
 
virtual void OutputToASCIIFile (std::ostream &file, double xmin, double xmax, int samples, char delimiter)
 Store X-Y pairs to an ASCII File. More...
 
virtual ChMatrixDynamic SampleUpToDerN (double xmin, double xmax, double step, int derN=0)
 Sample function on given interval [xmin, xmax], up to derN derivative (0 being the function ouput itself). More...
 
double operator() (double arg) const
 Alias operator of the GetVal function.
 

Additional Inherited Members

- Public Types inherited from chrono::ChFunction
enum  Type {
  BSPLINE, CONSTANT, CONSTACC, CONSTJERK,
  CUSTOM, CYCLOIDAL, DERIVATIVE, FILLET3,
  INTEGRAL, INTERP, LAMBDA, MIRROR,
  OPERATOR, POLY, POLY23, POLY345,
  RAMP, REPEAT, SEQUENCE, SINE,
  SINE_STEP
}
 Enumeration of function types.
 

Member Function Documentation

◆ GetDer()

double chrono::ChFunctionFillet3::GetDer ( double  x) const
overridevirtual

Return the first derivative of the function.

Default implementation computes a numerical differentiation. Inherited classes may override this method with a more efficient implementation (e.g. analytical solution).

Reimplemented from chrono::ChFunction.

◆ GetDer2()

double chrono::ChFunctionFillet3::GetDer2 ( double  x) const
overridevirtual

Return the second derivative of the function.

Default implementation computes a numerical differentiation. Inherited classes may override this method with a more efficient implementation (e.g. analytical solution).

Reimplemented from chrono::ChFunction.

◆ GetVal()

double chrono::ChFunctionFillet3::GetVal ( double  x) const
overridevirtual

Return the function output for input x.

Must be overridden by specialized classes.

Implements chrono::ChFunction.

◆ Setup()

void chrono::ChFunctionFillet3::Setup ( )

Setup the function after parameter changes.

This must be called by the user after the parameters are changed.


The documentation for this class was generated from the following files:
  • /builds/uwsbel/chrono/src/chrono/functions/ChFunctionFillet3.h
  • /builds/uwsbel/chrono/src/chrono/functions/ChFunctionFillet3.cpp