SundanceLabeledSubsetCellFilter.hpp

Go to the documentation of this file.

/* @HEADER@ */
// ************************************************************************
// 
//                              Sundance
//                 Copyright (2005) Sandia Corporation
// 
// Copyright (year first published) Sandia Corporation.  Under the terms 
// of Contract DE-AC04-94AL85000 with Sandia Corporation, the U.S. Government 
// retains certain rights in this software.
// 
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//  
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//                                                                                 
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA                                                                                
// Questions? Contact Kevin Long (krlong@sandia.gov), 
// Sandia National Laboratories, Livermore, California, USA
// 
// ************************************************************************
/* @HEADER@ */

#ifndef SUNDANCE_LABELEDSUBSETCELLFILTER_H
#define SUNDANCE_LABELEDSUBSETCELLFILTER_H

#include "SundanceDefs.hpp"
#include "Teuchos_RefCountPtr.hpp"
#include "SundanceCellFilterBase.hpp"

namespace Sundance
{
using namespace Teuchos;

/** */
class LabeledSubsetCellFilter : public CellFilterBase 
{
public:
  /** */
  LabeledSubsetCellFilter(const CellFilter& superset,
    const std::string& label);

  /** */
  virtual ~LabeledSubsetCellFilter(){;}

  /** */
  virtual XMLObject toXML() const ;

  /** */
  virtual std::string typeName() const {return "LabeledSubsetCellFilter";}

  /** */
  virtual bool lessThan(const CellFilterStub* other) const ;

  /** */
  virtual RCP<CellFilterBase> getRcp() {return rcp(this);}

  /** */
  virtual std::string description() const 
    {return "LabeledSubset(label=" + label_ + ", super=" + superset_.description()+")";}
    


  /** */
  std::string label() const {return label_;}

protected:
  /** */
  virtual CellSet internalGetCells(const Mesh& mesh) const ;

  /** */
  std::string label_;

  /** */
  CellFilter superset_;
};

}



#endif