/* ***************************************************************** 
    MESQUITE -- The Mesh Quality Improvement Toolkit

    Copyright 2004 Sandia Corporation and Argonne National
    Laboratory.  Under the terms of Contract DE-AC04-94AL85000 
    with Sandia Corporation, the U.S. Government retains certain 
    rights in this software.

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
    version 2.1 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public License 
    (lgpl.txt) along with this library; if not, write to the Free Software
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
 
    diachin2@llnl.gov, djmelan@sandia.gov, mbrewer@sandia.gov, 
    pknupp@sandia.gov, tleurent@mcs.anl.gov, tmunson@mcs.anl.gov      
   
  ***************************************************************** */
// -*- Mode : c++; tab-width: 3; c-tab-always-indent: t; indent-tabs-mode: nil; c-basic-offset: 3 -*-

/*! \file EdgeLengthQualityMetric.hpp

Header file for the Mesquite::EdgeLengthQualityMetric class

  \author Michael Brewer
  \date   2002-06-13
 */


#ifndef EdgeLengthQualityMetric_hpp
#define EdgeLengthQualityMetric_hpp

#include "Mesquite.hpp"
#include "Mesquite_AveragingQM.hpp"
#include "Mesquite_VertexQM.hpp"

namespace MESQUITE_NS
{
     /*! \class EdgeLengthQualityMetric
       \brief Computes the lengths of the edges connected to given a vertex..
       
        EdgeLengthQualityMetric is a vertex based metric which computes
        the lengths of the edges connected to a given vertex and then
        averages those together, using the specified averaging method
        The metric uses SUM as the default averaging method.
     */
  class EdgeLengthQualityMetric : public VertexQM, public AveragingQM
  {
   public:
    
    MESQUITE_EXPORT EdgeLengthQualityMetric() : AveragingQM(SUM)
      {}
    
      // virtual destructor ensures use of polymorphism during destruction
    MESQUITE_EXPORT virtual ~EdgeLengthQualityMetric()
       {}
      
    MESQUITE_EXPORT virtual std::string get_name() const;
    
    MESQUITE_EXPORT virtual int get_negate_flag() const;


    MESQUITE_EXPORT virtual
    bool evaluate( PatchData& pd, 
                   size_t vertex, 
                   double& value, 
                   MsqError& err );

    MESQUITE_EXPORT virtual
    bool evaluate_with_indices( PatchData& pd,
                   size_t vertex,
                   double& value,
                   std::vector<size_t>& indices,
                   MsqError& err );
  
   private:
   
    bool evaluate_common( PatchData& pd, 
                          size_t vertex, 
                          double& value, 
                          std::vector<size_t>& vertices,
                          MsqError& err );
  };


} //namespace


#endif // EdgeLengthQualityMetric_hpp


