ObjectiveFunction/MaxTemplate.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 "MaxTemplate.hpp"
#include "QualityMetric.hpp"
#include "PatchData.hpp"

namespace Mesquite {

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

//Lori:  need to clean up here
MaxTemplate::~MaxTemplate(){

}

bool MaxTemplate::concrete_evaluate(PatchData &patch, double &fval,
                                    MsqError &err){

  //Total value of objective function
  fval = 0.0;
  double temp_value=0;
  bool obj_bool = true;
  //For elements in Patch
  int index;
  QualityMetric* currentQM = get_quality_metric();
  if(currentQM->get_metric_type()==QualityMetric::ELEMENT_BASED){
    
    int num_elements=patch.num_elements();
    MsqMeshEntity* elems=patch.get_element_array(err);  MSQ_ERRZERO(err);
 
    for (index=0; index<num_elements; index++){

      //evaluate metric for this elem
      obj_bool = currentQM->evaluate_element(patch, &elems[index],
                                             temp_value, err);
        //if invalid patch
      if(MSQ_CHKERR(err) || !obj_bool ){
        fval = 0.0;
        return false;
      }

      if(temp_value>fval )
        fval=temp_value;

    }//end loop over elements
  }//end if not VERTEX

  else if (currentQM->get_metric_type()==QualityMetric::VERTEX_BASED) {

    int num_vertices=patch.num_vertices();
    MsqVertex* vertices=patch.get_vertex_array(err);  MSQ_ERRZERO(err);
 
    for (index=0; index<num_vertices;index++){

      //evaluate metric for this vertex
      obj_bool=currentQM->evaluate_vertex(patch, &vertices[index],
                                          temp_value, err);
      //if invalid patch
      if(MSQ_CHKERR(err) || !obj_bool ){
        fval = 0.0;
        return false;
      }
      if(temp_value>fval)
        fval=temp_value;

    }//end loop over vertices
  }//end else VERTEX
  else {
    MSQ_SETERR(err)("Make sure MetricType is initialised in concrete "
                    "QualityMetric constructor.", MsqError::INVALID_STATE);
    return false;
  }
  
  return true;
}

  bool MaxTemplate::compute_analytical_gradient(PatchData &patch,
                                                Vector3D *const &grad,
                                                double &OF_val,
                                                MsqError &err, 
                                                size_t array_size)
  {
    MSQ_SETERR(err)("The MaxTemplate 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