includeLinks/IdealWeightInverseMeanRatio.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 IdealWeightInverseMeanRatio_hpp
#define IdealWeightInverseMeanRatio_hpp

#include "Mesquite.hpp"
#include "ShapeQualityMetric.hpp"
#include "Vector3D.hpp"
#include "Matrix3D.hpp"
#include "Exponent.hpp"

namespace Mesquite
{
    class MsqMeshEntity;
    class PatchData;
    class MsqError;

   class IdealWeightInverseMeanRatio : public ShapeQualityMetric
   {
   public:
      IdealWeightInverseMeanRatio(MsqError& err, double pow_dbl = 1.0);

      virtual ~IdealWeightInverseMeanRatio() {
      }
     
      bool evaluate_element(PatchData &pd, MsqMeshEntity *element, 
                            double &fval, MsqError &err); 

      bool compute_element_analytical_gradient(PatchData &pd,
                                               MsqMeshEntity *element,
                                               MsqVertex *free_vtces[], 
                                               Vector3D grad_vec[],
                                               int num_vtx, 
                                               double &metric_value,
                                               MsqError &err);

      bool compute_element_analytical_hessian(PatchData &pd,
                                              MsqMeshEntity *e,
                                              MsqVertex *v[], 
                                              Vector3D g[],
                                              Matrix3D h[],
                                              int nv, 
                                              double &m,
                                              MsqError &err);
      
    private:
     void set_metric_power(double pow_dbl, MsqError& err);
     
      // arrays used in Hessian computations 
      // We allocate them here, so that one allocation only is done.
      // This gives a big computation speed increase.
      Vector3D mCoords[4]; // Vertex coordinates for the (decomposed) elements
      Vector3D mGradients[32]; // Gradient of metric with respect to the coords
      Vector3D mAccumGrad[8];  // Accumulated gradients (composed merit)
      Matrix3D mHessians[80]; // Hessian of metric with respect to the coords
      double   mMetrics[8]; // Metric values for the (decomposed) elements
      double   g_factor[8]; // Metric values for the (decomposed) elements
     double   h_factor[8]; // Metric values for the (decomposed) elements
       //variables used in the definition of the metric (2d and 3d)
     double a2Con;
     Exponent b2Con;
     Exponent c2Con;
     
     double a3Con;
     Exponent b3Con;
     Exponent c3Con;
   };
} //namespace


#endif // IdealWeightInverseMeanRatio_hpp