elem_quality.h

一个用来实现偏微分方程中网格的计算库

// $Id: elem_quality.h 2501 2007-11-20 02:33:29Z benkirk $

// The libMesh Finite Element Library.
// Copyright (C) 2002-2007  Benjamin S. Kirk, John W. Peterson
  
// 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 along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA



#ifndef __elem_quality_h__
#define __elem_quality_h__

// C++ includes
#include <vector>
#include <string>

// Local includes
#include "enum_elem_type.h"
#include "enum_elem_quality.h"


/**
 * A namespace for quality utility functions.
 */
namespace Quality
{
  /**
   * The number of element quality types we have
   * defined.  This needs to be updated if you
   * add one.
   */
  const unsigned int num_quals = 16;

  /**
   * @returns a descriptive name for a \p ElemQuality
   * \p enum
   */
  std::string              name     (const ElemQuality q);
  
  /**
   * @returns a description for a \p ElemQuality
   * \p enum
   */
  std::string              describe (const ElemQuality q);

  /**
   * @returns the valid \p ElemQuality metrics for a given
   * \p ElemType element type.
   */
  std::vector<ElemQuality> valid    (const ElemType    t);
}


#endif