Main Page   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages   Examples  

BoundaryCellSet.h

Go to the documentation of this file.
00001 #ifndef BOUNDARYCELLSET_H
00002 #define BOUNDARYCELLSET_H
00003 
00004 #include "SundanceDefs.h"
00005 
00006 #include <string>
00007 #include "CellSetBase.h"
00008 
00009 
00010 namespace Sundance
00011 {
00012 
00013   using namespace TSF;
00014   using std::string;
00015 
00016   using std::ostream;
00017 
00018   /** \ingroup UserLevelGeometry
00019    * BoundaryCellSet is a CellSet that includes all boundary cells
00020    * of dimension one less than the maximal cell dimension.
00021    */
00022 
00023   class BoundaryCellSet : public CellSetBase
00024     {
00025     public:
00026       /** constructor needs no arguments */
00027       BoundaryCellSet() : CellSetBase() {;}
00028 
00029       /** dtor */
00030       virtual ~BoundaryCellSet(){;}
00031 
00032       /** determine if a cell is contained in this set */
00033       virtual bool contains(const Cell& cell) const ;
00034 
00035       /** write self to XML */
00036       virtual XMLObject toXML() const ;
00037 
00038       /** find the cell dimensions that should be searched to find cells
00039        * in this set */
00040       virtual int dimension(const Mesh& mesh) const ;
00041 
00042 
00043       /** test equality */
00044       virtual bool equals(const CellSet& other) const {return true;}
00045 
00046       /** test ordering */
00047       virtual bool lessThan(const CellSet& other) const {return false;}
00048 
00049     protected:
00050       /** low-level routine to find an ordered list of cells */
00051       virtual TSFSmartPtr<TSFArray<Cell> >
00052         innerGetOrderedCells(const Mesh& mesh) const ;
00053     private:
00054     };
00055 }
00056 
00057 #endif

Contact:
Kevin Long (krlong@ca.sandia.gov)


Documentation generated by