volume_util.h

Go to the documentation of this file.

/*
 * Copyright (c) 2009-2015:  G-CSC, Goethe University Frankfurt
 * Authors: Sebastian Reiter, Martin Stepniewski
 * 
 * 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__VOLUME_UTIL__
#define __H__LIB_GRID__VOLUME_UTIL__
 
#include <vector>
#include "lib_grid/grid/grid.h"
#include "lib_grid/grid_objects/grid_objects.h"
#include "lib_grid/common_attachments.h"
 
namespace ug
{
 
//  GetNeighbours - sreiter
 
UG_API 
void GetNeighbours(std::vector<Volume*>& vVolsOut, Grid& grid, Volume* v,
          int side, bool clearContainer = true);
 
 
//  CalculateVolumeMinHeight - mstepnie
UG_API
number CalculateMinVolumeHeight(Tetrahedron* tet,
                Grid::VertexAttachmentAccessor<APosition>& aaPos);
 
 
//  CalculateTetrahedronAspectRatio - mstepnie
UG_API 
number CalculateTetrahedronAspectRatio(Grid& grid, Tetrahedron* tet,
              Grid::VertexAttachmentAccessor<APosition>& aaPos);
 
//  CalculateHexahedronAspectRatio
UG_API
number CalculateHexahedronAspectRatio(Grid& grid, Hexahedron* tet,
              Grid::VertexAttachmentAccessor<APosition>& aaPos);
 
//  CalculatePyramidAspectRatio
UG_API
number CalculatePyramidAspectRatio
(
  Grid& grid,
  Pyramid* pyr,
  Grid::VertexAttachmentAccessor<APosition>& aaPos
);
 
 
//  CalculateTetrahedronRootMeanSquareFaceArea - mstepnie
UG_API
number CalculateTetrahedronRootMeanSquareFaceArea(Grid& grid,
                          Tetrahedron* tet,
                          Grid::VertexAttachmentAccessor<APosition>& aaPos);
 
 
//  CalculateTetrahedronVolToRMSFaceAreaRatio - mstepnie
UG_API
number CalculateTetrahedronVolToRMSFaceAreaRatio(Grid& grid,
                           Tetrahedron* tet,
                         Grid::VertexAttachmentAccessor<APosition>& aaPos);
 
//  CalculateTetrahedronVolToRMSFaceAreaRatio - sgrein
UG_API
number CalculateHexahedronVolToRMSFaceAreaRatio(Grid& grid,
                          Hexahedron* hex,
                        Grid::VertexAttachmentAccessor<APosition>& aaPos);
 
 
 
 
//  PointIsInsideTetrahedron - sreiter
UG_API 
inline bool
PointIsInsideTetrahedron(const vector3& v, Tetrahedron* tet,
             Grid::VertexAttachmentAccessor<APosition>& aaPos);
 
 
 
size_t IntersectPlaneWithTetrahedron
(
  vector3 intsOut[4], 
  const vector3& planePoint, 
  const vector3& planeNormal, 
  const vector3 t[4] 
);
 
 
template <class TAAPos>
UG_API bool
ContainsPoint(Volume* vol, const vector3& p, TAAPos aaPos);
 
 
template<class TVertexPositionAttachmentAccessor>
UG_API 
typename TVertexPositionAttachmentAccessor::ValueType
CalculateCenter(const VolumeVertices* vol, TVertexPositionAttachmentAccessor& aaPosVRT);
 
 
template<class TAAPosVRT, class TAAWeightVRT>
UG_API
typename TAAPosVRT::ValueType
CalculateCenter(const VolumeVertices* vol, TAAPosVRT& aaPos, TAAWeightVRT& aaWeight);
 
 
 
void InsertCenterVertex(Grid& g, Volume* vol, Vertex* vrt, bool eraseOldVol);
 
 
template <class TVolIter>
void ConvertToTetrahedra (
    Grid& grid,
    TVolIter volsBegin,
    TVolIter volsEnd);
 
}// end of namespace
 
//  include implementation
#include "volume_util_impl.hpp"
 
#endif