Overture  Version 25
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Region Class Referenceabstract

Base class for regions. More...

#include <smesh.hh>

Inheritance diagram for Region:
Inheritance graph
[legend]
Collaboration diagram for Region:
Collaboration graph
[legend]

Public Types

typedef std::vector< Curve * >
::iterator 
curve_iterator
 

Public Member Functions

 Region (real dx=.1, real dy=.1, std::string nm="")
 
virtual ~Region ()
 
void addCurve (Curve *c)
 add a curve to the region, resetting the reference grid accordingly
 
void delCurve (Curve *c)
 delete a curve from the region
 
curve_iterator curve_begin ()
 
curve_iterator curve_end ()
 
int numberOfCurves () const
 
virtual int numberOfVertices ()=0
 
virtual int numberOfElements ()=0
 
virtual ArraySimpleFixed< int, 4, 1, 1, 1 > getElement (int e)=0
 
virtual Mapping & getMapping ()=0
 
virtual ArraySimple< int > & getGridIDList ()=0
 
virtual ArraySimple< real > & getVertices ()=0
 
virtual void resetIDList ()
 
const SquareMapping & getReferenceGrid () const
 get the reference grid used to guide the mesh spacing
 
real getDx () const
 
real getDy () const
 
void setDx (real d)
 
void setDy (real d)
 
std::string getName () const
 
void setName (std::string nm)
 
int ID () const
 

Protected Member Functions

void specifyReferenceGridBounds (real x1, real y1, real x2, real y2)
 
void resetReferenceGrid ()
 

Protected Attributes

real dxRef
 
real dyRef
 
ArraySimple< int > gridIDList
 

Detailed Description

Base class for regions.

Member Typedef Documentation

typedef std::vector<Curve *>::iterator Region::curve_iterator

Constructor & Destructor Documentation

Region::Region ( real  dx = .1,
real  dy = .1,
std::string  nm = "" 
)
inline

References dx.

virtual Region::~Region ( )
inlinevirtual

Member Function Documentation

void Region::addCurve ( Curve *  c)
inline

add a curve to the region, resetting the reference grid accordingly

References Curve::getRangeBound(), SquareMapping::getVertices(), max(), min(), Curve::region_1(), Curve::region_2(), and specifyReferenceGridBounds().

curve_iterator Region::curve_begin ( )
inline

Referenced by ~Region().

curve_iterator Region::curve_end ( )
inline

Referenced by ~Region().

void Region::delCurve ( Curve *  c)
inline

delete a curve from the region

References Curve::unbindRegion().

Referenced by ~Region().

real Region::getDx ( ) const
inline

References dxRef.

real Region::getDy ( ) const
inline

References dyRef.

virtual ArraySimpleFixed<int,4,1,1,1> Region::getElement ( int  e)
pure virtual

Implemented in UnstructuredRegion, and TFIRegion.

virtual ArraySimple<int>& Region::getGridIDList ( )
pure virtual

Implemented in UnstructuredRegion, and TFIRegion.

virtual Mapping& Region::getMapping ( )
pure virtual

Implemented in UnstructuredRegion, and TFIRegion.

std::string Region::getName ( ) const
inline

Referenced by main().

const SquareMapping& Region::getReferenceGrid ( ) const
inline

get the reference grid used to guide the mesh spacing

virtual ArraySimple<real>& Region::getVertices ( )
pure virtual

Implemented in UnstructuredRegion, and TFIRegion.

int Region::ID ( ) const
inline

Referenced by main().

int Region::numberOfCurves ( ) const
inline
virtual int Region::numberOfElements ( )
pure virtual

Implemented in UnstructuredRegion, and TFIRegion.

virtual int Region::numberOfVertices ( )
pure virtual

Implemented in UnstructuredRegion, and TFIRegion.

virtual void Region::resetIDList ( )
inlinevirtual

References gridIDList.

void Region::resetReferenceGrid ( )
protected

Referenced by setDx(), and setDy().

void Region::setDx ( real  d)
inline

References dxRef, and resetReferenceGrid().

void Region::setDy ( real  d)
inline

References dyRef, and resetReferenceGrid().

void Region::setName ( std::string  nm)
inline

Referenced by main().

void Region::specifyReferenceGridBounds ( real  x1,
real  y1,
real  x2,
real  y2 
)
protected

Referenced by addCurve().

Member Data Documentation

real Region::dxRef
protected

Referenced by getDx(), and setDx().

real Region::dyRef
protected

Referenced by getDy(), and setDy().

ArraySimple<int> Region::gridIDList
protected

Referenced by resetIDList().


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