SundanceMaximalCellFilter.hpp
Go to the documentation of this file.
00001 /* @HEADER@ */
00002 // ************************************************************************
00003 // 
00004 //                             Sundance
00005 //                 Copyright 2011 Sandia Corporation
00006 // 
00007 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
00008 // the U.S. Government retains certain rights in this software.
00009 //
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Kevin Long (kevin.long@ttu.edu)
00038 // 
00039 
00040 /* @HEADER@ */
00041 
00042 #ifndef SUNDANCE_MAXIMALCELLFILTER_H
00043 #define SUNDANCE_MAXIMALCELLFILTER_H
00044 
00045 #include "SundanceDefs.hpp"
00046 #include "Teuchos_RefCountPtr.hpp"
00047 #include "SundanceCellFilterBase.hpp"
00048 
00049 
00050 
00051 namespace Sundance
00052 {
00053 using namespace Teuchos;
00054 
00055 /** 
00056  * MaximalCellFilter is a filter that identifies all mesh
00057  * cells of maximal dimension.
00058  **/
00059 class MaximalCellFilter : public CellFilterBase 
00060 {
00061 public:
00062   /** Empty ctor */
00063   MaximalCellFilter();
00064 
00065   /** */
00066   virtual ~MaximalCellFilter(){;}
00067 
00068   /** Return the dimension of the cells that will be identified
00069    * by this filter when acting on the given mesh */
00070   virtual int dimension(const Mesh& mesh) const ;
00071 
00072   /** Write to XML */
00073   virtual XMLObject toXML() const {return XMLObject(typeName());}
00074 
00075   /** Return the type name */
00076   virtual std::string typeName() const {return "MaximalCellFilter";}
00077 
00078   /** Describable interface */
00079   virtual std::string description() const {return typeName();}
00080 
00081 
00082   /** Compare to another object */
00083   virtual bool lessThan(const CellFilterStub* other) const ;
00084 
00085   /* Handleable boilerplate */
00086   GET_RCP(CellFilterStub);
00087     
00088 
00089 protected:
00090   /** */
00091   virtual CellSet internalGetCells(const Mesh& mesh) const ;
00092 
00093 };
00094 
00095 }
00096 
00097 
00098 
00099 #endif

Site Contact