MOAB: Mesh Oriented datABase  (version 5.2.1)
TUntangleMu.hpp
Go to the documentation of this file.
00001 /* *****************************************************************
00002     MESQUITE -- The Mesh Quality Improvement Toolkit
00003 
00004     Copyright 2010 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     (2010) kraftche@cae.wisc.edu
00024 
00025   ***************************************************************** */
00026 
00027 /** \file TUntangleMu.hpp
00028  *  \brief
00029  *  \author Jason Kraftcheck
00030  */
00031 
00032 #ifndef MSQ_T_UNTANGLE_MU_HPP
00033 #define MSQ_T_UNTANGLE_MU_HPP
00034 
00035 #include "Mesquite.hpp"
00036 #include "TMetric.hpp"
00037 
00038 namespace MBMesquite
00039 {
00040 
00041 /**\brief Composite untangle metric
00042  *
00043  * This metric should be combined with TRel2DSize or TRel2DShapeSize
00044  * to produce a concrete untangle metric.
00045  *
00046  * \f$ \mu^\prime(T) = \frac{1}{8}(|d| - d)^3 \f$
00047  * \f$ d(T) = \sigma - \epsilon - \mu(T()) \f$
00048  *
00049  */
00050 class TUntangleMu : public TMetric
00051 {
00052   private:
00053     TMetric* mBaseMetric;
00054     double mConstant;
00055 
00056   public:
00057     TUntangleMu( TMetric* base, double sigma = 1.0 )
00058         : mBaseMetric( base ), mConstant( 0.99 * sigma ) /* default epsilon is 0.01*sigma */
00059     {
00060     }
00061 
00062     TUntangleMu( TMetric* base, double sigma, double epsilon ) : mBaseMetric( base ), mConstant( sigma - epsilon ) {}
00063 
00064     MESQUITE_EXPORT virtual ~TUntangleMu();
00065 
00066     MESQUITE_EXPORT virtual std::string get_name() const;
00067 
00068     MESQUITE_EXPORT virtual bool evaluate( const MsqMatrix< 2, 2 >& T, double& result, MsqError& err );
00069 
00070     MESQUITE_EXPORT virtual bool evaluate_with_grad( const MsqMatrix< 2, 2 >& T, double& result,
00071                                                      MsqMatrix< 2, 2 >& deriv_wrt_T, MsqError& err );
00072 
00073     MESQUITE_EXPORT virtual bool evaluate_with_hess( const MsqMatrix< 2, 2 >& T, double& result,
00074                                                      MsqMatrix< 2, 2 >& deriv_wrt_T, MsqMatrix< 2, 2 > second_wrt_T[3],
00075                                                      MsqError& err );
00076 
00077     MESQUITE_EXPORT virtual bool evaluate( const MsqMatrix< 3, 3 >& T, double& result, MsqError& err );
00078 
00079     MESQUITE_EXPORT virtual bool evaluate_with_grad( const MsqMatrix< 3, 3 >& T, double& result,
00080                                                      MsqMatrix< 3, 3 >& deriv_wrt_T, MsqError& err );
00081 
00082     MESQUITE_EXPORT virtual bool evaluate_with_hess( const MsqMatrix< 3, 3 >& T, double& result,
00083                                                      MsqMatrix< 3, 3 >& deriv_wrt_T, MsqMatrix< 3, 3 > second_wrt_T[6],
00084                                                      MsqError& err );
00085 
00086   private:
00087     template < unsigned D >
00088     inline bool eval( const MsqMatrix< D, D >& T, double& result, MsqError& err );
00089     template < unsigned D >
00090     inline bool grad( const MsqMatrix< D, D >& T, double& result, MsqMatrix< D, D >& first, MsqError& err );
00091     template < unsigned D >
00092     inline bool hess( const MsqMatrix< D, D >& T, double& result, MsqMatrix< D, D >& first, MsqMatrix< D, D >* second,
00093                       MsqError& err );
00094 };
00095 
00096 }  // namespace MBMesquite
00097 
00098 #endif
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines