CubbyFlow::ConstantVectorField< N > Class Template Reference

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.
Vector< double, N >	Sample (const Vector< double, N > &x) const override
	Returns the sampled value at given position x.
std::function< Vector< double, N >(const Vector< double, N > &)>	Sampler () const override
	Returns the sampler function.
Public Member Functions inherited from CubbyFlow::VectorField< N >
	VectorField ()=default
	Default constructor.
	~VectorField () override=default
	Default destructor.
	VectorField (const VectorField &)=default
	Default copy constructor.
	VectorField (VectorField &&) noexcept=default
	Default move constructor.
VectorField &	operator= (const VectorField &)=default
	Default copy assignment operator.
VectorField &	operator= (VectorField &&) noexcept=default
	Default move assignment operator.
virtual double	Divergence (const Vector< double, N > &x) const
	Returns divergence at given position x.
virtual GetCurl< N >::Type	Curl (const Vector< double, N > &x) const
	Returns curl at given position x.
Public Member Functions inherited from CubbyFlow::Field< N >
	Field ()=default
	Default constructor.
virtual	~Field ()=default
	Default virtual destructor.
	Field (const Field &)=default
	Default copy constructor.
	Field (Field &&) noexcept=default
	Default move constructor.
Field &	operator= (const Field &)=default
	Default copy assignment operator.
Field &	operator= (Field &&) noexcept=default
	Default move assignment operator.

Static Public Member Functions
static Builder	GetBuilder ()
	Returns builder for ConstantVectorField.

Detailed Description

template<size_t N>
class CubbyFlow::ConstantVectorField< N >

N-D constant vector field.

Constructor & Destructor Documentation

ConstantVectorField()

template<size_t N>

CubbyFlow::ConstantVectorField< N >::ConstantVectorField ( const Vector< double, N > &  value )

explicit

Constructs a constant vector field with given value.

Member Function Documentation

GetBuilder()

template<size_t N>

static Builder CubbyFlow::ConstantVectorField< N >::GetBuilder ( )

static

Returns builder for ConstantVectorField.

Sample()

template<size_t N>

Vector< double, N > CubbyFlow::ConstantVectorField< N >::Sample ( const Vector< double, N > &  x ) const

overridevirtual

Returns the sampled value at given position x.

Implements CubbyFlow::VectorField< N >.

Sampler()

template<size_t N>

std::function< Vector< double, N >(const Vector< double, N > &)> CubbyFlow::ConstantVectorField< N >::Sampler ( ) const

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