MOAB: Mesh Oriented datABase  (version 5.4.0)
StdDevTemplate.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 StdDevTemplate.hpp
00028  *  \brief
00029  *  \author Jason Kraftcheck
00030  */
00031 
00032 #ifndef MSQ_STD_DEV_TEMPLATE_HPP
00033 #define MSQ_STD_DEV_TEMPLATE_HPP
00034 
00035 #include "Mesquite.hpp"
00036 #include "VarianceTemplate.hpp"
00037 
00038 namespace MBMesquite
00039 {
00040 
00041 /**\brief standard deviation template
00042  *
00043  * This class implements an objective function that is the
00044  * standard deviation of the quality metric evalutations.
00045  */
00046 class StdDevTemplate : public VarianceTemplate
00047 {
00048   public:
00049     MESQUITE_EXPORT
00050     StdDevTemplate( QualityMetric* qm = 0 ) : VarianceTemplate( qm ) {}
00051 
00052     MESQUITE_EXPORT
00053     virtual ~StdDevTemplate() {}
00054 
00055     MESQUITE_EXPORT
00056     virtual bool evaluate( EvalType type, PatchData& pd, double& value_out, bool free, MsqError& err );
00057 
00058     MESQUITE_EXPORT
00059     virtual bool evaluate_with_gradient( EvalType type,
00060                                          PatchData& pd,
00061                                          double& value_out,
00062                                          std::vector< Vector3D >& grad_out,
00063                                          MsqError& err );
00064 
00065     MESQUITE_EXPORT
00066     virtual bool evaluate_with_Hessian_diagonal( EvalType type,
00067                                                  PatchData& pd,
00068                                                  double& value_out,
00069                                                  std::vector< Vector3D >& grad_out,
00070                                                  std::vector< SymMatrix3D >& hess_diag_out,
00071                                                  MsqError& err );
00072 
00073     MESQUITE_EXPORT
00074     virtual ObjectiveFunction* clone() const;
00075 };
00076 
00077 }  // namespace MBMesquite
00078 
00079 #endif
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines