00001 /* @HEADER@ */ 00002 // ************************************************************************ 00003 // 00004 // Sundance 00005 // Copyright (2005) Sandia Corporation 00006 // 00007 // Copyright (year first published) Sandia Corporation. Under the terms 00008 // of Contract DE-AC04-94AL85000 with Sandia Corporation, the U.S. Government 00009 // retains certain rights in this software. 00010 // 00011 // This library is free software; you can redistribute it and/or modify 00012 // it under the terms of the GNU Lesser General Public License as 00013 // published by the Free Software Foundation; either version 2.1 of the 00014 // License, or (at your option) any later version. 00015 // 00016 // This library is distributed in the hope that it will be useful, but 00017 // WITHOUT ANY WARRANTY; without even the implied warranty of 00018 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 00019 // Lesser General Public License for more details. 00020 // 00021 // You should have received a copy of the GNU Lesser General Public 00022 // License along with this library; if not, write to the Free Software 00023 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 00024 // USA 00025 // Questions? Contact Kevin Long (krlong@sandia.gov), 00026 // Sandia National Laboratories, Livermore, California, USA 00027 // 00028 // ************************************************************************ 00029 /* @HEADER@ */ 00030 00031 #ifndef SUNDANCE_CELLSETBASE_H 00032 #define SUNDANCE_CELLSETBASE_H 00033 00034 #include "SundanceDefs.hpp" 00035 #include "SundanceSet.hpp" 00036 #include "SundanceMap.hpp" 00037 #include "SundanceCellType.hpp" 00038 #include "SundanceCellIterator.hpp" 00039 #include "Teuchos_RefCountPtr.hpp" 00040 #include "SundanceMesh.hpp" 00041 #include "SundanceNoncopyable.hpp" 00042 #include "PlayaHandleable.hpp" 00043 #include "PlayaHandle.hpp" 00044 00045 namespace Sundance 00046 { 00047 using namespace Teuchos; 00048 00049 /** 00050 * CellSetBase is the base class for cell sets. There are two cell 00051 * set subtypes: ExplicitCellSet and ImplicitCellSet. 00052 * 00053 * @see CellFilter 00054 **/ 00055 class CellSetBase : public ObjectWithClassVerbosity<CellSetBase>, 00056 public Playa::Printable, 00057 public Noncopyable, 00058 public Playa::Handleable<CellSetBase> 00059 { 00060 public: 00061 /** Construct, initializing to an empty set */ 00062 CellSetBase(const Mesh& mesh, int cellDim, 00063 const CellType& cellType); 00064 00065 /** Return an iterator pointing to the first element in the set */ 00066 virtual CellIterator begin() const = 0 ; 00067 00068 /** Return an iterator containing the past-the-end value */ 00069 virtual CellIterator end() const = 0 ; 00070 00071 /** Return the type of cells in this set */ 00072 const CellType& cellType(const CellType& cellType) const 00073 {return cellType_;} 00074 00075 /** The ID number of the mesh in which these cells exist */ 00076 int meshID() const {return mesh_.id();} 00077 00078 /** The dimension of the cells contained in this set */ 00079 int dimension() const {return dim_;} 00080 00081 /** The mesh in which these cells exist */ 00082 const Mesh& mesh() const {return mesh_;} 00083 00084 /** The type of the cells contained in this set */ 00085 const CellType& cellType() const {return cellType_;} 00086 00087 /** */ 00088 bool lessThan(const CellSetBase* other) const ; 00089 00090 /** */ 00091 virtual bool internalLessThan(const CellSetBase* other) const = 0 ; 00092 00093 private: 00094 00095 /** the mesh in which the set exists */ 00096 Mesh mesh_; 00097 00098 /** the type of cell in the set */ 00099 CellType cellType_; 00100 00101 /** the dimension of the cells in the set */ 00102 int dim_; 00103 00104 }; 00105 } 00106 00107 00108 00109 #endif