Branch data     Line data    Source code

       1                 :            : /* *****************************************************************
       2                 :            :     MESQUITE -- The Mesh Quality Improvement Toolkit
       3                 :            : 
       4                 :            :     Copyright 2004 Sandia Corporation and Argonne National
       5                 :            :     Laboratory.  Under the terms of Contract DE-AC04-94AL85000
       6                 :            :     with Sandia Corporation, the U.S. Government retains certain
       7                 :            :     rights in this software.
       8                 :            : 
       9                 :            :     This library is free software; you can redistribute it and/or
      10                 :            :     modify it under the terms of the GNU Lesser General Public
      11                 :            :     License as published by the Free Software Foundation; either
      12                 :            :     version 2.1 of the License, or (at your option) any later version.
      13                 :            : 
      14                 :            :     This library is distributed in the hope that it will be useful,
      15                 :            :     but WITHOUT ANY WARRANTY; without even the implied warranty of
      16                 :            :     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
      17                 :            :     Lesser General Public License for more details.
      18                 :            : 
      19                 :            :     You should have received a copy of the GNU Lesser General Public License
      20                 :            :     (lgpl.txt) along with this library; if not, write to the Free Software
      21                 :            :     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
      22                 :            : 
      23                 :            :     [email protected], [email protected], [email protected],
      24                 :            :     [email protected], [email protected], [email protected]
      25                 :            : 
      26                 :            :   ***************************************************************** */
      27                 :            : // -*- Mode : c++; tab-width: 3; c-tab-always-indent: t; indent-tabs-mode: nil; c-basic-offset: 3
      28                 :            : // -*-
      29                 :            : 
      30                 :            : /*! \file EdgeLengthQualityMetric.hpp
      31                 :            : 
      32                 :            : Header file for the MBMesquite::EdgeLengthQualityMetric class
      33                 :            : 
      34                 :            :   \author Michael Brewer
      35                 :            :   \date   2002-06-13
      36                 :            :  */
      37                 :            : 
      38                 :            : #ifndef EdgeLengthQualityMetric_hpp
      39                 :            : #define EdgeLengthQualityMetric_hpp
      40                 :            : 
      41                 :            : #include "Mesquite.hpp"
      42                 :            : #include "AveragingQM.hpp"
      43                 :            : #include "VertexQM.hpp"
      44                 :            : 
      45                 :            : namespace MBMesquite
      46                 :            : {
      47                 :            : /*! \class EdgeLengthQualityMetric
      48                 :            :   \brief Computes the lengths of the edges connected to given a vertex..
      49                 :            : 
      50                 :            :    EdgeLengthQualityMetric is a vertex based metric which computes
      51                 :            :    the lengths of the edges connected to a given vertex and then
      52                 :            :    averages those together, using the specified averaging method
      53                 :            :    The metric uses SUM as the default averaging method.
      54                 :            : */
      55                 :            : class EdgeLengthQualityMetric : public VertexQM, public AveragingQM
      56                 :            : {
      57                 :            :   public:
      58         [ +  - ]:          2 :     MESQUITE_EXPORT EdgeLengthQualityMetric() : AveragingQM( SUM ) {}
      59                 :            : 
      60                 :            :     // virtual destructor ensures use of polymorphism during destruction
      61         [ -  + ]:          4 :     MESQUITE_EXPORT virtual ~EdgeLengthQualityMetric() {}
      62                 :            : 
      63                 :            :     MESQUITE_EXPORT virtual std::string get_name() const;
      64                 :            : 
      65                 :            :     MESQUITE_EXPORT virtual int get_negate_flag() const;
      66                 :            : 
      67                 :            :     MESQUITE_EXPORT virtual bool evaluate( PatchData& pd, size_t vertex, double& value, MsqError& err );
      68                 :            : 
      69                 :            :     MESQUITE_EXPORT virtual bool evaluate_with_indices( PatchData& pd, size_t vertex, double& value,
      70                 :            :                                                         std::vector< size_t >& indices, MsqError& err );
      71                 :            : 
      72                 :            :   private:
      73                 :            :     bool evaluate_common( PatchData& pd, size_t vertex, double& value, std::vector< size_t >& vertices, MsqError& err );
      74                 :            : };
      75                 :            : 
      76                 :            : }  // namespace MBMesquite
      77                 :            : 
      78                 :            : #endif  // EdgeLengthQualityMetric_hpp