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_CELLPREDICATE_H 00032 #define SUNDANCE_CELLPREDICATE_H 00033 00034 00035 00036 #include "SundanceDefs.hpp" 00037 #include "SundanceMesh.hpp" 00038 #include "SundanceCellPredicateBase.hpp" 00039 #include "SundancePositionalCellPredicate.hpp" 00040 #include "PlayaHandle.hpp" 00041 #include "SundanceParametrizedCurve.hpp" 00042 #include "SundanceCellCurvePredicate.hpp" 00043 00044 namespace Sundance 00045 { 00046 using namespace Teuchos; 00047 00048 00049 /** 00050 * User-level handle for predicates (deriving from CellPredicateBase) 00051 * used to decide whether 00052 * a given cell passes a CellFilter. 00053 */ 00054 class CellPredicate : public Playa::Handle<CellPredicateBase> 00055 { 00056 public: 00057 00058 /* handle boilerplate */ 00059 HANDLE_CTORS(CellPredicate, CellPredicateBase); 00060 00061 /** construct from a positional cell predicate functor */ 00062 CellPredicate(const RCP<CellPredicateFunctorBase>& func); 00063 00064 /** construct from a positional cell predicate functor */ 00065 CellPredicate(Playa::Handleable<CellPredicateFunctorBase>* func); 00066 00067 /** construct from a positional cell predicate functor */ 00068 CellPredicate(ParametrizedCurve& curve, CurveCellFilterMode filterMode); 00069 00070 /** write to XML */ 00071 XMLObject toXML() const {return ptr()->toXML();} 00072 00073 /** */ 00074 std::string description() const {return ptr()->description();} 00075 00076 00077 00078 /** set the mesh on which cells are to be tested */ 00079 void setMesh(const Mesh& mesh, int cellDim) const 00080 {ptr()->setMesh(mesh, cellDim);} 00081 00082 /** compare to another predicate, used for placement in STL containers */ 00083 bool operator<(const CellPredicate& other) const ; 00084 00085 00086 }; 00087 00088 } 00089 00090 namespace std 00091 { 00092 inline ostream& operator<<(std::ostream& os, const Sundance::CellPredicate& pred) 00093 { 00094 os << pred.toXML() << std::endl; 00095 return os; 00096 } 00097 } 00098 00099 00100 #endif