/* ***************************************************************** 
    MESQUITE -- The Mesh Quality Improvement Toolkit

    Copyright 2010 Sandia National Laboratories.  Developed at the
    University of Wisconsin--Madison under SNL contract number
    624796.  The U.S. Government and the University of Wisconsin
    retain certain rights to this software.

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
    version 2.1 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public License 
    (lgpl.txt) along with this library; if not, write to the Free Software
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA

    (2010) kraftche@cae.wisc.edu    

  ***************************************************************** */


/** \file MeshUtil.hpp
 *  \author Jason Kraftcheck 
 */

#ifndef MSQ_MESH_UTIL_HPP
#define MSQ_MESH_UTIL_HPP

#include "Mesquite.hpp"

namespace MESQUITE_NS {

class Mesh;
class MsqError;
class SimpleStats;
class Settings;
class PatchData;

/**\brief Miscelanions operations performed on an entire \c Mesh
 *        without the conveinience of a \c PatchData.
 */
class MeshUtil 
{
  private:
    Mesh* myMesh;
    Settings* mySettings;
    PatchData* globalPatch;
    
  protected:
    PatchData* get_global_patch( MsqError& err );
    
  public:
    MeshUtil( Mesh* mesh, Settings* settings = 0 ) 
      : myMesh( mesh ), 
        mySettings( settings ),
        globalPatch(0) 
        {}
        
    ~MeshUtil();
    
    /**\brief Calcluate statistics for mesh edge lengths
     */
    void edge_length_distribution( SimpleStats& result, MsqError& err );

    void lambda_distribution( SimpleStats& result, MsqError& err );

    /**\brief Given two meshes, check if they are different, return true if they are.
     * 
     *\param mesh1 the first mesh to compare
     *\param mesh2 the second mesh to compare
     *\param tol a relative tolerance for coordinates
     *\param do_print flag for printing differences 
     *
     * \NOTE Only basic mesh properties are checked, number of vertices & elements,
     * element connectivity, and coordinates (within the given relative tolerance).
     */
  static bool meshes_are_different(Mesh& mesh1, Mesh& mesh2, MsqError& err, double tol=1.e-5, bool do_print = false);


};


} // namespace MESQUITE_NS

#endif
