PyramidRule5.h

/**
 * \copyright
 * Copyright (c) 2012-2016, OpenGeoSys Community (http://www.opengeosys.org)
 *            Distributed under a Modified BSD License.
 *              See accompanying file LICENSE.txt or
 *              http://www.opengeosys.org/project/license
 *
 */

#ifndef PYRAMIDRULE5_H_
#define PYRAMIDRULE5_H_

#include "MeshLib/MeshEnums.h"
#include "Element.h"
#include "EdgeReturn.h"
#include "CellRule.h"

namespace MeshLib
{

/**
 * This class represents a 3d pyramid element. The following sketch shows the node and edge numbering.
 * @anchor Pyramid5NodeAndEdgeNumbering
 * @code
 *
 *               4
 *             //|\
 *            // | \
 *          7//  |  \6
 *          //   |5  \
 *         //    |    \
 *        3/.... |.....2
 *       ./      |  2 /
 *      ./4      |   /
 *    3./        |  /1
 *    ./         | /
 *   ./          |/
 *  0------------1
 *        0
 * @endcode

 */
class PyramidRule5 : public CellRule
{
public:
	/// Constant: The number of base nodes for this element
	static const unsigned n_base_nodes = 5u;

	/// Constant: The number of all nodes for this element
	static const unsigned n_all_nodes = 5u;

	/// Constant: The geometric type of the element
	static const MeshElemType mesh_elem_type = MeshElemType::PYRAMID;

	/// Constant: The FEM type of the element
	static const CellType cell_type = CellType::PYRAMID5;

	/// Constant: The number of faces
	static const unsigned n_faces = 5;

	/// Constant: The number of edges
	static const unsigned n_edges = 8;

	/// Constant: The number of neighbors
	static const unsigned n_neighbors = 5;

	/// Constant: Local node index table for faces
	static const unsigned face_nodes[5][4];

	/// Constant: Local node index table for edge
	static const unsigned edge_nodes[8][2];

	/// Constant: Table for the number of nodes for each face
	static const unsigned n_face_nodes[5];

	/// Returns the i-th edge of the element.
	typedef LinearEdgeReturn EdgeReturn;

	/// Get the number of nodes for face i.
	static unsigned getNFaceNodes(unsigned i);

	/// Returns the i-th face of the element.
	static const Element* getFace(const Element* e, unsigned i);

	/**
	 * Checks if a point is inside the element.
	 * @param pnt a 3D MathLib::Point3d object
	 * @param eps tolerance for numerical algorithm used or computing the property
	 * @return true if the point is not outside the element, false otherwise
	 */
	static bool isPntInElement(Node const* const* _nodes, MathLib::Point3d const& pnt, double eps);

	/**
	 * Tests if the element is geometrically valid.
	 */
	static ElementErrorCode validate(const Element* e);

	/// Returns the ID of a face given an array of nodes.
	static unsigned identifyFace(Node const* const*, Node* nodes[3]);

	/// Calculates the volume of a convex hexahedron by partitioning it into six tetrahedra.
	static double computeVolume(Node const* const* _nodes);

}; /* class */

} /* namespace */

#endif /* PYRAMIDRULE5_H_ */