A scalar-valued spatial function, defined through scalar fields. More...
#include <FieldFunctions.h>
Inheritance diagram for FieldFuncStream:
Collaboration diagram for FieldFuncStream:
Public Member Functions | |
| FieldFuncStream (const std::vector< ASMbase * > &patches, std::istream &istr) | |
| The constructor creates a field from the provided input stream. More... | |
| virtual | ~FieldFuncStream () |
| The destructor deletes the scalar fields. | |
| virtual bool | initPatch (size_t pIdx) |
| Sets the active patch. | |
 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 | deriv (const Vec3 &, int) const |
| Returns a first-derivative of the function. | |
| 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. | |
| virtual bool | isZero () const |
| Returns whether the function is identically zero or not. | |
| virtual bool | isConstant () const |
| Returns whether the function is time-independent or not. | |
| 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 | 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 | |
| virtual Real | evaluate (const Vec3 &X) const |
| Evaluates the scalar field 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 | |
| std::vector< Field * > | field |
| The scalar field to be evaluated. | |
| Private Attributes inherited from FieldFuncBase | |
| std::vector< ASMbase * > | patch |
| The patches on which the field is defined. | |
| size_t | pidx |
| Current patch index. | |
| size_t | npch |
| Number of patches in the field. | |
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. | |
| Private Member Functions inherited from FieldFuncBase | |
| FieldFuncBase () | |
| Default constructor. | |
| FieldFuncBase (const FieldFuncBase &)=delete | |
| No copying of this class. | |
| virtual | ~FieldFuncBase () |
| The destructor deletes the patches. | |
| bool | setPatch (size_t pIdx) |
| Sets the active patch. | |
| Static Private Attributes inherited from FieldFuncBase | |
| static constexpr int | FIXED_LEVEL = 1 << 24 |
| Bit flag in level for using fixed. | |
Detailed Description
A scalar-valued spatial function, defined through scalar fields.
This class reads its control point values from a stream.
Constructor & Destructor Documentation
◆ FieldFuncStream()
| FieldFuncStream::FieldFuncStream | ( | const std::vector< ASMbase * > & | patches, |
| std::istream & | istr | ||
| ) |
The constructor creates a field from the provided input stream.
- Parameters
-
[in] patches List of patches the field is defined over [in] istr Input stream to read control point values from
References Field::create(), and field.
The documentation for this class was generated from the following files:
- src/Utility/FieldFunctions.h
- src/Utility/FieldFunctions.C
