edge_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__EDGE_UTIL__
#define __H__LIB_GRID__EDGE_UTIL__
 
#include "face_util.h"
#include "lib_grid/grid/grid.h"
#include "lib_grid/grid/grid_util.h"
#include "lib_grid/grid_objects/grid_objects.h"
#include "lib_grid/common_attachments.h"
#include "lib_grid/tools/selector_grid.h"
#include "lib_grid/tools/subset_handler_interface.h"
 
namespace ug
{
//  GetEdgeIndex
 
UG_API int GetEdgeIndex(Face* f, Edge* e);
 
//  GetEdgeIndex
 
UG_API int GetEdgeIndex(Volume* vol, Edge* e);
 
 
 
UG_API 
bool IsBoundaryEdge(Grid& grid, Edge* e,
          Grid::face_traits::callback funcIsSurfFace);
 
 
 
UG_API bool IsBoundaryEdge2D(Grid& grid, Edge* e);
 
 
UG_API bool IsBoundaryEdge3D(Grid& grid, Edge* e);
 
UG_API bool LiesOnBoundary(Grid& grid, Edge* e);
 
//  GetAssociatedFaces
 
UG_API 
int GetAssociatedFaces(Face** facesOut, Grid& grid,
            Edge* e, int maxNumFaces);
 
//  NumAssociatedFaces
 
UG_API 
int NumAssociatedFaces(Grid& grid, Edge* e);
 
UG_API
Edge* GetConnectingEdge(Grid& grid, Face* f1, Face* f2);
 
 
template <class face_iter_t>
void GetInnerEdgesOfFaceSoup(
      std::vector<Edge*>& edgesOut,
      Grid& g,
      face_iter_t facesBegin,
      face_iter_t facesEnd);
 
 
template <class TAAPosVRT>
UG_API 
inline number EdgeLengthSq(const EdgeVertices* e, TAAPosVRT& aaPos);
 
 
template <class TAAPosVRT>
UG_API 
inline number EdgeLength(const EdgeVertices* e, TAAPosVRT& aaPos);
 
//  CalculateNormal
 
UG_API 
int CalculateNormal(vector3& vNormOut, Grid& grid, Edge* e,
          Grid::AttachmentAccessor<Vertex, APosition>& aaPos,
          Grid::AttachmentAccessor<Face, ANormal>* paaNormFACE = NULL);
 
//  CalculateNormal
 
UG_API 
int CalculateNormalNoNormalize(vector3& vNormOut, Grid& grid, Edge* e,
          Grid::VertexAttachmentAccessor<APosition>& aaPos,
          Grid::FaceAttachmentAccessor<ANormal>* paaNormFACE = NULL);
                    
//  CollapseEdge
 
UG_API 
bool CollapseEdge(Grid& grid, Edge* e, Vertex* newVrt);
 
//  EdgeCollapseIsValid
 
UG_API 
bool EdgeCollapseIsValid(Grid& grid, Edge* e);
 
 
//  SplitEdge
 
template<class TVertex>
TVertex* SplitEdge(Grid& grid, Edge* e, bool bConservative = false);
 
//  SplitEdge
 
template<class TVertex>
TVertex* SplitEdge(Grid& destGrid, Grid& srcGrid, Edge* e,
            AVertex* paAssociatedVertices = NULL,
            bool bConservative = false);
 
//  SwapEdge
 
UG_API 
Edge* SwapEdge(Grid& grid, Edge* e);
 
//  CreateEdgeSplitGeometry
 
UG_API 
bool CreateEdgeSplitGeometry(Grid& destGrid, Grid& srcGrid, Edge* e,
               Vertex* newVertex,
               AVertex* paAssociatedVertices = NULL);
 
 
template<class TVertexPositionAttachmentAccessor>
UG_API 
typename TVertexPositionAttachmentAccessor::ValueType
CalculateCenter(const Edge* e, TVertexPositionAttachmentAccessor& aaPosVRT);
 
 
 
template<class TAAPosVRT, class TAAWeightVRT>
UG_API
typename TAAPosVRT::ValueType
CalculateCenter(const EdgeVertices* e, TAAPosVRT& aaPos, TAAWeightVRT& aaWeight);
 
 
 
UG_API 
bool CutEdgesWithPlane(Selector& sel, const vector3& p, const vector3& n,
            APosition& aPos = aPosition);
 
//  FixOrientation
 
template <class TEdgeIterator>
UG_API 
void FixEdgeOrientation(Grid& grid, TEdgeIterator edgesBegin,
            TEdgeIterator edgesEnd);
 
 
template <class TEdgeIterator>
UG_API
void AdjustEdgeOrientationToFaceOrientation(Grid& grid, TEdgeIterator edgesBegin,
                                TEdgeIterator edgesEnd);
 
template <class TEdgeIterator>
UG_API
void AdjustEdgeOrientationToFaceOrientation(Grid& grid, TEdgeIterator edgesBegin,
                                TEdgeIterator edgesEnd,
                                Grid::face_traits::callback considerFace);
 
 
template <class TEdgeIterator, class TAAPosVRT>
UG_API 
Edge* FindShortestEdge(TEdgeIterator edgesBegin, TEdgeIterator edgesEnd,
              TAAPosVRT& aaPos);
 
//template <class TEdgeIterator>
//UG_API 
//void RemoveDoubleEdges(Grid& grid, TEdgeIterator edgesBegin, TEdgeIterator edgesEnd);
 
 
template <class EdgeIterator, class TAAPos>
UG_API 
void MinimizeEdgeLength_SwapsOnly(Grid& grid, EdgeIterator edgesBegin,
                  EdgeIterator edgesEnd, TAAPos& aaPos);
 
 
template <class vector_t, class TAAPos>
UG_API bool
ContainsPoint(const EdgeVertices* e, const vector_t& p, TAAPos aaPos);
 
 
template <class TAAPosVRT>
number CalculateAverageEdgeLength(Grid& grid, TAAPosVRT& aaPos);
 
 
}// end of namespace
 
//  include template-methods implementations
#include "edge_util_impl.hpp"
 
#endif