face_util.h

Go to the documentation of this file.

/*
 * Copyright (c) 2009-2015:  G-CSC, Goethe University Frankfurt
 * Author: Sebastian Reiter
 * 
 * This file is part of UG4.
 * 
 * UG4 is free software: you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License version 3 (as published by the
 * Free Software Foundation) with the following additional attribution
 * requirements (according to LGPL/GPL v3 §7):
 * 
 * (1) The following notice must be displayed in the Appropriate Legal Notices
 * of covered and combined works: "Based on UG4 (www.ug4.org/license)".
 * 
 * (2) The following notice must be displayed at a prominent place in the
 * terminal output of covered works: "Based on UG4 (www.ug4.org/license)".
 * 
 * (3) The following bibliography is recommended for citation and must be
 * preserved in all covered files:
 * "Reiter, S., Vogel, A., Heppner, I., Rupp, M., and Wittum, G. A massively
 *   parallel geometric multigrid solver on hierarchically distributed grids.
 *   Computing and visualization in science 16, 4 (2013), 151-164"
 * "Vogel, A., Reiter, S., Rupp, M., Nägel, A., and Wittum, G. UG4 -- a novel
 *   flexible software system for simulating pde based models on high performance
 *   computers. Computing and visualization in science 16, 4 (2013), 165-179"
 * 
 * This program 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.
 */
 
#ifndef __H__LIB_GRID__FACE_UTIL__
#define __H__LIB_GRID__FACE_UTIL__
 
#include "lib_grid/grid/grid.h"
#include "lib_grid/grid_objects/grid_objects.h"
#include "lib_grid/common_attachments.h"
 
namespace ug
{
 
//  GetFaceIndex
 
UG_API int GetFaceIndex(Volume* vol, Face* f);
 
 
//  CalculateNormal
 
UG_API 
void CalculateNormal(vector3& vNormOut, const FaceVertices* face,
          Grid::AttachmentAccessor<Vertex, APosition>& aaPos);
 
//  CalculateNormal
 
UG_API 
void CalculateNormalNoNormalize(vector3& vNormOut, FaceVertices* face,
            Grid::AttachmentAccessor<Vertex, APosition>& aaPos);
          
//  CalculateFaceNormals
 
UG_API 
void CalculateFaceNormals(Grid& grid, const FaceIterator& facesBegin,
            const FaceIterator& facesEnd,
            AVector3& aPos, AVector3& aNorm);
 
int NumAssociatedVolumes(Grid& grid, Face* f);
 
//  IsVolumeBoundaryFace
 
UG_API 
bool IsVolumeBoundaryFace(Grid& grid, Face* f);
 
//  IsVolumeBoundaryFace
 
UG_API 
bool IsVolumeBoundaryFace(Grid& grid, ConstrainedFace* f);
 
//  IsVolumeBoundaryFace
 
UG_API 
bool IsVolumeBoundaryFace(Grid& grid, ConstrainingFace* f);
 
template <class TFace>
UG_API 
bool IsBoundaryFace3D(Grid& grid, TFace* f)
{return IsVolumeBoundaryFace(grid, f);}
 
template <class TFace>
UG_API 
bool LiesOnBoundary(Grid& grid, TFace* f)
{return IsBoundaryFace3D(grid, f);}
 
//  FaceArea
template <class TAAPosVRT>
UG_API 
number FaceArea(FaceVertices* f, TAAPosVRT& aaPos);
 
//  FaceArea
template <class TIterator, class TAAPosVRT>
UG_API
number FaceArea(TIterator facesBegin, TIterator facesEnd, TAAPosVRT& aaPos);
 
 
template <class TIterator, class TAAPosVRT>
UG_API 
Face* FindSmallestFace(TIterator facesBegin, TIterator facesEnd, TAAPosVRT& aaPos);
 
//  FaceQuality
 
UG_API 
number FaceQuality(FaceVertices* f, Grid::VertexAttachmentAccessor<APosition> aaPos);
 
//  AreaFaceQuality
 
template <class TIterator>
UG_API 
number AreaFaceQuality(TIterator facesBegin, TIterator facesEnd,
             Grid::VertexAttachmentAccessor<APosition>& aaPos);
 
//  TriangleQuality
 
UG_API number TriangleQuality(vector3& v1, vector3& v2, vector3& v3);
 
//  Triangulate
 
UG_API 
void Triangulate(Grid& grid, Quadrilateral* q,
        Grid::VertexAttachmentAccessor<APosition>* paaPos = NULL);
 
//  Triangulate
 
UG_API 
void Triangulate(Grid& grid,
        QuadrilateralIterator iterBegin,
        QuadrilateralIterator iterEnd,
        Grid::VertexAttachmentAccessor<APosition>* paaPos = NULL);
 
UG_API 
inline void Triangulate(Grid& grid,
            Grid::VertexAttachmentAccessor<APosition>* paaPos = NULL);
 
//  GetNeighbours
 
UG_API 
void GetNeighbours(std::vector<Face*>& vFacesOut, Grid& grid, Face* f,
          int side, bool clearContainer = true);
          
 
//  template methods
//  CalculateCenter
 
template<class TVertexPositionAttachmentAccessor>
UG_API 
typename TVertexPositionAttachmentAccessor::ValueType
CalculateCenter(const FaceVertices* f, TVertexPositionAttachmentAccessor& aaPosVRT);
 
template<class TAAPosVRT, class TAAWeightVRT>
UG_API
typename TAAPosVRT::ValueType
CalculateCenter(const FaceVertices* f, TAAPosVRT& aaPos, TAAWeightVRT& aaWeight);
 
 
 
template <class vector_t, class TAAPos>
UG_API bool
ContainsPoint(const FaceVertices* f, const vector_t& p, TAAPos aaPos);
 
 
//  project points to surface 
template <class TTriangleIterator, class TAAPosVRT>
UG_API 
bool ProjectPointToSurface(vector3& vOut, const vector3& v, const vector3& n,
               TTriangleIterator trisBegin, TTriangleIterator trisEnd,
               TAAPosVRT& aaPos, bool compareNormals = false);
 
 
template <class TAAPosVRT>
UG_API 
int PointFaceTest(vector3& v, Face* f, TAAPosVRT& aaPos);
 
 
template <class TAAPosVRT>
UG_API 
bool IsDegenerated(Face* f, TAAPosVRT& aaPos, number threshold = SMALL);
 
 
 
UG_API
void InsertCenterVertex(Grid& g, Face* f, Vertex* vrt, bool eraseOldFace);
 
 
}// end of namespace
 
//  include implementation
#include "face_util_impl.hpp"
 
#endif