MOAB: Mesh Oriented datABase  (version 5.2.1)
ElementPatches.hpp
Go to the documentation of this file.
00001 /* *****************************************************************
00002     MESQUITE -- The Mesh Quality Improvement Toolkit
00003
00004     Copyright 2006 Lawrence Livermore National Laboratory.  Under
00005     the terms of Contract B545069 with the University of Wisconsin --
00006     Madison, Lawrence Livermore National Laboratory retains certain
00007     rights in this software.
00008
00009     This library is free software; you can redistribute it and/or
00010     modify it under the terms of the GNU Lesser General Public
00012     version 2.1 of the License, or (at your option) any later version.
00013
00014     This library is distributed in the hope that it will be useful,
00015     but WITHOUT ANY WARRANTY; without even the implied warranty of
00016     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00017     Lesser General Public License for more details.
00018
00019     You should have received a copy of the GNU Lesser General Public License
00020     (lgpl.txt) along with this library; if not, write to the Free Software
00021     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
00022
00023     (2006) kraftche@cae.wisc.edu
00024
00025   ***************************************************************** */
00026
00027 #ifndef MSQ_ELEMENT_PATCHES_HPP
00028 #define MSQ_ELEMENT_PATCHES_HPP
00029
00030 #include "Mesquite.hpp"
00031 #include "PatchSet.hpp"
00032
00033 namespace MBMesquite
00034 {
00035
00036 /**\brief A PatchSet representing a decomposition of the mesh
00037  *        into patches containing a single element.
00038  *
00039  * This is intended for use in QualityAssessor.  It is not usable
00040  * for optimization.
00041  */
00042 class MESQUITE_EXPORT ElementPatches : public PatchSet
00043 {
00044   public:
00045     ~ElementPatches();
00046
00047     /**\brief Get a list of handles, one for each patch */
00048     virtual void get_patch_handles( std::vector< PatchHandle >& patch_handles_out, MsqError& err );
00049
00050     /**\brief Get the mesh entities in a patch
00051      *
00052      * Given one of the handles returned by get_patch_handles(),
00053      * return the mesh entities in the corresponding patch.
00054      * This function returns a single element in element_handles_out
00055      * and returns free_vertices_out as an empty list.
00056      *
00057      *\param patch_handle one of the handles returned by get_patch_handles()
00058      *\param elem_handles_out the list of elements in the mesh
00059      *\param free_vertices_out the list of vertices interior to the patch
00060      */
00061     virtual void get_patch( PatchHandle patch_handle, std::vector< Mesh::ElementHandle >& elem_handles_out,
00062                             std::vector< Mesh::VertexHandle >& free_vertices_out, MsqError& err );
00063 };
00064
00065 }  // namespace MBMesquite
00066
00067 #endif