Diffpack Documentation

---

              Search  

---

FieldBob Class Reference

#include <FieldBob.h>

Inheritance diagram for FieldBob::

List of all members.

Public Methods
	FieldBob ()
	~FieldBob ()
bool	redim (const FieldBob &f)
bool	redim (int nx, int ny, int nz, real min, real max, real xmin, real ymin, real zmin, real dx, real dy, real dz)
virtual bool	ok () const
virtual void	minmax (NUMT &min, NUMT &max, GridWithPts *grid=NULL) const
virtual NUMT	valuePt (const Ptv(real) &x, real t=DUMMY)
void	operator= (const FieldLattice &fdfield)
void	operator= (const FieldFE &fdfield)
void	writeToBobFile (const String &filename)
void	put (real value, int i, int j, int k)
virtual NUMT&	valuePoint (int point_no)
virtual NUMT	valuePoint (int point_no) const
virtual Ptv(real)	getPt (int point_no) const
virtual int	getNoPoints () const
virtual int	getNoValues () const
virtual GridWithPts&	getGridWithPts ()
virtual const GridWithPts&	getGridWithPts () const
virtual Vec(NUMT)&	valuesVec ()
virtual const Vec(NUMT)&	valuesVec () const

---

Constructor & Destructor Documentation

FieldBob::FieldBob ( )

FieldBob::~FieldBob ( )

---

Member Function Documentation

const GridWithPts & FieldBob::getGridWithPts ( ) const [virtual]

See documentation of one of the overloaded functions. Reimplemented from FieldWithPtValues.

GridWithPts & FieldBob::getGridWithPts ( ) [virtual]

gives access to the grid object associated with the "FieldWithPtValues" object. The corresponding base class for grid with discrete points is "GridWithPts". Reimplemented from FieldWithPtValues.

int FieldBob::getNoPoints ( ) const [virtual]

returns the number of points in the grid. Reimplemented from FieldWithPtValues.

int FieldBob::getNoValues ( ) const [virtual]

returns the number of field values (usually equal to the number of points).`\footnote{`In a "GridLattice" grid one can think of a finite difference field defined at the cell centers. Then the number of grid points does not coincide with the number of field values. However, the field is typically characterized as being defined at a finite number of spatial points.`}` Reimplemented from FieldWithPtValues.

Ptv(real) FieldBob::getPt ( int point_no ) const [virtual]

returns the coordinate of a point. The point is given by its point number in the grid. Reimplemented from FieldWithPtValues.

void FieldBob::minmax ( NUMT & min, NUMT & max, GridWithPts * grid = NULL ) const [virtual]

finds the minimum and maximum values of the field. Most of the subclass fields have an internal grid and will find the extreme values over this grid. The "minmax" function has an optional argument "grid" that can be supplied. This grid is not used if the field has an internal grid. However, some fields, like "FieldFunc", do not have internal grids and in that case the "grid" argument is required in order to compute the extreme values. Reimplemented from Field.

bool FieldBob::ok ( ) const [virtual]

returns true if the object is initialized, for the base class "Field" it just writes an error messages such that if a derived class fails to define an "ok" function, an error message will be written. Reimplemented from Field.

void FieldBob::operator= ( const FieldFE & fdfield )

void FieldBob::operator= ( const FieldLattice & fdfield )

void FieldBob::put ( real value, int i, int j, int k )

bool FieldBob::redim ( int nx, int ny, int nz, real min, real max, real xmin, real ymin, real zmin, real dx, real dy, real dz )

bool FieldBob::redim ( const FieldBob & f )

NUMT FieldBob::valuePoint ( int point_no ) const [virtual]

See documentation of one of the overloaded functions. Reimplemented from FieldWithPtValues.

NUMT & FieldBob::valuePoint ( int point_no ) [virtual]

returns access to the field value at a spatial point. The point is given by its point number. (If the point is known by its coordinates and not the point number, one can use the "valuePt" function, see class "Field"). Reimplemented from FieldWithPtValues.

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

evaluates the field at a point in space and time. The time argument can be omitted, the default value is then "DUMMY". Generally, we suggest to use "DUMMY" to check if fields are stationary. Reimplemented from Field.

const Vec(NUMT) & FieldBob::valuesVec ( ) const [inline, virtual]

Reimplemented from FieldWithPtValues.

Vec(NUMT) & FieldBob::valuesVec ( ) [virtual]

Reimplemented from FieldWithPtValues.

void FieldBob::writeToBobFile ( const String & filename )

---

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

• FieldBob.h

---