Diffpack Documentation

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

FieldsFV Class Reference

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

#include <FieldsFV.h>

Inheritance diagram for FieldsFV::

Public Methods
	FieldsFV ()
	FieldsFV (GridFV &grid, const char *fieldname)
	FieldsFV (GridFV &grid, int n, const char *fieldname_)
void	redim (int nsf, const char *fieldname)
bool	redim (GridFV &grid, const char *fieldname)
bool	redim (GridFV &grid, int n, const char *fieldname_)
	~FieldsFV ()
FieldFV&	operator() (int i)
const FieldFV&	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	valueDof (Ptv(NUMT) &vec, int dofno, real t=DUMMY) const
virtual void	valuePt (Ptv(NUMT) &vec, const Ptv(real) &x, real t=DUMMY)
void	magnitude (FieldFV &m)
Protected Attributes
VecSimplest(Handle(FieldFV))	fvsfvec

Detailed Description

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

NAME: FieldsFV - 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 "FieldFV" objects. We refer to the classes "Fields" and "FieldsWithPtValues" for documentation.

Constructor & Destructor Documentation

FieldsFV::FieldsFV ( ) [inline]

FieldsFV::FieldsFV ( GridFV & grid,

const char * fieldname )

FieldsFV::FieldsFV ( GridFV & grid,

int n,

const char * fieldname_ )

See documentation of one of the overloaded constructor.

FieldsFV::~FieldsFV ( ) [inline]

Member Function Documentation

void FieldsFV::attach ( Field & field,

int i = 1 ) [virtual]

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

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

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

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

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

void FieldsFV::fill ( const FieldsFunc & func,

real time = DUMMY )

Field * FieldsFV::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 FieldsFV::getNoFields ( ) const [inline, virtual]

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

int FieldsFV::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 FieldsFV::magnitude ( FieldFV & m )

computes the magnitude of the vector field as a "FieldFV" 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 FieldsFV::ok ( ) const [inline, virtual]

Reimplemented from Fields.

const FieldFV & FieldsFV::operator() ( int i ) const

FieldFV & FieldsFV::operator() ( int i )

bool FieldsFV::redim ( GridFV & grid,

int n,

const char * fieldname_ )

bool FieldsFV::redim ( GridFV & grid,

const char * fieldname )

void FieldsFV::redim ( int nsf,

const char * fieldname ) [virtual]

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

void FieldsFV::valueDof ( Ptv(NUMT) & vec,

int dofno,

real t = DUMMY ) const [virtual]

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

const Ptv(real) & x,

real t = DUMMY ) [virtual]

Reimplemented from Fields.

Member Data Documentation

VecSimplest(Handle(FieldFV)) FieldsFV::fvsfvec [protected]

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

FieldsFV.h