misc_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__MISC_UTIL__
#define __H__LIB_GRID__MISC_UTIL__
 
#include "lib_grid/grid/grid.h"
#include "lib_grid/grid_objects/grid_objects.h"
#include "lib_grid/common_attachments.h"
 
namespace ug
{
template <class TElem>
UG_API
typename TElem::side*
GetSharedSide(Grid& grid, TElem* e1, TElem* e2);
 
 
//  CalculateGridObjectCenter
template<class TAAPosVRT>
UG_API
inline
typename TAAPosVRT::ValueType
CalculateGridObjectCenter(const GridObject* o, TAAPosVRT& aaPosVRT);
 
 
 
template<class TAAPosVRT, class TAAWeightVRT>
UG_API
inline
typename TAAPosVRT::ValueType
CalculateGridObjectCenter(const GridObject* o, TAAPosVRT& aaPosVRT,
                TAAWeightVRT& aaWeight);
 
//  CalculateCenter
 
template <class TIterator, class TAAPosVRT>
UG_API 
typename TAAPosVRT::ValueType
CalculateCenter(TIterator begin, TIterator end, TAAPosVRT& aaPos);
 
//  FindClosestByCoordinate
 
template<class TElem, class TVertexPositionAttachmentAccessor>
UG_API 
TElem* FindClosestByCoordinate(const typename TVertexPositionAttachmentAccessor::ValueType& coord,
                 typename geometry_traits<TElem>::iterator iterBegin,
                 typename geometry_traits<TElem>::iterator iterEnd,
                 TVertexPositionAttachmentAccessor& aaPosVRT);
 
 
template<class vector_t, class TIterator, class TAAPos>
UG_API 
void CalculateBoundingBox(vector_t& vMinOut, vector_t& vMaxOut,
              TIterator begin, TIterator end,
              TAAPos& aaPos);
 
//  NumSharedVertices
 
template <class TElemPtr1, class TElemPtr2>
UG_API 
size_t NumSharedVertices(Grid& grid, TElemPtr1 elem1, TElemPtr2 elem2);
 
//  EraseConnectingElements
UG_API 
void EraseConnectingElements(Grid& grid, Vertex* v1, Vertex* v2);
 
//  EraseElements
template <class TElem>
UG_API 
void EraseElements(Grid& grid, typename geometry_traits<TElem>::iterator iterBegin,
            typename geometry_traits<TElem>::iterator iterEnd);
 
//  ElementDiameter
template <class TElem, class TAAPos>
number ElementDiameterSq(Grid& grid,
                         TAAPos& aaPos,
               TElem* elem);
 
template <class TAAPos>
number ElementDiameterSq(Grid& grid,
                         TAAPos& aaPos,
               GridObject* elem);
 
template <class TElem, class TAAPos>
number ElementDiameter(Grid& grid,
                       TAAPos& aaPos,
             TElem* elem);
 
 
template <class TAAPos, class TIterator>
number MaxElementDiameter(Grid& grid, TAAPos& aaPos,
                          TIterator iterBegin, TIterator iterEnd);
 
 
template <class TAAPos, class TIterator>
number MinElementDiameter(Grid& grid, TAAPos& aaPos,
                          TIterator iterBegin, TIterator iterEnd);
 
 
template <class TElem1, class TElem2, class TAAPos>
typename TAAPos::ValueType
GetDirection (TElem1* e1, TElem2* e2, const TAAPos& aaPos);
 
 
template <class TElem1, class TElem2, class TAAPos>
bool CheckDirection (TElem1* e1,
                     TElem2* e2,
                     const TAAPos& aaPos,
                     const typename TAAPos::ValueType& dir,
                     number minAngle,
                     number maxAngle);
 
 
}// end of namespace
 
//  include implementation of template methods.
#include "misc_util_impl.hpp"
 
#endif