A scalar-valued spatial function, defining a rotation about the Z-axis. More...
#include <Functions.h>
Inheritance diagram for LinearRotZFunc:
Collaboration diagram for LinearRotZFunc:
Public Member Functions | |
| LinearRotZFunc (bool retX, Real a, Real x_0=Real(0), Real y_0=Real(0)) | |
| Constructor initializing the function parameters. | |
| bool | isZero () const override |
| Returns whether the function is identically zero or not. | |
| bool | isConstant () const override |
| Returns whether the function is time-independent or not. | |
| Real | deriv (const Vec3 &, int dir) const override |
| Returns first-derivative of the function. | |
 Public Member Functions inherited from RealFunc | |
| unsigned char | getType () const override |
| Returns the function type flag. | |
| std::vector< Real > | getValue (const Vec3 &X) const override |
| Returns the function value as an array. | |
| virtual Vec3 | gradient (const Vec3 &X) const |
| Evaluates first derivatives of the function. | |
| virtual SymmTensor | hessian (const Vec3 &X) const |
| Evaluates second derivatives of the function. | |
| Real | getScalarValue (const Vec3 &X) const override |
| Returns a representative scalar equivalent of the function value. | |
| Real | timeDerivative (const Vec3 &X) const |
| Returns the time derivative of the function. | |
| Public Member Functions inherited from utl::SpatialFunction< Real > | |
| virtual Real | dderiv (const Vec3 &, int, int) const |
| Returns a second-derivative of the function. | |
| Public Member Functions inherited from utl::Function< Arg, Result > | |
| virtual | ~Function () |
| Empty destructor. | |
| Result | operator() (const Arg &x) const |
| Operator returning the function value for the given argument. | |
| Public Member Functions inherited from FunctionBase | |
| virtual | ~FunctionBase () |
| Empty destructor. | |
| size_t | dim () const |
| Returns the number of components of the return value. | |
| virtual bool | initPatch (size_t) |
| Sets the active patch. | |
| virtual bool | inDomain (const Vec3 &) const |
| Checks if a specified point is within the function domain. | |
| virtual void | setParam (const std::string &, Real) |
| Sets an additional parameter in the function. | |
| void | setParam (const std::string &name, const Vec3 &value) |
| Sets additional parameter values in the function. | |
Protected Member Functions | |
| Real | evaluate (const Vec3 &X) const override |
| Evaluates the rotation function. | |
| Protected Member Functions inherited from RealFunc | |
| RealFunc () | |
| The constructor is protected to allow sub-class instances only. | |
| Protected Member Functions inherited from utl::SpatialFunction< Real > | |
| SpatialFunction (const Real &val) | |
| The constructor is protected to allow sub-class instances only. | |
| virtual std::vector< Real > | evalGradient (const Vec3 &) const |
| Returns the gradient of the function as a 1D array. | |
| virtual std::vector< Real > | evalHessian (const Vec3 &) const |
| Returns the hessian of the function as a 1D array. | |
| virtual std::vector< Real > | evalTimeDerivative (const Vec3 &) const |
| Returns the time derivatives of the function as a 1D array. | |
| Protected Member Functions inherited from utl::Function< Arg, Result > | |
| Function () | |
| The constructor is protected to allow sub-class instances only. | |
| virtual Result | evaluate (const Arg &x) const =0 |
| Evaluates the function for the argument x. | |
| Protected Member Functions inherited from FunctionBase | |
| FunctionBase () | |
| The constructor is protected to allow sub-class instances only. | |
Private Attributes | |
| bool | rX |
| Flag telling whether to return the X- (true) or Y-component. | |
| Real | A |
| Magnitude of the rotation. | |
| Real | x0 |
| Global X-coordinate of rotation centre. | |
| Real | y0 |
| Global Y-coordinate of rotation centre. | |
Additional Inherited Members | |
| Public Types inherited from utl::Function< Arg, Result > | |
| typedef Arg | Input |
| Input type. | |
| typedef Result | Output |
| Output type. | |
| Protected Attributes inherited from utl::SpatialFunction< Real > | |
| Real | zero |
| Return value for default implementations of derivatives. | |
| Protected Attributes inherited from FunctionBase | |
| size_t | ncmp |
| Number of components in the return value. | |
Detailed Description
A scalar-valued spatial function, defining a rotation about the Z-axis.
The time component of the function argument multiplied with the function parameter A, is interpreted as the angle of rotation (in radians) about the global Z-axis passing through the point x0, y0. The function then returns the translation in either X- or Y-direction (depending on the retX argument to the constructor) of the global point { X.x, X.y } corresponding to this rotation.
The documentation for this class was generated from the following files:
- src/Utility/Functions.h
- src/Utility/Functions.C
