CubbyFlow::ConstantScalarField2 Class Referencefinal

2-D constant scalar field. More...

#include <Core/Field/ConstantScalarField2.h>

Inheritance diagram for CubbyFlow::ConstantScalarField2:
CubbyFlow::ScalarField2 CubbyFlow::Field2

Classes

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

Public Member Functions

 ConstantScalarField2 (double value)
 Constructs a constant scalar field with given value. More...
 
double Sample (const Vector2D &x) const override
 Returns the sampled value at given position x. More...
 
std::function< double(const Vector2D &)> Sampler () const override
 Returns the sampler function. More...
 
- Public Member Functions inherited from CubbyFlow::ScalarField2
 ScalarField2 ()
 Default constructor. More...
 
virtual ~ScalarField2 ()
 Default destructor. More...
 
virtual Vector2D Gradient (const Vector2D &x) const
 Returns gradient vector at given position x. More...
 
virtual double Laplacian (const Vector2D &x) const
 Returns Laplacian at given position x. More...
 
- Public Member Functions inherited from CubbyFlow::Field2
 Field2 ()
 
virtual ~Field2 ()
 

Static Public Member Functions

static Builder GetBuilder ()
 Returns builder fox ConstantScalarField2. More...
 

Detailed Description

2-D constant scalar field.

Constructor & Destructor Documentation

◆ ConstantScalarField2()

CubbyFlow::ConstantScalarField2::ConstantScalarField2 ( double  value)
explicit

Constructs a constant scalar field with given value.

Member Function Documentation

◆ GetBuilder()

static Builder CubbyFlow::ConstantScalarField2::GetBuilder ( )
static

Returns builder fox ConstantScalarField2.

◆ Sample()

double CubbyFlow::ConstantScalarField2::Sample ( const Vector2D x) const
overridevirtual

Returns the sampled value at given position x.

Implements CubbyFlow::ScalarField2.

◆ Sampler()

std::function<double(const Vector2D&)> CubbyFlow::ConstantScalarField2::Sampler ( ) const
overridevirtual

Returns the sampler function.

Reimplemented from CubbyFlow::ScalarField2.


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