Diffpack Documentation

---

              Search  

---

BellFunc Class Reference

functor (derived from FieldFunc) for bell function. More...

#include <FieldFunc.h>

Inheritance diagram for BellFunc::

List of all members.

Public Methods
	BellFunc ()
	BellFunc (const VecSimple(real) &parameters)
void	setParameters (const VecSimple(real) &parameters)
virtual NUMT	operator() (const Ptv(real) &x, real t) const
virtual NUMT	valuePt (const Ptv(real) &x, real t=DUMMY)

---

Detailed Description

functor (derived from FieldFunc) for bell function.

NAME: BellFunc - functor (derived from FieldFunc) for bell function

DESCRIPTION:

The class is a predefined functor for the Gaussian bell function. The parameters reflect the position (the d first values) and the width (the next d values, where d is the number of space dimensions); It is convenient to read the parameters and the functor name using "FieldFormat" (the data member "function_prm" can be fed directly into the this functor).

---

Constructor & Destructor Documentation

BellFunc::BellFunc ( )

There are two ways to initialize a "BellFunc" object: 1) call "BellFunc(prms)", where "prms" is a vector of parameters, or 2) first declare an empty object using the constructor without arguments and then call "setParameters(prms)". Thereafter one can evaluate the function using "operator()" or "valuePt".

BellFunc::BellFunc ( const VecSimple(real) & parameters )

See documentation of one of the overloaded constructor.

---

Member Function Documentation

NUMT BellFunc::operator() ( const Ptv(real) & x, real t ) const [inline, virtual]

Reimplemented from FieldFunc.

void BellFunc::setParameters ( const VecSimple(real) & parameters )

NUMT BellFunc::valuePt ( const Ptv(real) & x, real t = DUMMY ) [virtual]

evaluates the function. This is a non-const function and it is also virtual in the "Field" base class. Reimplemented from FieldFunc.

---

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

• FieldFunc.h

---