MOAB: Mesh Oriented datABase  (version 5.4.0)
PatchPowerMeanP.hpp
Go to the documentation of this file.
00001 /* *****************************************************************
00002     MESQUITE -- The Mesh Quality Improvement Toolkit
00003 
00004     Copyright 2006 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     (2006) kraftche@cae.wisc.edu
00024 
00025   ***************************************************************** */
00026 
00027 /** \file PatchPowerMeanP.hpp
00028  *  \brief
00029  *  \author Jason Kraftcheck
00030  */
00031 
00032 #ifndef MSQ_PATCH_POWER_MEAN_P_HPP
00033 #define MSQ_PATCH_POWER_MEAN_P_HPP
00034 
00035 #include "Mesquite.hpp"
00036 #include "PMeanPTemplate.hpp"
00037 #include "Exponent.hpp"
00038 #include "Matrix3D.hpp"
00039 
00040 namespace MBMesquite
00041 {
00042 
00043 /**\brief Objective function: p-mean^p of p-mean^p of patch metric values
00044  */
00045 class PatchPowerMeanP : public PMeanPTemplate
00046 {
00047   public:
00048     /**
00049      *\param power   The exponent to use for the power-mean
00050      *\param qm      The quality metric.
00051      */
00052     MESQUITE_EXPORT
00053     PatchPowerMeanP( double power, QualityMetric* qm = 0 ) : PMeanPTemplate( power, qm ) {}
00054 
00055     /**\brief copy constructor
00056      *
00057      * Define a copy constructor because the compiler-provided
00058      * default one would also copy the temporary arrays, which
00059      * would be a waste of time.
00060      */
00061     MESQUITE_EXPORT
00062     PatchPowerMeanP( const PatchPowerMeanP& copy ) : PMeanPTemplate( copy ) {}
00063 
00064     MESQUITE_EXPORT
00065     virtual ~PatchPowerMeanP() {}
00066 
00067     MESQUITE_EXPORT virtual bool initialize_block_coordinate_descent( Mesh* mesh,
00068                                                                       MeshDomain* domain,
00069                                                                       const Settings* settings,
00070                                                                       PatchSet* user_set,
00071                                                                       MsqError& err );
00072 
00073     MESQUITE_EXPORT virtual bool evaluate( EvalType type, PatchData& pd, double& value_out, bool free, MsqError& err );
00074 
00075     MESQUITE_EXPORT virtual bool evaluate_with_gradient( EvalType type,
00076                                                          PatchData& pd,
00077                                                          double& value_out,
00078                                                          std::vector< Vector3D >& grad_out,
00079                                                          MsqError& err );
00080 
00081     MESQUITE_EXPORT virtual bool evaluate_with_Hessian( EvalType type,
00082                                                         PatchData& pd,
00083                                                         double& value_out,
00084                                                         std::vector< Vector3D >& grad_out,
00085                                                         MsqHessian& Hessian_out,
00086                                                         MsqError& err );
00087 
00088     MESQUITE_EXPORT virtual ObjectiveFunction* clone() const;
00089 };
00090 
00091 }  // namespace MBMesquite
00092 
00093 #endif
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines