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