vertex_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__VERTEX_UTIL__
#define __H__LIB_GRID__VERTEX_UTIL__
 
#include <vector>
#include "lib_grid/grid/grid.h"
#include "lib_grid/grid_objects/grid_objects.h"
#include "lib_grid/common_attachments.h"
#include "lib_grid/tools/subset_handler_grid.h"
#include "lib_grid/callbacks/basic_callbacks.h"
#include "common/math/ugmath.h"
 
namespace ug
{
//  GetVertexIndex
 
UG_API int GetVertexIndex(EdgeVertices* e, Vertex* v);
 
//  GetVertexIndex
 
UG_API int GetVertexIndex(FaceVertices* f, Vertex* v);
 
//  GetVertexIndex
 
UG_API int GetVertexIndex(VolumeVertices* vol, Vertex* v);
 
//  GetConnectedVertex
 
UG_API Vertex* GetConnectedVertex(Edge* e, Vertex* v);
 
//  GetConnectedVertex
UG_API Vertex* GetConnectedVertex(EdgeVertices* e, Face* f);
 
//  GetConnectedVertexIndex
UG_API int GetConnectedVertexIndex(Face* f, const EdgeDescriptor& ed);
UG_API int GetConnectedVertexIndex(Face* f, const EdgeVertices* e);
 
 
UG_API Edge* GetConnectedEdge(Grid& g, Vertex* vrt, Face* tri);
 
 
UG_API Vertex* GetSharedVertex(IVertexGroup* vrts0, IVertexGroup* vrts1);
 
 
size_t GetSharedVertices(
      std::vector<Vertex*>& vrtsOut,
      IVertexGroup* vrts0,
      IVertexGroup* vrts1);
 
size_t NumSharedVertices(IVertexGroup* vrts0, IVertexGroup* vrts1);
 
UG_API
int NumAssociatedEdges(Grid& grid, Vertex* v);
 
UG_API
int NumAssociatedFaces(Grid& grid, Vertex* v);
 
//  CollectSurfaceNeighborsSorted
 
UG_API 
bool CollectSurfaceNeighborsSorted(std::vector<Vertex*>& vNeighborsOut,
                   Grid& grid, Vertex* v);
                  
template <class TAAPos>
UG_API 
number VertexDistanceSq(Vertex* v0, Vertex* v1, TAAPos& aaPos);
 
template <class TAAPos>
UG_API 
number VertexDistance(Vertex* v0, Vertex* v1, TAAPos& aaPos);
 
//  FindVertexByCoordiante
 
UG_API 
Vertex* FindVertexByCoordiante(vector3& coord, VertexIterator iterBegin,
                  VertexIterator iterEnd,
                  Grid::VertexAttachmentAccessor<APosition>& aaPos);
 
 
template <size_t dim>
int FindVertexByCoordinate(const MathVector<dim>& coord, size_t ncoords, const MathVector<dim> vCoords[]);
 
 
template <class TAAPosVRT>
UG_API 
void CalculateVertexNormal(vector3& nOut, Grid& grid, Vertex* vrt,
               TAAPosVRT& aaPos);
 
 
template <class TAAPosVRT>
UG_API 
void CalculateBoundaryVertexNormal2D(typename TAAPosVRT::ValueType& nOut,
                   Grid& grid, Vertex* vrt,
                         TAAPosVRT& aaPos);
 
 
template <class TAAPosVRT>
UG_API 
void CalculateBoundaryVertexNormal3D(vector3& nOut, Grid& grid, Vertex* vrt,
                         TAAPosVRT& aaPos);
 
//  CalculateVertexNormals
 
UG_API 
bool CalculateVertexNormals(Grid& grid, APosition& aPos, ANormal& aNorm);
 
UG_API 
bool CalculateVertexNormals(Grid& grid,
              Grid::AttachmentAccessor<Vertex, APosition>& aaPos,
              Grid::AttachmentAccessor<Vertex, ANormal>& aaNorm);
 
//  CalculateBoundingBox
 
template <class TVrtIter, class TAPosition>
UG_API 
void
CalculateBoundingBox(typename TAPosition::ValueType& vMinOut,
           typename TAPosition::ValueType& vMaxOut,
           TVrtIter vrtsBegin, TVrtIter vrtsEnd,
           Grid::AttachmentAccessor<Vertex, TAPosition>& aaPos);
 
//  CalculateCenter
 
template <class TVrtIter, class TAPosition>
UG_API 
typename TAPosition::ValueType
CalculateCenter(TVrtIter vrtsBegin, TVrtIter vrtsEnd,
        Grid::AttachmentAccessor<Vertex, TAPosition>& aaPos);
 
//  CalculateBarycenter
template <class TVrtIter, class TAPosition>
UG_API 
typename TAPosition::ValueType
CalculateBarycenter(TVrtIter vrtsBegin, TVrtIter vrtsEnd,
          Grid::VertexAttachmentAccessor<TAPosition>& aaPos);
 
//  MergeVertices
 
UG_API 
void MergeVertices(Grid& grid, Vertex* v1, Vertex* v2);
 
 
template <class TVrtIterator>
UG_API 
Vertex* MergeMultipleVertices(Grid& grid, TVrtIterator vrtsBegin,
                      TVrtIterator vrtsEnd);
 
//  RemoveDoubles
 
template <int dim, class TVrtIterator>
UG_API 
void RemoveDoubles(Grid& grid, const TVrtIterator& iterBegin,
          const TVrtIterator& iterEnd, Attachment<MathVector<dim> >& aPos,
          number threshold);
 
template <int dim, class TVrtIterator, class TAAPos>
UG_API 
void RemoveDoubles(Grid& grid, const TVrtIterator& iterBegin,
          const TVrtIterator& iterEnd,
          TAAPos aaPos,
          number threshold);
 
UG_API 
bool IsBoundaryVertex1D(Grid& grid, Vertex* v,
            Grid::edge_traits::callback cbConsiderEdge = ConsiderAll());
 
 
UG_API bool IsBoundaryVertex2D(Grid& grid, Vertex* v);
 
 
UG_API bool IsBoundaryVertex3D(Grid& grid, Vertex* v);
 
UG_API bool LiesOnBoundary(Grid& grid, Vertex* v);
 
//  IsRegularSurfaceVertex
 
UG_API bool IsRegularSurfaceVertex(Grid& grid, Vertex* v);
 
 
UG_API 
void MarkFixedCreaseVertices(Grid& grid, SubsetHandler& sh,
              int creaseSI, int fixedSI);
 
 
template<class TVertexPositionAttachmentAccessor>
UG_API 
inline
typename TVertexPositionAttachmentAccessor::ValueType
CalculateCenter(const Vertex* v, TVertexPositionAttachmentAccessor& aaPosVRT);
 
template<class TAAPosVRT, class TAAWeightVRT>
UG_API
typename TAAPosVRT::ValueType
CalculateCenter(const Vertex* v, TAAPosVRT& aaPos, TAAWeightVRT& aaWeight);
template<class TAAPos> inline
UG_API 
void TransformVertex(Vertex* vrt, matrix33& m, TAAPos& aaPos);
 
template<class TIterator, class TAAPos> inline
UG_API 
void TransformVertices(TIterator vrtsBegin, TIterator vrtsEnd,
             matrix33& m, TAAPos& aaPos);
 
template<class TIterator, class TAAPos> inline
void MoveVertices(TIterator vrtsBegin, TIterator vrtsEnd, TAAPos aaPos,
          const typename TAAPos::ValueType& offset);
 
 
template <class vector_t, class TAAPos>
UG_API bool
ContainsPoint(const Vertex* v, const vector_t& p, TAAPos aaPos);
 
 
}// end of namespace
 
//  include implementation
#include "vertex_util_impl.hpp"
 
#endif