ObjectiveFunction/LInfTemplate.cpp

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      
   
  ***************************************************************** */
#include <math.h>
#include "LInfTemplate.hpp"

namespace Mesquite {


LInfTemplate::LInfTemplate(QualityMetric *qualitymetric){
   set_quality_metric(qualitymetric);
   set_gradient_type(ObjectiveFunction::ANALYTICAL_GRADIENT);
   set_negate_flag(qualitymetric->get_negate_flag());
}


//Michael:  need to clean up here
LInfTemplate::~LInfTemplate(){

}

bool LInfTemplate::concrete_evaluate(PatchData &patch, double &fval,
                                     MsqError &err){
    //Total value of objective function
  double temp_value=0;
  fval=0.0;
  bool obj_bool=true;
    //For elements in Patch
  int index;
  QualityMetric* currentQM = get_quality_metric();
  if(currentQM==NULL)
    currentQM=get_quality_metric_list().front();
  if(currentQM->get_metric_type()==QualityMetric::ELEMENT_BASED){
    int num_elements=patch.num_elements();
    MsqMeshEntity* elems=patch.get_element_array(err);  MSQ_ERRZERO(err);
      //Michael:  this may not do what we want
      //Set currentQM to be the first quality metric* in the list 
    for (index=0; index<num_elements;index++){
        //evaluate metric for this elem
      obj_bool=currentQM->evaluate_element(patch, &elems[index], temp_value,
                                           err);  MSQ_ERRZERO(err);
        //if invalid patch
      if(!obj_bool){
        return false;
      }
      temp_value = fabs(temp_value);
      if(temp_value>fval)
        fval=temp_value;
    }//end loop over elements
  }//end if not VERTEX
  else {//VERTEX
    int num_vertices=patch.num_vertices();
    MsqVertex* vertices=patch.get_vertex_array(err);  MSQ_ERRZERO(err);
      //Michael:  this may not do what we want
      //Set currentQM to be the first quality metric* in the list
 
    for (index=0; index<num_vertices;index++){
        //evaluate metric for this vertex
      obj_bool=currentQM->evaluate_vertex(patch,&vertices[index],
                                          temp_value, err);  MSQ_ERRZERO(err);
        //if invalid patch
      if(!obj_bool){
        return false;
      }
      temp_value = fabs(temp_value);
      if(temp_value>fval)
        fval=temp_value;
    }//end loop over vertices
  }//end elseVERTEX
  return true;
}

  bool LInfTemplate::compute_analytical_gradient(PatchData &patch,
                                                         Vector3D *const &grad,
                                                         double &OF_val,
                                                         MsqError &err, 
                                                         size_t array_size)
  {
    MSQ_SETERR(err)("The LInfTemplate is not sufficient for methods requiring\n"
                    "  gradient information.  If you neeed to try this anyway, \n"
                    "  set the gradient type to numerical.\n",
                    MsqError::INVALID_STATE);
    return false;
  }
 

} // namespace Mesquite