/* ***************************************************************** 
    MESQUITE -- The Mesh Quality Improvement Toolkit

    Copyright 2006 Lawrence Livermore National Laboratory.  Under 
    the terms of Contract B545069 with the University of Wisconsin -- 
    Madison, Lawrence Livermore National Laboratory 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 
    (lgpl.txt) along with this library; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

    (2006) kraftche@cae.wisc.edu    

  ***************************************************************** */

#ifndef MSQ_ELEMENT_PATCHES_HPP
#define MSQ_ELEMENT_PATCHES_HPP

#include "Mesquite.hpp"
#include "PatchSet.hpp"


namespace MESQUITE_NS {

/**\brief A PatchSet representing a decomposition of the mesh
 *        into patches containing a single element.  
 *
 * This is intended for use in QualityAssessor.  It is not usable
 * for optimization.
 */
class MESQUITE_EXPORT ElementPatches : public PatchSet
{
public:

    ~ElementPatches();
    
    /**\brief Get a list of handles, one for each patch */
    virtual void get_patch_handles( std::vector<PatchHandle>& patch_handles_out,
                                    MsqError& err );
    
    /**\brief Get the mesh entities in a patch
     *
     * Given one of the handles returned by get_patch_handles(),
     * return the mesh entities in the corresponding patch.  
     * This function returns a single element in element_handles_out
     * and returns free_vertices_out as an empty list.
     *
     *\param patch_handle one of the handles returned by get_patch_handles()
     *\param elem_handles_out the list of elements in the mesh
     *\param free_vertices_out the list of vertices interior to the patch
     */
    virtual void get_patch( PatchHandle patch_handle,
                            std::vector<Mesh::ElementHandle>& elem_handles_out,
                            std::vector<Mesh::VertexHandle>& free_vertices_out,
                            MsqError& err );

};

} // namespace Mesquite

#endif
