MOAB: Mesh Oriented datABase  (version 5.3.0)
StdDevTemplate.cpp
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.cpp
00028  *  \brief
00029  *  \author Jason Kraftcheck
00030  */
00031 
00032 #include "Mesquite.hpp"
00033 #include "StdDevTemplate.hpp"
00034 #include "QualityMetric.hpp"
00035 #include "MsqError.hpp"
00036 #include "MsqHessian.hpp"
00037 #include "PatchData.hpp"
00038 
00039 namespace MBMesquite
00040 {
00041 
00042 ObjectiveFunction* StdDevTemplate::clone() const
00043 {
00044     return new StdDevTemplate( *this );
00045 }
00046 
00047 bool StdDevTemplate::evaluate( EvalType type, PatchData& pd, double& value_out, bool free, MsqError& err )
00048 {
00049     bool result = VarianceTemplate::evaluate( type, pd, value_out, free, err );
00050     if( MSQ_CHKERR( err ) || !result ) return false;
00051 
00052     const double neg = get_quality_metric()->get_negate_flag();
00053     value_out        = neg * sqrt( neg * value_out );
00054     return true;
00055 }
00056 
00057 bool StdDevTemplate::evaluate_with_gradient( EvalType type, PatchData& pd, double& value_out,
00058                                              std::vector< Vector3D >& grad_out, MsqError& err )
00059 {
00060     bool result = VarianceTemplate::evaluate_with_gradient( type, pd, value_out, grad_out, err );
00061     if( MSQ_CHKERR( err ) || !result ) return false;
00062 
00063     const double neg = get_quality_metric()->get_negate_flag();
00064     value_out *= neg;                         // undo any negation done by VarianceTemplate
00065     value_out           = sqrt( value_out );  // standard deviation
00066     const double factor = 1.0 / ( 2.0 * value_out );
00067     for( std::vector< Vector3D >::iterator i = grad_out.begin(); i != grad_out.end(); ++i )
00068         *i *= factor;
00069     value_out *= neg;  // redo any negation done by VariandeTemplate
00070 
00071     return true;
00072 }
00073 
00074 bool StdDevTemplate::evaluate_with_Hessian_diagonal( EvalType type, PatchData& pd, double& value_out,
00075                                                      std::vector< Vector3D >& grad_out,
00076                                                      std::vector< SymMatrix3D >& hess_diag_out, MsqError& err )
00077 {
00078     bool result = VarianceTemplate::evaluate_with_Hessian_diagonal( type, pd, value_out, grad_out, hess_diag_out, err );
00079     if( MSQ_CHKERR( err ) || !result ) return false;
00080 
00081     const double neg = get_quality_metric()->get_negate_flag();
00082     value_out *= neg;                     // undo any negation done by VarianceTemplate
00083     value_out       = sqrt( value_out );  // standard deviation
00084     const double f1 = 1.0 / ( 2.0 * value_out );
00085     const double f2 = neg * -0.25 / ( value_out * value_out * value_out );
00086     for( size_t i = 0; i < grad_out.size(); ++i )
00087     {
00088         hess_diag_out[i] *= f1;
00089         hess_diag_out[i] += f2 * outer( grad_out[i] );
00090         grad_out[i] *= f1;
00091     }
00092 
00093     value_out *= neg;  // redo any negation done by VariandeTemplate
00094     return true;
00095 }
00096 
00097 }  // namespace MBMesquite
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines