includeLinks/LPtoPTemplate.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 LPtoPTemplate_hpp
#define LPtoPTemplate_hpp

#include "Mesquite.hpp"
#include "MsqError.hpp"
#include "ObjectiveFunction.hpp"

namespace Mesquite
{
   class PatchData;
   class MsqMeshEntity;
   class LPtoPTemplate :public ObjectiveFunction
   {
   public:
     LPtoPTemplate(QualityMetric *, short, MsqError &);
     virtual ~LPtoPTemplate();
     virtual bool concrete_evaluate(PatchData &patch, double &fval,
                                    MsqError &err);
     void set_dividing_by_n(bool d_bool){dividingByN=d_bool;}
     
   protected:
     virtual bool compute_analytical_gradient(PatchData &patch,
                                              Vector3D *const &grad,
                                              double &OF_val,
                                              MsqError &err, 
                                              size_t array_size);
     
     virtual bool  compute_analytical_hessian(PatchData &patch,
                                              MsqHessian &hessian, 
                                              Vector3D *const &grad,
                                              double &OF_val,
                                              MsqError &err);
     
   private:
     double compute_function(double metric_values[], size_t total_num,
                             MsqError &err);
     short pVal;
     bool dividingByN;
   };
   
   inline double LPtoPTemplate::compute_function(double metric_values[],
                                                 size_t total_num,
                                                 MsqError &err)
   {
     double scale_factor=1.0;
       //if scaling, divide by total_num
     if(dividingByN){
       if(total_num<=0) {
         MSQ_SETERR(err)(MsqError::INVALID_ARG);
         return 0.0;
       }
       scale_factor/=total_num;
     }
     size_t ind=0;
     short jnd=0;
     double temp_value=1;
     double total_value=0;
     for(ind=0;ind<total_num;++ind){
       temp_value=1;
       for(jnd=0;jnd<pVal;++jnd){
         temp_value*=metric_values[ind];
       }
       total_value+=(scale_factor*temp_value);
     }
     return total_value;
   }
   
}//namespace

#endif // LPtoPTemplate_hpp