CubbyFlow::ScalarField3 Class Referenceabstract
Abstract base class for 3-D scalar field. More...
#include <Core/Field/ScalarField3.h>
Inheritance diagram for CubbyFlow::ScalarField3:
Public Member Functions | |
| ScalarField3 () | |
| Default constructor. More... | |
| virtual | ~ScalarField3 () |
| Default destructor. More... | |
| virtual double | Sample (const Vector3D &x) const =0 |
Returns sampled value at given position x. More... | |
| virtual Vector3D | Gradient (const Vector3D &x) const |
Returns gradient vector at given position x. More... | |
| virtual double | Laplacian (const Vector3D &x) const |
Returns Laplacian at given position x. More... | |
| virtual std::function< double(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 scalar field.
Constructor & Destructor Documentation
◆ ScalarField3()
| CubbyFlow::ScalarField3::ScalarField3 | ( | ) |
Default constructor.
◆ ~ScalarField3()
|
virtual |
Default destructor.
Member Function Documentation
◆ Gradient()
Returns gradient vector at given position x.
Reimplemented in CubbyFlow::ScalarGrid3, and CubbyFlow::CustomScalarField3.
◆ Laplacian()
|
virtual |
Returns Laplacian at given position x.
Reimplemented in CubbyFlow::ScalarGrid3, and CubbyFlow::CustomScalarField3.
◆ Sample()
|
pure virtual |
Returns sampled value at given position x.
Implemented in CubbyFlow::ScalarGrid3, CubbyFlow::CustomScalarField3, and CubbyFlow::ConstantScalarField3.
◆ Sampler()
|
virtual |
Returns sampler function object.
Reimplemented in CubbyFlow::ScalarGrid3, CubbyFlow::CustomScalarField3, and CubbyFlow::ConstantScalarField3.
The documentation for this class was generated from the following file:
- Core/Field/ScalarField3.h
