CubbyFlow::VectorField< N > Class Template Reference

Abstract base class for N-D vector field. More...

#include <Core/Field/VectorField.hpp>

Inheritance diagram for CubbyFlow::VectorField< N >:

Public Member Functions
	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 Vector< double, N >	Sample (const Vector< double, N > &x) const =0
	Returns sampled value at given position x.
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.
virtual std::function< Vector< double, N >(const Vector< double, N > &)>	Sampler () const
	Returns sampler function object.
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.

Detailed Description

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

Abstract base class for N-D vector field.

Constructor & Destructor Documentation

VectorField() [1/3]

template<size_t N>

CubbyFlow::VectorField< N >::VectorField ( )

default

Default constructor.

~VectorField()

template<size_t N>

CubbyFlow::VectorField< N >::~VectorField ( )

overridedefault

Default destructor.

VectorField() [2/3]

template<size_t N>

CubbyFlow::VectorField< N >::VectorField ( const VectorField< N > &  )

default

Default copy constructor.

VectorField() [3/3]

template<size_t N>

CubbyFlow::VectorField< N >::VectorField ( VectorField< N > &&  )

defaultnoexcept

Default move constructor.

Member Function Documentation

Curl()

template<size_t N>

virtual GetCurl< N >::Type CubbyFlow::VectorField< N >::Curl ( const Vector< double, N > &  x ) const

virtual

Returns curl at given position x.

Reimplemented in CubbyFlow::CustomVectorField< N >, CubbyFlow::CollocatedVectorGrid< N >, and CubbyFlow::FaceCenteredGrid< N >.

Divergence()

template<size_t N>

virtual double CubbyFlow::VectorField< N >::Divergence ( const Vector< double, N > &  x ) const

virtual

Returns divergence at given position x.

Reimplemented in CubbyFlow::CustomVectorField< N >, CubbyFlow::CollocatedVectorGrid< N >, and CubbyFlow::FaceCenteredGrid< N >.

operator=() [1/2]

template<size_t N>

VectorField & CubbyFlow::VectorField< N >::operator= ( const VectorField< N > &  )

default

Default copy assignment operator.

operator=() [2/2]

template<size_t N>

VectorField & CubbyFlow::VectorField< N >::operator= ( VectorField< N > &&  )

defaultnoexcept

Default move assignment operator.

Sample()

template<size_t N>

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

pure virtual

Returns sampled value at given position x.

Implemented in CubbyFlow::ConstantVectorField< N >, CubbyFlow::CustomVectorField< N >, CubbyFlow::CollocatedVectorGrid< N >, and CubbyFlow::FaceCenteredGrid< N >.

Sampler()

template<size_t N>

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

virtual

Returns sampler function object.

Reimplemented in CubbyFlow::ConstantVectorField< N >, CubbyFlow::CustomVectorField< N >, CubbyFlow::CollocatedVectorGrid< N >, and CubbyFlow::FaceCenteredGrid< N >.

---

The documentation for this class was generated from the following file:

• Core/Field/VectorField.hpp