The Face class is an abstract base class that supplies implemented general methods, as well as a vew virtual interface methods to child classes. More...

#include <Face.hpp>

Inheritance diagram for Face:

[legend]

Collaboration diagram for Face:

[legend]

Public Types
enum	Type { e_tri, e_quad, e_MAX_TYPE }

enum	eType { e_tet, e_hex, e_tri_cohesive, e_quad_cohesive, e_MAX_ELEMENT_TYPE }

Public Member Functions
	Face (Type type)
	Constructor: set type & reset params. More...

	Face ()

	~Face ()
	Destructor. More...

void	setID (int theID)
	Sets the serial ID for the face. More...

int	getID () const
	Returns the serial ID of the face. More...

void	setFlag (int theFlag)
	Sets the flag for the face. More...

int	getFlag () const
	Gets the flag for the face. More...

virtual int	getNumNodes () const =0
	Retrieves the number of nodes that make up the face. More...

Node **	getNodes ()
	Returns the array of nodes. More...

void	setElement1 (Element *elem1)
	Sets the pointer to the first element that this face is associated with. More...

Element *	getElement1 ()
	Get the pointer to the first element that this face is associated with. More...

void	setElement2 (Element *elem2)
	Sets the pointer to the second element that this face is associated with. More...

Element *	getElement2 ()
	Get the pointer to the second element that this face is associated with. More...

void	addElement (Element *theElement)

void	removeElement (Element *theElement)

Type	getFaceType () const
	Returns the face type of this face (see the Type attribute of the Face class). More...

boolean	isExterior () const

virtual Element *	buildCohesive (Element side_elem, Node node, Node *new_node)=0

void	replaceNode (Node node, Node new_node)

boolean	containsNode (Node *node) const

Static Public Member Functions
static Face *	create (eType type)

static void	setMesh (Mesh *emesh)

Protected Attributes
int	d_ID
	Serial ID assigned to this face. More...

int	d_flag
	User-defined integer flag assigned to this face. More...

Element *	d_E1
	Pointer to the first element that this face is associated with. More...

Element *	d_E2
	The second element that this face is associated with. More...

Node **	d_nodes
	Array of nodes assigned to this face. More...

Type	d_eType
	The Type of face (triangular or square for now). More...

Static Protected Attributes
static Mesh *	s_mesh = 0

Friends
istream &	operator>> (istream &stream, Face &face)

ostream &	operator<< (ostream &stream, Face &face)

Detailed Description

The Face class is an abstract base class that supplies implemented general methods, as well as a vew virtual interface methods to child classes.

It represents one face of a mesh element. It knows the nodes that make it up, and the elements that it is a part of. It knows whether or not it is on the surface of the mesh.

Author: Mark Brandyberry

Version: 1.0

Since: 2001

Definition at line 19 of file Face.hpp.

Member Enumeration Documentation

enum eType

Enumerator
e_tet
e_hex
e_tri_cohesive
e_quad_cohesive
e_MAX_ELEMENT_TYPE

Definition at line 24 of file Face.hpp.

                    {
         e_tet,      // 0
         e_hex,      // 1
         e_tri_cohesive,  // 2
         e_quad_cohesive,  // 3
         e_MAX_ELEMENT_TYPE
         };

enum Type

Enumerator
e_tri
e_quad
e_MAX_TYPE

Definition at line 22 of file Face.hpp.

22 {e_tri,e_quad,e_MAX_TYPE};

Face::e_tri

Definition: Face.hpp:22

Face::e_MAX_TYPE

Definition: Face.hpp:22

Face::e_quad

Definition: Face.hpp:22

Constructor & Destructor Documentation

Face ( Face::Type ftype )

Constructor: set type & reset params.

Definition at line 10 of file Face.cpp.

                         :
   d_ID(-1),
   d_flag(-1),
   d_E1(0),
   d_E2(0),
   d_nodes(0),
   d_eType( ftype )
 {}

Face ( )

Definition at line 19 of file Face.cpp.

           :
   d_ID(-1),
   d_flag(-1),
   d_E1(0),
   d_E2(0),
   d_nodes(0)
 {}

~Face ( )

Destructor.

when here face should not be in any element

Definition at line 27 of file Face.cpp.

References d_nodes.

            {
 
   if( d_nodes ){
     delete [] d_nodes;
   }
 }

Member Function Documentation

void addElement ( Element * theElement )

inline

Definition at line 200 of file Face.hpp.

References d_E1, and d_E2.

Referenced by Element::setFace().

                                                 { 
   if( d_E1 ){
     d_E2 = theElement;
   }
   else {
     d_E1 = theElement;
   }
 }

Here is the caller graph for this function:

virtual Element* buildCohesive	(	Element *	side_elem,
		Node *	node,
		Node *	new_node
	)

