CubbyFlow::ScalarField2 Class Referenceabstract
Abstract base class for 2-D scalar field. More...
#include <Core/Field/ScalarField2.h>
Inheritance diagram for CubbyFlow::ScalarField2:
Public Member Functions | |
| ScalarField2 () | |
| Default constructor. More... | |
| virtual | ~ScalarField2 () |
| Default destructor. More... | |
| virtual double | Sample (const Vector2D &x) const =0 |
Returns sampled value at given position x. More... | |
| virtual Vector2D | Gradient (const Vector2D &x) const |
Returns gradient vector at given position x. More... | |
| virtual double | Laplacian (const Vector2D &x) const |
Returns Laplacian at given position x. More... | |
| virtual std::function< double(const Vector2D &)> | Sampler () const |
| Returns sampler function object. More... | |
 Public Member Functions inherited from CubbyFlow::Field2 | |
| Field2 () | |
| virtual | ~Field2 () |
Detailed Description
Abstract base class for 2-D scalar field.
Constructor & Destructor Documentation
◆ ScalarField2()
| CubbyFlow::ScalarField2::ScalarField2 | ( | ) |
Default constructor.
◆ ~ScalarField2()
|
virtual |
Default destructor.
Member Function Documentation
◆ Gradient()
Returns gradient vector at given position x.
Reimplemented in CubbyFlow::ScalarGrid2, and CubbyFlow::CustomScalarField2.
◆ Laplacian()
|
virtual |
Returns Laplacian at given position x.
Reimplemented in CubbyFlow::ScalarGrid2, and CubbyFlow::CustomScalarField2.
◆ Sample()
|
pure virtual |
Returns sampled value at given position x.
Implemented in CubbyFlow::ScalarGrid2, CubbyFlow::CustomScalarField2, and CubbyFlow::ConstantScalarField2.
◆ Sampler()
|
virtual |
Returns sampler function object.
Reimplemented in CubbyFlow::ScalarGrid2, CubbyFlow::CustomScalarField2, and CubbyFlow::ConstantScalarField2.
The documentation for this class was generated from the following file:
- Core/Field/ScalarField2.h
