MOAB: Mesh Oriented datABase  (version 5.2.1)
IdealElements.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 IdealElements.hpp
00028  *  \brief
00029  *  \author Jason Kraftcheck
00030  */
00031 
00032 #ifndef MSQ_IDEAL_ELEMENTS_HPP
00033 #define MSQ_IDEAL_ELEMENTS_HPP
00034 
00035 #include "Mesquite.hpp"
00036 
00037 namespace MBMesquite
00038 {
00039 
00040 class Vector3D;
00041 
00042 /**\brief Get ideal element with unit edge length
00043  *
00044  * Get list of vertex coordinates for an ideal element with it's
00045  * centroid at the origin and all edges of unit length.  Surface
00046  * elements lie in the XY plane.
00047  *
00048  *\param type the type of the element to obtain.
00049  *\param unit_height_pyramid If true, ideal pyramid has it's height equal
00050  *          to the length of an edge of the base, rather than the default
00051  *          of equilateral triangular faces.
00052  *\return corner vertex coordinates in canonical order.
00053  */
00054 const Vector3D* unit_edge_element( EntityTopology type, bool unit_height_pyramid = false );
00055 
00056 /**\brief Get ideal element with unit area or volume
00057  *
00058  * Get list of vertex coordinates for an ideal element with it's
00059  * centroid at the origin and unit area/volume.  Surface
00060  * elements lie in the XY plane.
00061  *
00062  *\param type the type of the element to obtain.
00063  *\param unit_height_pyramid If true, ideal pyramid has it's height equal
00064  *          to the length of an edge of the base, rather than the default
00065  *          of equilateral triangular faces.
00066  *\return corner vertex coordinates in canonical order.
00067  */
00068 const Vector3D* unit_element( EntityTopology type, bool unit_height_pyramid = false );
00069 
00070 }  // namespace MBMesquite
00071 
00072 #endif
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines