MOAB: Mesh Oriented datABase  (version 5.2.1)
EdgeLengthQualityMetric.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 EdgeLengthQualityMetric.hpp
00031 
00032 Header file for the MBMesquite::EdgeLengthQualityMetric class
00033 
00034   \author Michael Brewer
00035   \date   2002-06-13
00036  */
00037 
00038 #ifndef EdgeLengthQualityMetric_hpp
00039 #define EdgeLengthQualityMetric_hpp
00040 
00041 #include "Mesquite.hpp"
00042 #include "AveragingQM.hpp"
00043 #include "VertexQM.hpp"
00044 
00045 namespace MBMesquite
00046 {
00047 /*! \class EdgeLengthQualityMetric
00048   \brief Computes the lengths of the edges connected to given a vertex..
00049 
00050    EdgeLengthQualityMetric is a vertex based metric which computes
00051    the lengths of the edges connected to a given vertex and then
00052    averages those together, using the specified averaging method
00053    The metric uses SUM as the default averaging method.
00054 */
00055 class EdgeLengthQualityMetric : public VertexQM, public AveragingQM
00056 {
00057   public:
00058     MESQUITE_EXPORT EdgeLengthQualityMetric() : AveragingQM( SUM ) {}
00059 
00060     // virtual destructor ensures use of polymorphism during destruction
00061     MESQUITE_EXPORT virtual ~EdgeLengthQualityMetric() {}
00062 
00063     MESQUITE_EXPORT virtual std::string get_name() const;
00064 
00065     MESQUITE_EXPORT virtual int get_negate_flag() const;
00066 
00067     MESQUITE_EXPORT virtual bool evaluate( PatchData& pd, size_t vertex, double& value, MsqError& err );
00068 
00069     MESQUITE_EXPORT virtual bool evaluate_with_indices( PatchData& pd, size_t vertex, double& value,
00070                                                         std::vector< size_t >& indices, MsqError& err );
00071 
00072   private:
00073     bool evaluate_common( PatchData& pd, size_t vertex, double& value, std::vector< size_t >& vertices, MsqError& err );
00074 };
00075 
00076 }  // namespace MBMesquite
00077 
00078 #endif  // EdgeLengthQualityMetric_hpp
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines