ug4
normal_calculation.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2014-2015: G-CSC, Goethe University Frankfurt
3  * Author: Sebastian Reiter
4  *
5  * This file is part of UG4.
6  *
7  * UG4 is free software: you can redistribute it and/or modify it under the
8  * terms of the GNU Lesser General Public License version 3 (as published by the
9  * Free Software Foundation) with the following additional attribution
10  * requirements (according to LGPL/GPL v3 §7):
11  *
12  * (1) The following notice must be displayed in the Appropriate Legal Notices
13  * of covered and combined works: "Based on UG4 (www.ug4.org/license)".
14  *
15  * (2) The following notice must be displayed at a prominent place in the
16  * terminal output of covered works: "Based on UG4 (www.ug4.org/license)".
17  *
18  * (3) The following bibliography is recommended for citation and must be
19  * preserved in all covered files:
20  * "Reiter, S., Vogel, A., Heppner, I., Rupp, M., and Wittum, G. A massively
21  * parallel geometric multigrid solver on hierarchically distributed grids.
22  * Computing and visualization in science 16, 4 (2013), 151-164"
23  * "Vogel, A., Reiter, S., Rupp, M., Nägel, A., and Wittum, G. UG4 -- a novel
24  * flexible software system for simulating pde based models on high performance
25  * computers. Computing and visualization in science 16, 4 (2013), 165-179"
26  *
27  * This program is distributed in the hope that it will be useful,
28  * but WITHOUT ANY WARRANTY; without even the implied warranty of
29  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
30  * GNU Lesser General Public License for more details.
31  */
32 
33 #ifndef __H__UG_NORMAL_CALCULATION__
34 #define __H__UG_NORMAL_CALCULATION__
35 
36 namespace ug{
37 
48 
49 template <class TAAPos>
50 inline typename TAAPos::ValueType
51 CalculateOuterNormal(Vertex* v, int sideIndex, TAAPos aaPos);
52 
53 template <class TAAPos>
54 inline typename TAAPos::ValueType
55 CalculateOuterNormal(Edge* v, int sideIndex, TAAPos aaPos);
56 
57 template <class TAAPos>
58 inline typename TAAPos::ValueType
59 CalculateOuterNormal(Face* v, int sideIndex, TAAPos aaPos);
60 
61 template <class TAAPos>
62 inline typename TAAPos::ValueType
63 CalculateOuterNormal(Volume* v, int sideIndex, TAAPos aaPos);
64 
65 template <class TAAPos>
66 inline typename TAAPos::ValueType
67 CalculateOuterNormal(GridObject* v, int sideIndex, TAAPos aaPos);
68 
72 inline vector2
73 CalculateNormal(EdgeVertices* edge,
74  Grid::AttachmentAccessor<Vertex, APosition2>& aaPos);
75 
76 inline vector3
77 CalculateNormal(FaceVertices* face,
78  Grid::AttachmentAccessor<Vertex, APosition>& aaPos);
79  // end of docu-group normal_calculation
81 }// end of namespace
82 
83 
85 // include implementation
86 #include "normal_calculation_impl.h"
87 
88 #endif
ug::EdgeVertices
holds the vertices of an Edge or an EdgeDescriptor.
Definition: grid_base_objects.h:362
ug::FaceVertices
Definition: grid_base_objects.h:483
ug::Grid::AttachmentAccessor
the generic attachment-accessor for access to grids attachment pipes.
Definition: grid.h:182
ug::CalculateNormal
int CalculateNormal(vector3 &vNormOut, Grid &grid, Edge *e, Grid::AttachmentAccessor< Vertex, APosition > &aaPos, Grid::AttachmentAccessor< Face, ANormal > *paaNormFACE)
Calculates the normal of the given edge.
Definition: edge_util.cpp:314
ug::CalculateOuterNormal
TAAPos::ValueType CalculateOuterNormal(Vertex *v, int sideIndex, TAAPos aaPos)
Calculates the outer normal of the i-th side of the given grid object.
Definition: normal_calculation_impl.h:44
ug::vector2
MathVector< 2, number > vector2
a 2d vector
Definition: ugmath_types.h:69
ug
the ug namespace
normal_calculation_impl.h