Jet  v1.3.3
Classes | Public Member Functions | Static Public Member Functions | List of all members
jet::ConstantScalarField2 Class Referencefinal

2-D constant scalar field. More...

#include <jet/constant_scalar_field2.h>

Inheritance diagram for jet::ConstantScalarField2:
jet::ScalarField2 jet::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 jet::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 jet::Field2
 Field2 ()
 
virtual ~Field2 ()
 

Static Public Member Functions

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

Detailed Description

2-D constant scalar field.

Constructor & Destructor Documentation

◆ ConstantScalarField2()

jet::ConstantScalarField2::ConstantScalarField2 ( double  value)
explicit

Constructs a constant scalar field with given value.

Member Function Documentation

◆ builder()

static Builder jet::ConstantScalarField2::builder ( )
static

Returns builder fox ConstantScalarField2.

◆ sample()

double jet::ConstantScalarField2::sample ( const Vector2D x) const
overridevirtual

Returns the sampled value at given position x.

Implements jet::ScalarField2.

◆ sampler()

std::function<double(const Vector2D&)> jet::ConstantScalarField2::sampler ( ) const
overridevirtual

Returns the sampler function.

Reimplemented from jet::ScalarField2.


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