Diffpack Documentation

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

FieldsLattice Class Reference

collection of finite difference scalar fields (ie. vector field). More...

#include <FieldsLattice.h>

Inheritance diagram for FieldsLattice::

Public Methods
	FieldsLattice ()
	FieldsLattice (GridLattice &grid, const char *fieldname)
	FieldsLattice (GridLattice &grid, int n, const char *fieldname_)
void	redim (int nsf, const char *fieldname)
bool	redim (GridLattice &grid, const char *fieldname)
bool	redim (GridLattice &grid, int n, const char *fieldname_)
	~FieldsLattice ()
FieldLattice&	operator() (int i)
const FieldLattice&	operator() (int i) const
virtual FieldWithPtValues&	component (int i)
virtual const FieldWithPtValues&	component (int i) const
virtual Field*	getFieldBase (int i=1) const
virtual void	attach (Field &field, int i=1)
void	fill (const FieldsFunc &func, real time=DUMMY)
virtual bool	ok () const
virtual int	getNoFields () const
virtual int	getNoValues () const
virtual void	valuePt (Ptv(NUMT) &vec, const Ptv(real) &x, real t=DUMMY)
void	valueIndex (Ptv(NUMT) &vec, const Ptv(int) idx) const
void	magnitude (FieldLattice &m)
Protected Attributes
VecSimplest(Handle(FieldLattice))	fdsfvec

Detailed Description

collection of finite difference scalar fields (ie. vector field).

NAME: FieldsLattice - collection of finite difference scalar fields (ie. vector field)

DESCRIPTION:

The class implements a vector field suited for finite difference methods. The vector field is simply a collection of scalar finite difference fields, or more precisely, an array of handles (pointers) to "FieldLattice" objects. We refer to the classes "Fields" and "FieldsWithPtValues" for documentation.

Constructor & Destructor Documentation

FieldsLattice::FieldsLattice ( ) [inline]

FieldsLattice::FieldsLattice ( GridLattice & grid,

const char * fieldname )

FieldsLattice::FieldsLattice ( GridLattice & grid,

int n,

const char * fieldname_ )

See documentation of one of the overloaded constructor.

FieldsLattice::~FieldsLattice ( ) [inline]

Member Function Documentation

void FieldsLattice::attach ( Field & field,

int i = 1 ) [virtual]

attaches a scalar field as component number "i" in the vector field.
Reimplemented from Fields.

const FieldWithPtValues & FieldsLattice::component ( int i ) const [virtual]

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

FieldWithPtValues & FieldsLattice::component ( int i ) [virtual]

gives access to a scalar component in the vector field.
Reimplemented from FieldsWithPtValues.

void FieldsLattice::fill ( const FieldsFunc & func,

real time = DUMMY )

Field * FieldsLattice::getFieldBase ( int i = 1 ) const [inline, virtual]

returns a "Field" base class pointer for component number "i" in the vector field. Used when reading/writing vector fields from/to SimRes files. This function will return a "NULL" pointer in some subclasses of "Fields" that are not represented as a vector of scalar fields.
Reimplemented from Fields.

int FieldsLattice::getNoFields ( ) const [inline, virtual]

returns the number of scalar fields that make up the vector field.
Reimplemented from Fields.

int FieldsLattice::getNoValues ( ) const [virtual]

returns the total number of degrees of freedom in the vector field. For example, for a 3D velocity field, represented in terms of trilinear finite elements with X nodes, the "getNoValues" function should return "3*X".
Reimplemented from Fields.

void FieldsLattice::magnitude ( FieldLattice & m )

computes the magnitude of the vector field as a "FieldLattice" object. The magnitude is simply the Eucledian norm of the vector (at each node). The argument (result) field "m" will be automatically initialized in "magnitude" (by a relevant "redim" call) if the field is empty at input.

bool FieldsLattice::ok ( ) const [inline, virtual]

Reimplemented from Fields.

const FieldLattice & FieldsLattice::operator() ( int i ) const

FieldLattice & FieldsLattice::operator() ( int i )

bool FieldsLattice::redim ( GridLattice & grid,

int n,

const char * fieldname_ )

bool FieldsLattice::redim ( GridLattice & grid,

const char * fieldname )

void FieldsLattice::redim ( int nsf,

const char * fieldname ) [virtual]

redimensions the number of scalar fields that make up the vector field.
Reimplemented from Fields.

void FieldsLattice::valueIndex ( Ptv(NUMT) & vec,

const Ptv(int) idx ) const

evaluates the field at a given index in space.

void FieldsLattice::valuePt ( Ptv(NUMT) & vec,

const Ptv(real) & x,

real t = DUMMY ) [virtual]

Reimplemented from Fields.

Member Data Documentation

VecSimplest(Handle(FieldLattice)) FieldsLattice::fdsfvec [protected]

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

FieldsLattice.h