MOAB: Mesh Oriented datABase  (version 5.2.1)
EdgeLengthRangeQualityMetric.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 EdgeLengthRangeQualityMetric.hpp
00031 
00032 Header file for the MBMesquite::EdgeLengthRangeQualityMetric class
00033 
00034   \author Michael Brewer
00035   \date   2002-06-13
00036  */
00037 
00038 #ifndef EdgeLengthRangeQualityMetric_hpp
00039 #define EdgeLengthRangeQualityMetric_hpp
00040 
00041 #include "Mesquite.hpp"
00042 #include "AveragingQM.hpp"
00043 #include "VertexQM.hpp"
00044 
00045 namespace MBMesquite
00046 {
00047 /*! \class EdgeLengthRangeQualityMetric
00048   \brief Computes the edge length range metric for a given vertex.
00049 
00050    EdgeLengthRangeQualityMetric is a vertex based metric which computes
00051    the lengths of the edges connected to a given vertex and then
00052    uses those values to form a metric.  The metric is created using
00053    two doubles A and B.  The value of the metric is zero (ideal) if
00054    the edge lengths are in the range [A,B].  Otherwise, the
00055    metric value is some positive number.  For a given vertex,
00056    v_i, with connected edges of lengths l_j for j=1...k, the metric
00057    value is the average (where the default average type is SUM) of
00058    u_j = ( | l_j - A | - (l_j - A) )^2 + ( | B - l_j | - (B - l_j) )^2.
00059 */
00060 class EdgeLengthRangeQualityMetric : public VertexQM, public AveragingQM
00061 {
00062   public:
00063     EdgeLengthRangeQualityMetric( double low_a, double high_a );
00064 
00065     virtual ~EdgeLengthRangeQualityMetric();
00066 
00067     virtual std::string get_name() const;
00068 
00069     virtual int get_negate_flag() const;
00070 
00071     virtual bool evaluate( PatchData& pd, size_t vertex, double& value, MsqError& err );
00072 
00073     virtual bool evaluate_with_indices( PatchData& pd, size_t vertex, double& value, std::vector< size_t >& indices,
00074                                         MsqError& err );
00075 
00076   private:
00077     bool evaluate_common( PatchData& pd, size_t vertex, double& value, std::vector< size_t >& vertices, MsqError& err );
00078 
00079     double highVal;
00080     double lowVal;
00081 };
00082 
00083 }  // namespace MBMesquite
00084 
00085 #endif  // EdgeLengthRangeQualityMetric_hpp
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines