MOAB: Mesh Oriented datABase  (version 5.2.1)
LocalSizeQualityMetric.hpp
Go to the documentation of this file.
00001 /* *****************************************************************
00002     MESQUITE -- The Mesh Quality Improvement Toolkit
00003 
00004     Copyright 2004 Sandia Corporation and Argonne National
00005     Laboratory.  Under the terms of Contract DE-AC04-94AL85000
00006     with Sandia Corporation, the U.S. Government 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     diachin2@llnl.gov, djmelan@sandia.gov, mbrewer@sandia.gov,
00024     pknupp@sandia.gov, tleurent@mcs.anl.gov, tmunson@mcs.anl.gov
00025 
00026   ***************************************************************** */
00027 // -*- Mode : c++; tab-width: 3; c-tab-always-indent: t; indent-tabs-mode: nil; c-basic-offset: 3
00028 // -*-
00029 
00030 /*! \file LocalSizeQualityMetric.hpp
00031 
00032 Header file for the MBMesquite::LocalSizeQualityMetric class
00033 
00034   \author Michael Brewer
00035   \date   April 9, 2003
00036  */
00037 
00038 #ifndef LocalSizeQualityMetric_hpp
00039 #define LocalSizeQualityMetric_hpp
00040 
00041 #include "Mesquite.hpp"
00042 #include "VertexQM.hpp"
00043 #include "AveragingQM.hpp"
00044 
00045 namespace MBMesquite
00046 {
00047 /*! \class LocalSizeQualityMetric
00048   \brief Computes the local size metric for a given vertex.
00049 
00050    LocalSizeQualityMetric is a vertex based metric which computes
00051    the corner volume (or area) for the element corners attached
00052    to a given element.  Then these volumes (or areas) are averaged
00053    together.  The default averaging method is QualityMetric::RMS.
00054 */
00055 class LocalSizeQualityMetric : public VertexQM, public AveragingQM
00056 {
00057   public:
00058     // Default constructor.
00059     LocalSizeQualityMetric() : AveragingQM( RMS ) {}
00060 
00061     // virtual destructor ensures use of polymorphism during destruction
00062     virtual ~LocalSizeQualityMetric();
00063 
00064     virtual std::string get_name() const;
00065 
00066     virtual int get_negate_flag() const;
00067 
00068     virtual bool evaluate( PatchData& pd, size_t handle, double& value, MsqError& err );
00069 
00070     virtual bool evaluate_with_indices( PatchData& pd, size_t handle, double& value, std::vector< size_t >& indices,
00071                                         MsqError& err );
00072 };
00073 
00074 }  // namespace MBMesquite
00075 
00076 #endif  // LocalSizeQualityMetric_hpp
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines