includeLinks/EdgeLengthRangeQualityMetric.hpp

Go to the documentation of this file.

/* ***************************************************************** 
    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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  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 -*-

#ifndef EdgeLengthRangeQualityMetric_hpp
#define EdgeLengthRangeQualityMetric_hpp

#include "Mesquite.hpp"
#include "MsqError.hpp"
#include "SmoothnessQualityMetric.hpp"

namespace Mesquite
{
   class MsqMeshEntity;
   class MsqVertex;
   
   class EdgeLengthRangeQualityMetric : public SmoothnessQualityMetric
  {
   public:
    
      //This is the form of the constructor that should beused.
    EdgeLengthRangeQualityMetric(double low_a, double high_a, MsqError &err)
       {
         if(low_a>high_a){
           MSQ_SETERR(err)("Edge Length Range values given in descending order.",
                           MsqError::INVALID_ARG);
         }
         lowVal=low_a;
         highVal=high_a;
         avgMethod=SUM;
         feasible=0;
         set_metric_type(QualityMetric::VERTEX_BASED);
         set_name("Edge Length Range Metric");
       }

      // virtual destructor ensures use of polymorphism during destruction
    virtual ~EdgeLengthRangeQualityMetric()
       {}

  
   protected:
   
    bool evaluate_vertex(PatchData &pd, MsqVertex *vert, double &fval,
                         MsqError &err);

   private:
    
      //Generally, this constructor should not be used.
    EdgeLengthRangeQualityMetric()
       {
         lowVal=0;
         highVal=0;
         avgMethod=SUM;
         feasible=0;
         set_metric_type(QualityMetric::VERTEX_BASED);
         set_name("Edge Length Range Metric Default Constructor");
       }
    
    double highVal;
    double lowVal;
    
  };


} //namespace


#endif // EdgeLengthRangeQualityMetric_hpp