CubbyFlow::ConstantVectorField< N > Class Template Referencefinal
N-D constant vector field. More...
#include <Core/Field/ConstantVectorField.hpp>
Inheritance diagram for CubbyFlow::ConstantVectorField< N >:
Classes | |
| class | Builder |
| Front-end to create ConstantVectorField objects step by step. More... | |
Public Member Functions | |
| ConstantVectorField (const Vector< double, N > &value) | |
Constructs a constant vector field with given value. More... | |
| Vector< double, N > | Sample (const Vector< double, N > &x) const override |
Returns the sampled value at given position x. More... | |
| std::function< Vector< double, N >const Vector< double, N > &)> | Sampler () const override |
| Returns the sampler function. More... | |
 Public Member Functions inherited from CubbyFlow::VectorField< N > | |
| VectorField ()=default | |
| Default constructor. More... | |
| ~VectorField () override=default | |
| Default destructor. More... | |
| VectorField (const VectorField &)=default | |
| Default copy constructor. More... | |
| VectorField (VectorField &&) noexcept=default | |
| Default move constructor. More... | |
| VectorField & | operator= (const VectorField &)=default |
| Default copy assignment operator. More... | |
| VectorField & | operator= (VectorField &&) noexcept=default |
| Default move assignment operator. More... | |
| virtual double | Divergence (const Vector< double, N > &x) const |
Returns divergence at given position x. More... | |
| virtual GetCurl< N >::Type | Curl (const Vector< double, N > &x) const |
Returns curl at given position x. More... | |
| Public Member Functions inherited from CubbyFlow::Field< N > | |
| Field ()=default | |
| Default constructor. More... | |
| virtual | ~Field ()=default |
| Default virtual destructor. More... | |
| Field (const Field &)=default | |
| Default copy constructor. More... | |
| Field (Field &&) noexcept=default | |
| Default move constructor. More... | |
| Field & | operator= (const Field &)=default |
| Default copy assignment operator. More... | |
| Field & | operator= (Field &&) noexcept=default |
| Default move assignment operator. More... | |
Static Public Member Functions | |
| static Builder | GetBuilder () |
| Returns builder for ConstantVectorField. More... | |
Detailed Description
template<size_t N>
class CubbyFlow::ConstantVectorField< N >
N-D constant vector field.
Constructor & Destructor Documentation
◆ ConstantVectorField()
template<size_t N>
|
explicit |
Constructs a constant vector field with given value.
Member Function Documentation
◆ GetBuilder()
template<size_t N>
|
static |
Returns builder for ConstantVectorField.
◆ Sample()
template<size_t N>
|
overridevirtual |
Returns the sampled value at given position x.
Implements CubbyFlow::VectorField< N >.
◆ Sampler()
template<size_t N>
|
overridevirtual |
Returns the sampler function.
Reimplemented from CubbyFlow::VectorField< N >.
The documentation for this class was generated from the following file:
- Core/Field/ConstantVectorField.hpp
