MOAB: Mesh Oriented datABase  (version 5.2.1)
ObjectiveFunctionTemplate.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 ObjectiveFunctionTemplate.hpp
00028  *  \brief
00029  *  \author Jason Kraftcheck
00030  */
00031 
00032 #ifndef MSQ_OBJECTIVE_FUNCTION_TEMPLATE_HPP
00033 #define MSQ_OBJECTIVE_FUNCTION_TEMPLATE_HPP
00034 
00035 #include "Mesquite.hpp"
00036 #include "ObjectiveFunction.hpp"
00037 
00038 namespace MBMesquite
00039 {
00040 
00041 /**\brief Base for most concrete objective functions
00042  *
00043  * Base class for objective functions which are a function
00044  * of a quality metric.
00045  */
00046 class MESQUITE_EXPORT ObjectiveFunctionTemplate : public ObjectiveFunction
00047 {
00048   public:
00049     ObjectiveFunctionTemplate( QualityMetric* qm = 0 ) : qualityMetric( qm ) {}
00050 
00051     virtual ~ObjectiveFunctionTemplate();
00052 
00053     QualityMetric* get_quality_metric() const
00054     {
00055         return qualityMetric;
00056     }
00057 
00058     void set_quality_metric( QualityMetric* metric )
00059     {
00060         qualityMetric = metric;
00061     }
00062 
00063     virtual bool initialize_block_coordinate_descent( MeshDomainAssoc* mesh_and_domain, const Settings* settings,
00064                                                       PatchSet* user_set, MsqError& err );
00065 
00066     virtual int min_patch_layers() const;
00067 
00068     //!\brief Called at start of instruction queue processing
00069     //!
00070     //! Do any preliminary global initialization, consistency checking,
00071     //! etc.  Default implementation does nothing.
00072     virtual void initialize_queue( MeshDomainAssoc* mesh_and_domain, const Settings* settings, MsqError& err );
00073 
00074   private:
00075     QualityMetric* qualityMetric;
00076 };
00077 
00078 }  // namespace MBMesquite
00079 
00080 #endif
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines