MOAB: Mesh Oriented datABase  (version 5.2.1)
EdgeLengthMetric.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 EdgeLengthMetric.hpp
00028  *  \brief
00029  *  \author Jason Kraftcheck
00030  */
00031 
00032 #ifndef MSQ_EDGE_LENGTH_METRIC_HPP
00033 #define MSQ_EDGE_LENGTH_METRIC_HPP
00034 
00035 #include "EdgeQM.hpp"
00036 
00037 namespace MBMesquite
00038 {
00039 
00040 class EdgeLengthMetric : public EdgeQM
00041 {
00042   public:
00043     MESQUITE_EXPORT EdgeLengthMetric( double gamma = 0.0 );
00044 
00045     MESQUITE_EXPORT virtual std::string get_name() const;
00046 
00047     //! 1 if metric should be minimized, -1 if metric should be maximized.
00048     MESQUITE_EXPORT virtual int get_negate_flag() const;
00049 
00050     MESQUITE_EXPORT virtual bool evaluate( PatchData& pd, size_t handle, double& value, MsqError& err );
00051     MESQUITE_EXPORT virtual bool evaluate_with_gradient( PatchData& pd, size_t handle, double& value,
00052                                                          std::vector< size_t >& indices,
00053                                                          std::vector< Vector3D >& gradient, MsqError& err );
00054 
00055   private:
00056     double mGamma;
00057 };
00058 
00059 }  // namespace MBMesquite
00060 
00061 #endif
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines