MOAB: Mesh Oriented datABase  (version 5.2.1)
NumericalQM.hpp
Go to the documentation of this file.
00001 /* *****************************************************************
00002     MESQUITE -- The Mesh Quality Improvement Toolkit
00003 
00004     Copyright 2009 Sandia National Laboratories.  Developed at the
00005     University of Wisconsin--Madison under SNL contract number
00006     624796.  The U.S. Government and the University of Wisconsin
00007     retain certain rights to this software.
00008 
00009     This library is free software; you can redistribute it and/or
00010     modify it under the terms of the GNU Lesser General Public
00011     License as published by the Free Software Foundation; either
00012     version 2.1 of the License, or (at your option) any later version.
00013 
00014     This library is distributed in the hope that it will be useful,
00015     but WITHOUT ANY WARRANTY; without even the implied warranty of
00016     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00017     Lesser General Public License for more details.
00018 
00019     You should have received a copy of the GNU Lesser General Public License
00020     (lgpl.txt) along with this library; if not, write to the Free Software
00021     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
00022 
00023     (2009) kraftche@cae.wisc.edu
00024 
00025   ***************************************************************** */
00026 
00027 /** \file NumericalQM.hpp
00028  *  \brief
00029  *  \author Jason Kraftcheck
00030  */
00031 
00032 #ifndef MSQ_NUMERICAL_QM_HPP
00033 #define MSQ_NUMERICAL_QM_HPP
00034 
00035 #include "Mesquite.hpp"
00036 #include "QualityMetric.hpp"
00037 
00038 namespace MBMesquite
00039 {
00040 
00041 /**\brief Use finite difference rather than analytical derivative calculations.
00042  *
00043  * This class acts as a decorator for (wrapper around) an existing
00044  * QualityMetric.  It bypasses any code provided by the underlying
00045  * metric for calculation of derivatives, forcing the use of finite
00046  * difference approximation of the derivatives.
00047  */
00048 class NumericalQM : public QualityMetric
00049 {
00050   public:
00051     /**
00052      *\param real_metric  The actual quality metric.
00053      *\param numerical_gradient Use finite difference to calculate first derivatives
00054      *\param numerical_hessian  Use finite difference to calculate second derivatives
00055      */
00056     NumericalQM( QualityMetric* real_metric, bool numerical_gradient = true, bool numerical_hessian = true );
00057 
00058     MetricType get_metric_type() const;
00059 
00060     std::string get_name() const;
00061 
00062     int get_negate_flag() const;
00063 
00064     void get_evaluations( PatchData& pd, std::vector< size_t >& handles, bool free_vertices_only, MsqError& err );
00065 
00066     bool evaluate( PatchData& pd, size_t handle, double& value, MsqError& err );
00067 
00068     bool evaluate_with_indices( PatchData& pd, size_t handle, double& value, std::vector< size_t >& indices,
00069                                 MsqError& err );
00070 
00071     bool evaluate_with_gradient( PatchData& pd, size_t handle, double& value, std::vector< size_t >& indices,
00072                                  std::vector< Vector3D >& gradient, MsqError& err );
00073 
00074     bool evaluate_with_Hessian_diagonal( PatchData& pd, size_t handle, double& value, std::vector< size_t >& indices,
00075                                          std::vector< Vector3D >& gradient,
00076                                          std::vector< SymMatrix3D >& Hessian_diagonal, MsqError& err );
00077 
00078     bool evaluate_with_Hessian( PatchData& pd, size_t handle, double& value, std::vector< size_t >& indices,
00079                                 std::vector< Vector3D >& gradient, std::vector< Matrix3D >& Hessian, MsqError& err );
00080 
00081   private:
00082     QualityMetric* realMetric;
00083     bool numericGrad, numericHess;
00084 };
00085 
00086 }  // namespace MBMesquite
00087 
00088 #endif
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines