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_DIMENSIONALCELLFILTER_H 00032 #define SUNDANCE_DIMENSIONALCELLFILTER_H 00033 00034 #include "SundanceDefs.hpp" 00035 #include "Teuchos_RefCountPtr.hpp" 00036 #include "SundanceCellFilterBase.hpp" 00037 00038 00039 namespace Sundance 00040 { 00041 using namespace Teuchos; 00042 00043 00044 00045 /** 00046 * DimensionalCellFilter is a filter that identifies all cells of a 00047 * specified dimension. 00048 * 00049 * <h4> Example: </h4> get all faces in a 3D mesh 00050 * 00051 * \code 00052 * Mesh myMesh = myReader.getMesh(); 00053 * CellFilter faceFilter = new DimensionalCellFilter(2); 00054 * CellSet faces = faceFilter.getCells(myMesh); 00055 * \endcode 00056 */ 00057 class DimensionalCellFilter : public CellFilterBase 00058 { 00059 public: 00060 /** */ 00061 DimensionalCellFilter(int dim); 00062 00063 /** */ 00064 virtual ~DimensionalCellFilter(){;} 00065 00066 /** */ 00067 virtual int dimension(const Mesh& mesh) const {return dim_;} 00068 00069 /** */ 00070 virtual XMLObject toXML() const ; 00071 00072 /** */ 00073 virtual std::string typeName() const {return "DimensionalCellFilter";} 00074 00075 /** */ 00076 virtual std::string description() const 00077 {return "Cells(d=" + Teuchos::toString(dim_) + ")";} 00078 00079 /** */ 00080 virtual bool lessThan(const CellFilterStub* other) const ; 00081 00082 /* */ 00083 GET_RCP(CellFilterStub); 00084 00085 protected: 00086 /** get the cells */ 00087 virtual CellSet internalGetCells(const Mesh& mesh) const ; 00088 00089 private: 00090 00091 int dim_; 00092 00093 00094 }; 00095 00096 } 00097 00098 00099 00100 #endif