MOAB: Mesh Oriented datABase  (version 5.2.1)
WeightCalculator.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 WeightCalculator.hpp
00028  *  \brief
00029  *  \author Jason Kraftcheck
00030  */
00031 
00032 #ifndef MSQ_WEIGHT_CALCULATOR_HPP
00033 #define MSQ_WEIGHT_CALCULATOR_HPP
00034 
00035 #include "Mesquite.hpp"
00036 #include "Sample.hpp"
00037 #include <stddef.h>
00038 
00039 namespace MBMesquite
00040 {
00041 
00042 class PatchData;
00043 class MsqError;
00044 class Mesh;
00045 class MeshDomain;
00046 class MeshDomainAssoc;
00047 class Settings;
00048 
00049 class MESQUITE_EXPORT WeightCalculator
00050 {
00051   public:
00052     virtual ~WeightCalculator();
00053 
00054     //!\brief Called at start of instruction queue processing
00055     //!
00056     //! Do any preliminary global initialization, consistency checking,
00057     //! etc.  Default implementation does nothing.
00058     virtual void initialize_queue( MeshDomainAssoc* mesh_and_domain, const Settings* settings, MsqError& err );
00059 
00060     /**\brief Get target metric weight
00061      *
00062      *\param pd      The current PatchData
00063      *\param element The index an element within the patch data.
00064      *\param sample  The sample point in the element.
00065      */
00066     virtual double get_weight( PatchData& pd, size_t element, Sample sample, MsqError& err ) = 0;
00067 };
00068 
00069 }  // namespace MBMesquite
00070 
00071 #endif
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines