SundanceCellReorderer.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_CELLREORDERER_H
#define SUNDANCE_CELLREORDERER_H


#include "SundanceDefs.hpp"
#include "SundanceCellReordererBase.hpp"
#include "PlayaHandle.hpp"


namespace Sundance
{
using namespace Teuchos;
  
  
class Mesh;
/**
 * User-level handle class for abstract specification of
 * cell reordering algorithms.
 *
 * <h4> Examples </h4>
 *
 * \code
 * CellReorderer bfs = new BreadthFirstReorderer();
 * mesh.setReorderer(bfs);
 * \endcode
 */
class CellReorderer
  : public Playa::Handle<CellReordererFactoryBase>
{
public:
  HANDLE_CTORS(CellReorderer, CellReordererFactoryBase);
      
  /** */
  RCP<CellReordererImplemBase> 
  createInstance(const MeshBase* mesh) const ;
};
}


#endif