Abstract base class for 2-D vector field. More...
#include <jet/vector_field2.h>
Public Member Functions | |
| VectorField2 () | |
| Default constructor. More... | |
| virtual | ~VectorField2 () |
| Default destructor. More... | |
| virtual Vector2D | sample (const Vector2D &x) const =0 |
Returns sampled value at given position x. 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... | |
| virtual std::function< Vector2D(const Vector2D &)> | sampler () const |
| Returns sampler function object. More... | |
 Public Member Functions inherited from jet::Field2 | |
| Field2 () | |
| virtual | ~Field2 () |
Detailed Description
Abstract base class for 2-D vector field.
Constructor & Destructor Documentation
◆ VectorField2()
| jet::VectorField2::VectorField2 | ( | ) |
Default constructor.
◆ ~VectorField2()
|
virtual |
Default destructor.
Member Function Documentation
◆ curl()
|
virtual |
Returns curl at given position x.
Reimplemented in jet::FaceCenteredGrid2, jet::CollocatedVectorGrid2, and jet::CustomVectorField2.
◆ divergence()
|
virtual |
Returns divergence at given position x.
Reimplemented in jet::FaceCenteredGrid2, jet::CollocatedVectorGrid2, and jet::CustomVectorField2.
◆ sample()
Returns sampled value at given position x.
Implemented in jet::FaceCenteredGrid2, jet::CollocatedVectorGrid2, jet::CustomVectorField2, and jet::ConstantVectorField2.
◆ sampler()
Returns sampler function object.
Reimplemented in jet::FaceCenteredGrid2, jet::CollocatedVectorGrid2, jet::CustomVectorField2, and jet::ConstantVectorField2.
The documentation for this class was generated from the following file:
- jet/vector_field2.h
