Diffpack Documentation

---

              Search  

---

HandleElmDefs Class Reference

a class that replaces Handle(ElmDef). More...

#include <HandleElmDefs.h>

List of all members.

Public Methods
	HandleElmDefs ()
	~HandleElmDefs ()
bool	refill (const String &elm_tp, int nsd)
bool	refill (const String &elm_tp)
bool	refill (const ElementType et_enum, int nsd)
bool	refill (const ElementType et_enum)
void	rebind (const ElmDef *p)
void	rebind (const ElmDef &p)
void	detach ()
bool	ok () const
bool	ok (const char *message) const
const ElmDef*	operator-> () const
const ElmDef&	operator() () const
const ElmDef&	operator * () const
const ElmDef*	getPtr () const
const ElmDef&	getRef () const
ElmDef*	operator-> ()
ElmDef&	operator() ()
ElmDef&	operator * ()
ElmDef*	getPtr ()
ElmDef&	getRef ()
void	operator= (const HandleElmDefs &h)
Public Attributes
Handle(ElmDef)	elmdef
Protected Attributes
String	elm_tp
ElementType	et_enum
int	nsd
Handle(ElmDef_prm)	elm_prm

---

Detailed Description

a class that replaces Handle(ElmDef).

NAME: HandleElmDefs - a class that replaces Handle(ElmDef)

DESCRIPTION:

Declaration and application of a finite element object (from the "ElmDef" hierarchy) are handled by the "HandleElmDefs" class. This class contains information about the current element being handled, such that creation of a new identical element can be avoided. One can say that "HandleElmDefs" is a combination of a "Handle(ElmDef)" and an "ElmDef_prm" class (with an understanding of handles and parameter classes in Diffpack, this information should explain the basic purpose of class "HandleElmDefs").

Having a "HandleElmDefs" object, one just calls the "refill" object to create a new element (and if the element is already created and therefore can be reused, "refill" is smart enough to take advantage of this knowledge).

To extend the library with new element types/element classes, see the class "ElmDef_prm".

---

Constructor & Destructor Documentation

HandleElmDefs::HandleElmDefs ( ) [inline]

Only an empty constructor is provided. To initialize the pointer in this handle, the "refill" member functions should be called.

HandleElmDefs::~HandleElmDefs ( ) [inline]

---

Member Function Documentation

void HandleElmDefs::detach ( ) [inline]

ElmDef * HandleElmDefs::getPtr ( ) [inline]

const ElmDef * HandleElmDefs::getPtr ( ) const [inline]

ElmDef & HandleElmDefs::getRef ( ) [inline]

const ElmDef & HandleElmDefs::getRef ( ) const [inline]

bool HandleElmDefs::ok ( const char * message ) const [inline]

bool HandleElmDefs::ok ( ) const [inline]

ElmDef & HandleElmDefs::operator * ( ) [inline]

const ElmDef & HandleElmDefs::operator * ( ) const [inline]

ElmDef & HandleElmDefs::operator() ( ) [inline]

const ElmDef & HandleElmDefs::operator() ( ) const [inline]

ElmDef * HandleElmDefs::operator-> ( ) [inline]

const ElmDef * HandleElmDefs::operator-> ( ) const [inline]

void HandleElmDefs::operator= ( const HandleElmDefs & h ) [inline]

void HandleElmDefs::rebind ( const ElmDef & p ) [inline]

void HandleElmDefs::rebind ( const ElmDef * p ) [inline]

bool HandleElmDefs::refill ( const ElementType et_enum )

See documentation of one of the overloaded functions.

bool HandleElmDefs::refill ( const ElementType et_enum, int nsd )

See documentation of one of the overloaded functions.

bool HandleElmDefs::refill ( const String & elm_tp )

See documentation of one of the overloaded functions.

bool HandleElmDefs::refill ( const String & elm_tp, int nsd )

on basis of the element type (and the number of space dimensions if the element is of tensor product type and defined in an arbitrary number of space dimensions) the function ensures that the pointer in this handle points to an element of the specified type. The "refill" which use the enum variable ElementType as argument is more efficient then the corresponding "refill" which use a String.

---

Member Data Documentation

Handle(ElmDef_prm) HandleElmDefs::elm_prm [protected]

String HandleElmDefs::elm_tp [protected]

Handle(ElmDef) HandleElmDefs::elmdef

ElementType HandleElmDefs::et_enum [protected]

int HandleElmDefs::nsd [protected]

---

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

• HandleElmDefs.h

---