MOAB: Mesh Oriented datABase  (version 5.2.1)
ScalarMultiplyQualityMetric.hpp
Go to the documentation of this file.
00001 /* *****************************************************************
00002     MESQUITE -- The Mesh Quality Improvement Toolkit
00003 
00004     Copyright 2004 Sandia Corporation and Argonne National
00005     Laboratory.  Under the terms of Contract DE-AC04-94AL85000
00006     with Sandia Corporation, the U.S. Government 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     diachin2@llnl.gov, djmelan@sandia.gov, mbrewer@sandia.gov,
00024     pknupp@sandia.gov, tleurent@mcs.anl.gov, tmunson@mcs.anl.gov
00025 
00026   ***************************************************************** */
00027 // -*- Mode : c++; tab-width: 3; c-tab-always-indent: t; indent-tabs-mode: nil; c-basic-offset: 3
00028 // -*-
00029 
00030 /*! \file ScalarMultiplyQualityMetric.hpp
00031 \brief
00032 Header file for the MBMesquite::ScalarMultiplyQualityMetric class
00033 
00034   \author Todd Munson
00035   \date   2004-12-21
00036  */
00037 
00038 #ifndef ScalarMultiplyQualityMetric_hpp
00039 #define ScalarMultiplyQualityMetric_hpp
00040 
00041 #include "Mesquite.hpp"
00042 #include "QualityMetric.hpp"
00043 
00044 namespace MBMesquite
00045 {
00046 /*! \class ScalarMultiplyQualityMetric
00047   \brief Multiplies quality metric value by a number (a double).
00048 */
00049 class ScalarMultiplyQualityMetric : public QualityMetric
00050 {
00051   public:
00052     ScalarMultiplyQualityMetric( QualityMetric* metric, double scale ) : mMetric( metric ), mScale( scale ) {}
00053 
00054     ~ScalarMultiplyQualityMetric() {}
00055 
00056     MetricType get_metric_type() const
00057     {
00058         return mMetric->get_metric_type();
00059     }
00060 
00061     std::string get_name() const;
00062 
00063     int get_negate_flag() const
00064     {
00065         return mMetric->get_negate_flag();
00066     }
00067 
00068     void get_evaluations( PatchData& pd, std::vector< size_t >& handles, bool free_vertices_only, MsqError& err );
00069 
00070     bool evaluate( PatchData& pd, size_t handle, double& value, MsqError& err );
00071 
00072     bool evaluate_with_indices( PatchData& pd, size_t handle, double& value, std::vector< size_t >& indices,
00073                                 MsqError& err );
00074 
00075     bool evaluate_with_gradient( PatchData& pd, size_t handle, double& value, std::vector< size_t >& indices,
00076                                  std::vector< Vector3D >& gradient, 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* mMetric;
00083     double mScale;
00084 };
00085 
00086 }  // namespace MBMesquite
00087 
00088 #endif  // ScalarMultiplyQualityMetric_hpp
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines