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

3-D constant scalar field. More...

#include <jet/constant_scalar_field3.h>

Inheritance diagram for jet::ConstantScalarField3:
jet::ScalarField3 jet::Field3

Classes

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

Public Member Functions

 ConstantScalarField3 (double value)
 Constructs a constant scalar field with given value. More...
 
double sample (const Vector3D &x) const override
 Returns the sampled value at given position x. More...
 
std::function< double(const Vector3D &)> sampler () const override
 Returns the sampler function. More...
 
- Public Member Functions inherited from jet::ScalarField3
 ScalarField3 ()
 Default constructor. More...
 
virtual ~ScalarField3 ()
 Default destructor. More...
 
virtual Vector3D gradient (const Vector3D &x) const
 Returns gradient vector at given position x. More...
 
virtual double laplacian (const Vector3D &x) const
 Returns Laplacian at given position x. More...
 
- Public Member Functions inherited from jet::Field3
 Field3 ()
 
virtual ~Field3 ()
 

Static Public Member Functions

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

Detailed Description

3-D constant scalar field.

Constructor & Destructor Documentation

◆ ConstantScalarField3()

jet::ConstantScalarField3::ConstantScalarField3 ( double  value)
explicit

Constructs a constant scalar field with given value.

Member Function Documentation

◆ builder()

static Builder jet::ConstantScalarField3::builder ( )
static

Returns builder fox ConstantScalarField3.

◆ sample()

double jet::ConstantScalarField3::sample ( const Vector3D x) const
overridevirtual

Returns the sampled value at given position x.

Implements jet::ScalarField3.

◆ sampler()

std::function<double(const Vector3D&)> jet::ConstantScalarField3::sampler ( ) const
overridevirtual

Returns the sampler function.

Reimplemented from jet::ScalarField3.


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