Diffpack Documentation

Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members Search

FieldsBob Class Reference

collection of brick of bytes fields. More...

#include <FieldBob.h>

Inheritance diagram for FieldsBob::

Public Methods
	FieldsBob ()
void	redim (int nsf)
	FieldsBob (int nsf)
	FieldsBob (int nx, int ny, int nz, int nsf=1)
	FieldsBob (const FieldBob &field)
	~FieldsBob ()
FieldBob&	operator() (int i)
const FieldBob&	operator() (int i) const
void	attach (const FieldBob &field, int i=1)
int	getNoFields () const
bool	ok () const
Protected Attributes
VecSimplest(Handle(FieldBob))	fesfvec

Detailed Description

collection of brick of bytes fields.

NAME: FieldsBob - collection of brick of bytes fields

DESCRIPTION:

See class "FieldBob".

Constructor & Destructor Documentation

FieldsBob::FieldsBob ( ) [inline]

There are four constructors. Without any arguments the constructor needs to be supplemented by @redim first and then @attach for each scalar field member in the collection.
Another constructor takes the number of fields in the collection as argument and corresponds to the empty constructor plus the @redim function, that is, calls to @attach are necessary to initialize the object.
The third constructor takes a "FieldBob" argument and performs all the necessary initialiaztion. This constructor is identical to the empty constructor, "redim(1)" and one call to "attach".
Finally, the fourth constructor takes a grid argument and allocates memory for all the scalar fields in the collection. Coefficients in the field, associated with the grid, are allocated in the constructor of a single field. If the user already has these coefficients available in some array, he must first create single fields, utilizing the constructor of the single fields that can take advantage of such vectors, and then attach each single field to the present object.

FieldsBob::FieldsBob ( int nsf ) [inline]

See documentation of one of the overloaded constructor.

FieldsBob::FieldsBob ( int nx,

int ny,

int nz,

int nsf = 1 )

See documentation of one of the overloaded constructor.

FieldsBob::FieldsBob ( const FieldBob & field )

See documentation of one of the overloaded constructor.

FieldsBob::~FieldsBob ( ) [inline]

Member Function Documentation

void FieldsBob::attach ( const FieldBob & field,

int i = 1 ) [inline]

establishes connection with a "FieldBob" object to be regarded as the "i"th component of the vector field.

int FieldsBob::getNoFields ( ) const [inline]

returns the number of field components.

bool FieldsBob::ok ( ) const

returns true if the object is properly initialized.

const FieldBob & FieldsBob::operator() ( int i ) const [inline]

FieldBob & FieldsBob::operator() ( int i ) [inline]

void FieldsBob::redim ( int nsf ) [inline]

redimensions the vector field to hold the appropriate number of scalar components.

Member Data Documentation

VecSimplest(Handle(FieldBob)) FieldsBob::fesfvec [protected]

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

FieldBob.h