CubbyFlow::ConstantScalarField< N > Class Template Reference

N-D constant scalar field. More...

#include <Core/Field/ConstantScalarField.hpp>

Inheritance diagram for CubbyFlow::ConstantScalarField< N >:

Classes
class	Builder
	Front-end to create ConstantScalarField objects step by step. More...

Public Member Functions
	ConstantScalarField (double value)
	Constructs a constant scalar field with given value.
double	Sample (const Vector< double, N > &x) const override
	Returns the sampled value at given position x.
std::function< double(const Vector< double, N > &)>	Sampler () const override
	Returns the sampler function.
Public Member Functions inherited from CubbyFlow::ScalarField< N >
	ScalarField ()=default
	Default constructor.
	~ScalarField () override=default
	Default destructor.
	ScalarField (const ScalarField &)=default
	Default copy constructor.
	ScalarField (ScalarField &&) noexcept=default
	Default move constructor.
ScalarField &	operator= (const ScalarField &)=default
	Default copy assignment operator.
ScalarField &	operator= (ScalarField &&) noexcept=default
	Default move assignment operator.
virtual Vector< double, N >	Gradient (const Vector< double, N > &x) const
	Returns gradient vector at given position x.
virtual double	Laplacian (const Vector< double, N > &x) const
	Returns Laplacian 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 ConstantScalarField.

Detailed Description

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

N-D constant scalar field.

Constructor & Destructor Documentation

ConstantScalarField()

template<size_t N>

CubbyFlow::ConstantScalarField< N >::ConstantScalarField ( double  value )

explicit

Constructs a constant scalar field with given value.

Member Function Documentation

GetBuilder()

template<size_t N>

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

static

Returns builder for ConstantScalarField.

Sample()

template<size_t N>

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

overridevirtual

Returns the sampled value at given position x.

Implements CubbyFlow::ScalarField< N >.

Sampler()

template<size_t N>

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

overridevirtual

Returns the sampler function.

Reimplemented from CubbyFlow::ScalarField< N >.

---

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

• Core/Field/ConstantScalarField.hpp