MOAB: Mesh Oriented datABase  (version 5.3.0)
ElementQM.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
00011     License as published by the Free Software Foundation; either
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 /** \file ElementQM.hpp
00028  *  \brief
00029  *  \author Jason Kraftcheck
00030  */
00031 
00032 #ifndef MSQ_ELEMENT_QM_HPP
00033 #define MSQ_ELEMENT_QM_HPP
00034 
00035 #include "Mesquite.hpp"
00036 #include "QualityMetric.hpp"
00037 
00038 namespace MBMesquite
00039 {
00040 
00041 /**\brief Base type for per-element quality metrics */
00042 class ElementQM : public QualityMetric
00043 {
00044   public:
00045     MESQUITE_EXPORT virtual ~ElementQM();
00046 
00047     MESQUITE_EXPORT virtual MetricType get_metric_type() const
00048     {
00049         return ELEMENT_BASED;
00050     }
00051 
00052     /**\brief Returns list of element indices in PatchData */
00053     MESQUITE_EXPORT virtual void get_evaluations( PatchData& pd, std::vector< size_t >& handles,
00054                                                   bool free_vertices_only, MsqError& err );
00055 
00056     MESQUITE_EXPORT static void get_element_evaluations( PatchData& pd, std::vector< size_t >& handles,
00057                                                          bool free_vertices_only, MsqError& err );
00058 
00059     /**\brief Default implementation for all element-based metrics
00060      *
00061      * Fill 'indices' with all free vertex indices in element,
00062      * and call 'evaluate'.
00063      */
00064     MESQUITE_EXPORT virtual bool evaluate_with_indices( PatchData& pd, size_t handle, double& value,
00065                                                         std::vector< size_t >& indices, MsqError& err );
00066 };
00067 
00068 }  // namespace MBMesquite
00069 
00070 #endif
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines