SundanceNullCellFilter.hpp
Go to the documentation of this file.
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_NULLCELLFILTER_H
00032 #define SUNDANCE_NULLCELLFILTER_H
00033 
00034 #include "SundanceDefs.hpp"
00035 #include "Teuchos_RefCountPtr.hpp"
00036 #include "SundanceCellFilterBase.hpp"
00037 #include "SundanceNullCellFilterStub.hpp"
00038 
00039 namespace Sundance
00040 {
00041 using namespace Teuchos;
00042 
00043 /** 
00044  * NullCellFilter is used as a placeholder cell filter
00045  * in those equations defined
00046  * independently of geometry, i.e., equations involving only
00047  * global parameters.
00048  **/
00049 class NullCellFilter : public Sundance::NullCellFilterStub
00050 {
00051 public:
00052   /** */
00053   NullCellFilter();
00054 
00055   /** */
00056   virtual ~NullCellFilter(){;}
00057 
00058   /** */
00059   virtual XMLObject toXML() const ;
00060 
00061   /** Return the dimension of the cells that will be identified
00062    * by this filter when acting on the given mesh */
00063   virtual int dimension(const Mesh& mesh) const ;
00064 
00065   /* */
00066   GET_RCP(CellFilterStub);
00067     
00068 protected:
00069 
00070   /** */
00071   virtual CellSet internalGetCells(const Mesh& mesh) const ;
00072 };
00073 }
00074 
00075 
00076 #endif

Site Contact