MOAB: Mesh Oriented datABase  (version 5.2.1)
ScalarAddQualityMetric.hpp
Go to the documentation of this file.
00001 /* *****************************************************************
00002     MESQUITE -- The Mesh Quality Improvement Toolkit
00003 
00004     Copyright 2006 Lawrence Livermore National Laboratory.  Under
00005     the terms of Contract B545069 with the University of Wisconsin --
00006     Madison, Lawrence Livermore National Laboratory retains certain
00007     rights in 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     (2006) kraftche@cae.wisc.edu
00024 
00025   ***************************************************************** */
00026 
00027 /** \file ScalarAddQualityMetric.hpp
00028  *  \brief
00029  *  \author Jason Kraftcheck
00030  */
00031 
00032 #ifndef MSQ_SCALAR_ADD_QUALITY_METRIC_HPP
00033 #define MSQ_SCALAR_ADD_QUALITY_METRIC_HPP
00034 
00035 #include "Mesquite.hpp"
00036 #include "QualityMetric.hpp"
00037 
00038 namespace MBMesquite
00039 {
00040 
00041 /**\brief Offset a quality metric by a scalar value */
00042 class ScalarAddQualityMetric : public QualityMetric
00043 {
00044   public:
00045     ScalarAddQualityMetric( QualityMetric* metric, double offset ) : mMetric( metric ), mOffset( offset ) {}
00046 
00047     ~ScalarAddQualityMetric() {}
00048 
00049     MetricType get_metric_type() const
00050     {
00051         return mMetric->get_metric_type();
00052     }
00053 
00054     std::string get_name() const;
00055 
00056     int get_negate_flag() const
00057     {
00058         return mMetric->get_negate_flag();
00059     }
00060 
00061     void get_evaluations( PatchData& pd, std::vector< size_t >& handles, bool free_vertices_only, MsqError& err );
00062 
00063     bool evaluate( PatchData& pd, size_t handle, double& value, MsqError& err );
00064 
00065     bool evaluate_with_indices( PatchData& pd, size_t handle, double& value, std::vector< size_t >& indices,
00066                                 MsqError& err );
00067 
00068     bool evaluate_with_gradient( PatchData& pd, size_t handle, double& value, std::vector< size_t >& indices,
00069                                  std::vector< Vector3D >& gradient, MsqError& err );
00070 
00071     bool evaluate_with_Hessian( PatchData& pd, size_t handle, double& value, std::vector< size_t >& indices,
00072                                 std::vector< Vector3D >& gradient, std::vector< Matrix3D >& Hessian, MsqError& err );
00073 
00074   private:
00075     QualityMetric* mMetric;
00076     double mOffset;
00077 };
00078 
00079 }  // namespace MBMesquite
00080 
00081 #endif
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines