Abstract base class for 3-D vector field. More...
#include <jet/vector_field3.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 jet::Field3 | |
| Field3 () | |
| virtual | ~Field3 () |
Detailed Description
Abstract base class for 3-D vector field.
Constructor & Destructor Documentation
◆ VectorField3()
| jet::VectorField3::VectorField3 | ( | ) |
Default constructor.
◆ ~VectorField3()
|
virtual |
Default destructor.
Member Function Documentation
◆ curl()
Returns curl at given position x.
Reimplemented in jet::FaceCenteredGrid3, jet::CollocatedVectorGrid3, and jet::CustomVectorField3.
◆ divergence()
|
virtual |
Returns divergence at given position x.
Reimplemented in jet::FaceCenteredGrid3, jet::CollocatedVectorGrid3, and jet::CustomVectorField3.
◆ sample()
Returns sampled value at given position x.
Implemented in jet::FaceCenteredGrid3, jet::CollocatedVectorGrid3, jet::CustomVectorField3, and jet::ConstantVectorField3.
◆ sampler()
Returns sampler function object.
Reimplemented in jet::FaceCenteredGrid3, jet::CollocatedVectorGrid3, jet::CustomVectorField3, and jet::ConstantVectorField3.
The documentation for this class was generated from the following file:
- jet/vector_field3.h
