CubbyFlow::ConstantVectorField3 Class Referencefinal
3-D constant vector field. More...
#include <Core/Field/ConstantVectorField3.h>
Inheritance diagram for CubbyFlow::ConstantVectorField3:
Classes | |
| class | Builder |
| Front-end to create ConstantVectorField3 objects step by step. More... | |
Public Member Functions | |
| ConstantVectorField3 (const Vector3D &value) | |
Constructs a constant vector field with given value. More... | |
| Vector3D | Sample (const Vector3D &x) const override |
Returns the sampled value at given position x. More... | |
| std::function< Vector3D(const Vector3D &)> | Sampler () const override |
| Returns the sampler function. More... | |
 Public Member Functions inherited from CubbyFlow::VectorField3 | |
| VectorField3 () | |
| Default constructor. More... | |
| virtual | ~VectorField3 () |
| Default destructor. More... | |
| virtual double | Divergence (const Vector3D &x) const |
Returns divergence at given position x. More... | |
| virtual Vector3D | Curl (const Vector3D &x) const |
Returns curl at given position x. More... | |
| Public Member Functions inherited from CubbyFlow::Field3 | |
| Field3 () | |
| virtual | ~Field3 () |
Static Public Member Functions | |
| static Builder | GetBuilder () |
| Returns builder fox ConstantVectorField3. More... | |
Detailed Description
3-D constant vector field.
Constructor & Destructor Documentation
◆ ConstantVectorField3()
|
explicit |
Constructs a constant vector field with given value.
Member Function Documentation
◆ GetBuilder()
|
static |
Returns builder fox ConstantVectorField3.
◆ Sample()
Returns the sampled value at given position x.
Implements CubbyFlow::VectorField3.
◆ Sampler()
|
overridevirtual |
Returns the sampler function.
Reimplemented from CubbyFlow::VectorField3.
The documentation for this class was generated from the following file:
- Core/Field/ConstantVectorField3.h
