Abstract base class for 3-D vector field. More...
#include <Core/Field/VectorField3.h>
Public Member Functions | |
| VectorField3 () | |
| Default constructor. More... | |
| virtual | ~VectorField3 () |
| Default destructor. More... | |
| virtual Vector3D | Sample (const Vector3D &x) const =0 |
Returns sampled value at given position x. 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... | |
| virtual std::function< Vector3D(const Vector3D &)> | Sampler () const |
| Returns sampler function object. More... | |
 Public Member Functions inherited from CubbyFlow::Field3 | |
| Field3 () | |
| virtual | ~Field3 () |
Detailed Description
Abstract base class for 3-D vector field.
Constructor & Destructor Documentation
◆ VectorField3()
| CubbyFlow::VectorField3::VectorField3 | ( | ) |
Default constructor.
◆ ~VectorField3()
|
virtual |
Default destructor.
Member Function Documentation
◆ Curl()
Returns curl at given position x.
Reimplemented in CubbyFlow::FaceCenteredGrid3, CubbyFlow::CollocatedVectorGrid3, and CubbyFlow::CustomVectorField3.
◆ Divergence()
|
virtual |
Returns divergence at given position x.
Reimplemented in CubbyFlow::FaceCenteredGrid3, CubbyFlow::CollocatedVectorGrid3, and CubbyFlow::CustomVectorField3.
◆ Sample()
Returns sampled value at given position x.
Implemented in CubbyFlow::FaceCenteredGrid3, CubbyFlow::CollocatedVectorGrid3, CubbyFlow::CustomVectorField3, and CubbyFlow::ConstantVectorField3.
◆ Sampler()
Returns sampler function object.
Reimplemented in CubbyFlow::FaceCenteredGrid3, CubbyFlow::CollocatedVectorGrid3, CubbyFlow::CustomVectorField3, and CubbyFlow::ConstantVectorField3.
The documentation for this class was generated from the following file:
- Core/Field/VectorField3.h
