SundanceBinaryCellFilter.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_BINARYCELLFILTER_H
#define SUNDANCE_BINARYCELLFILTER_H

#include "SundanceDefs.hpp"
#include "SundanceCellFilter.hpp"
#include "SundanceCellFilterBase.hpp"

namespace Sundance
{
using namespace Teuchos;
  
/** 
 * BinaryCellFilter implements cell filters that do
 * binary logical operations on cell sets.
 */
class BinaryCellFilter : public CellFilterBase
{
public:

  /** */
  enum CellFilterOpType {Union, Intersection, Difference};

  /** Empty ctor */
  BinaryCellFilter(const CellFilter& left, const CellFilter& right,
    const CellFilterOpType& op);

  /** virtual dtor */
  virtual ~BinaryCellFilter(){;}

  /** Return the dimension of the cells that will be identified
   * by this filter when acting on the given mesh */
  virtual int dimension(const Mesh& mesh) const ;

  /** Write to XML */
  virtual XMLObject toXML() const ;

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

  /** Return the name of the type. Used in ordering. */
  virtual std::string typeName() const {return "BinaryOpCellFilter";}

  /* */
  GET_RCP(CellFilterStub);
protected:

  /** Get my cells for the given mesh */
  virtual CellSet internalGetCells(const Mesh& mesh) const ;

private:
  /** */
  std::string opName() const ;

  /** The operation I perform */
  CellFilterOpType op_;

  /** My left operand  */
  CellFilter left_;

  /** My right operand */
  CellFilter right_;
};
}


#endif