pure virtual

Implemented in QuadFace, and TriFace.

Referenced by Mesh::replaceNode().

Here is the caller graph for this function:

boolean containsNode ( Node * node ) const

Definition at line 108 of file Face.cpp.

References d_nodes, FALSE, getNumNodes(), i, and TRUE.

Referenced by Mesh::replaceNode().

                                              {
 
   int i;
   int numn = getNumNodes();
   for( i = 0; i< numn; i++ ){
     if( d_nodes[i] == node ){
       return TRUE;
     }
   }
   return FALSE;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

Face * create ( Face::eType type )

static

Definition at line 34 of file Face.cpp.

References e_hex, e_quad_cohesive, e_tet, e_tri_cohesive, and face.

Referenced by operator>>().

                                  {
 
   Face *face;  
 
   switch( type ){
   case e_hex:
     face = new QuadFace();
     break;
   case e_tet:
     face = new TriFace();
     break;
   case e_tri_cohesive:
     face = new TriFace();
     break;
   case e_quad_cohesive:
     face = new QuadFace();
     break;
   default:
     cerr << "BUG: Illegal element type in Face::create " << type << endl;
   }
   
   return face;
 }

Here is the caller graph for this function:

Element * getElement1 ( )

inline

Get the pointer to the first element that this face is associated with.

Definition at line 191 of file Face.hpp.

References d_E1.

Referenced by Mesh::addCohesive(), Node::getSeparateElements(), Mesh::replaceNode(), and Mesh::write_boundary().

192 { return d_E1; }

Face::d_E1

Element * d_E1

Pointer to the first element that this face is associated with.

Definition: Face.hpp:147

Here is the caller graph for this function:

Element * getElement2 ( )

inline

Get the pointer to the second element that this face is associated with.

Definition at line 197 of file Face.hpp.

References d_E2.

Referenced by Mesh::addCohesive(), Node::getSeparateElements(), and Mesh::replaceNode().

198 { return d_E2; }

Face::d_E2

Element * d_E2

The second element that this face is associated with.

Definition: Face.hpp:154

Here is the caller graph for this function:

Face::Type getFaceType ( ) const

inline

Returns the face type of this face (see the Type attribute of the Face class).

Definition at line 209 of file Face.hpp.

References d_eType.

210 { return d_eType; }

Face::d_eType

Type d_eType

The Type of face (triangular or square for now).

Definition: Face.hpp:166

int getFlag ( ) const

inline

Gets the flag for the face.

Will return -1 if it was not set.

Definition at line 182 of file Face.hpp.

References d_flag.

Referenced by Mesh::write_boundary().

183 { return d_flag; }

Face::d_flag

int d_flag

User-defined integer flag assigned to this face.

Definition: Face.hpp:141

Here is the caller graph for this function:

int getID ( ) const

inline

Returns the serial ID of the face.

Will return -1 if it was not set.

Definition at line 176 of file Face.hpp.

References d_ID.

177 { return d_ID; }

Face::d_ID

int d_ID

Serial ID assigned to this face.

Definition: Face.hpp:136

Node ** getNodes ( )

inline

Returns the array of nodes.

Definition at line 185 of file Face.hpp.

References d_nodes.

Referenced by Mesh::addCohesive(), operator>>(), and Node::sharedFace().

186 { return d_nodes; }

Face::d_nodes

Node ** d_nodes

Array of nodes assigned to this face.

Definition: Face.hpp:161

Here is the caller graph for this function:

virtual int getNumNodes ( ) const

pure virtual

Retrieves the number of nodes that make up the face.

Will be either three or four depending upon the face type.

Implemented in QuadFace, and TriFace.

Referenced by Mesh::addCohesive(), containsNode(), operator>>(), replaceNode(), and Node::sharedFace().

Here is the caller graph for this function:

boolean isExterior ( ) const

inline

Definition at line 212 of file Face.hpp.

References d_E2, FALSE, and TRUE.

213 { return (d_E2 == 0 ? TRUE : FALSE); }

FALSE

#define FALSE

Definition: vinci.h:133

Face::d_E2

Element * d_E2

The second element that this face is associated with.

Definition: Face.hpp:154

TRUE

#define TRUE

Definition: vinci.h:134

void removeElement ( Element * theElement )

Definition at line 81 of file Face.cpp.

References d_E1, and d_E2.

Referenced by HexElement::~HexElement(), QCoElement::~QCoElement(), TCoElement::~TCoElement(), and TetElement::~TetElement().

                                             {
 
   if( theElement == d_E1 ){
     d_E1 = d_E2;
     d_E2 = 0;
   }
   else if( theElement == d_E2 ){
     d_E2 = 0;
   }
 }

Here is the caller graph for this function:

void replaceNode	(	Node *	node,
		Node *	new_node
	)

Definition at line 93 of file Face.cpp.

References Node::addFace(), d_nodes, getNumNodes(), i, and Node::removeFace().

Referenced by QCoElement::replaceFaceNode(), TCoElement::replaceFaceNode(), and Element::replaceNode().

                                                    {
 
   int i;
   int numn = getNumNodes();
   for( i = 0; i< numn; i++ ){
     if( d_nodes[i] == node ){
       d_nodes[i] = new_node;
       node->removeFace( this );
       new_node->addFace( this );
     }
   }
 }

Here is the call graph for this function:

Here is the caller graph for this function:

void setElement1 ( Element * elem1 )

inline

Sets the pointer to the first element that this face is associated with.

Definition at line 188 of file Face.hpp.

References d_E1.

189 { d_E1 = elem1; }

Face::d_E1

Element * d_E1

Pointer to the first element that this face is associated with.

Definition: Face.hpp:147

void setElement2 ( Element * elem2 )

inline

Sets the pointer to the second element that this face is associated with.

Definition at line 194 of file Face.hpp.

References d_E2.

195 { d_E2 = elem2; }

Face::d_E2

Element * d_E2

The second element that this face is associated with.

Definition: Face.hpp:154

void setFlag ( int theFlag )

inline

Sets the flag for the face.

Will return -1 if it was not set.

Definition at line 179 of file Face.hpp.

References d_flag.

Referenced by operator>>().

180 { d_flag = theFlag; }

Face::d_flag

int d_flag

User-defined integer flag assigned to this face.

Definition: Face.hpp:141

Here is the caller graph for this function:

void setID ( int theID )

inline

Sets the serial ID for the face.

Definition at line 173 of file Face.hpp.

References d_ID.

Referenced by Mesh::addFace(), and Mesh::removeFace().

174 { d_ID = theID; }

Face::d_ID

int d_ID

Serial ID assigned to this face.

Definition: Face.hpp:136

Here is the caller graph for this function:

void setMesh ( Mesh * emesh )

inlinestatic

Definition at line 215 of file Face.hpp.

References s_mesh.

Referenced by Mesh::Mesh().

216 { s_mesh = fmesh; }

Face::s_mesh

static Mesh * s_mesh

Definition: Face.hpp:168

Here is the caller graph for this function:

Friends And Related Function Documentation

ostream& operator<<	(	ostream &	stream,
		Face &	face
	)

friend

Definition at line 59 of file Face.cpp.

                                                 {
 
   return stream;
 }

istream& operator>>	(	istream &	stream,
		Face &	face
	)

friend

Definition at line 64 of file Face.cpp.

                                                 {
 
   // read nodes & set
 
   int numn = face.getNumNodes();
   int i;
   for( i = 0; i < numn; i++ ){
     int node_id;
     stream >> node_id;
     Node *node = face.s_mesh->getNode(node_id);
     face.d_nodes[i] = node;
   }
   
   return stream;
 
 }

Member Data Documentation

Element* d_E1

protected

Pointer to the first element that this face is associated with.

A face will always have at least one element.

Definition at line 147 of file Face.hpp.

Referenced by addElement(), TriFace::buildCohesive(), QuadFace::buildCohesive(), getElement1(), removeElement(), and setElement1().

Element* d_E2

protected

The second element that this face is associated with.

This element will be Null if the face is an exterior face. This face will have a normal opposite of the one for the element in E2.

Definition at line 154 of file Face.hpp.

Referenced by addElement(), TriFace::buildCohesive(), QuadFace::buildCohesive(), getElement2(), isExterior(), removeElement(), and setElement2().

Type d_eType

protected

The Type of face (triangular or square for now).

Definition at line 166 of file Face.hpp.

Referenced by getFaceType().

int d_flag

protected

User-defined integer flag assigned to this face.

Definition at line 141 of file Face.hpp.

Referenced by getFlag(), and setFlag().

int d_ID

protected

Serial ID assigned to this face.

Definition at line 136 of file Face.hpp.

Referenced by getID(), and setID().

Node** d_nodes

protected

Array of nodes assigned to this face.

The number of nodes will depend on the type of face.

Definition at line 161 of file Face.hpp.

Referenced by TriFace::buildCohesive(), QuadFace::buildCohesive(), containsNode(), getNodes(), operator>>(), QuadFace::QuadFace(), replaceNode(), TriFace::TriFace(), ~Face(), QuadFace::~QuadFace(), and TriFace::~TriFace().

Mesh * s_mesh = 0

staticprotected

Definition at line 168 of file Face.hpp.

Referenced by operator>>(), and setMesh().

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Static Protected Attributes

Friends

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation