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

Site Contact