/*
 * Copyright (c) 2014-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__UG_problem_detection_util
#define __H__UG_problem_detection_util

#include <vector>
#include "common/math/ugmath_types.h"

namespace ug{
class Grid;

/**	Checks for all edges of the given tetrahedron whether the distance to the
 *	opposite edge is smaller than the given ratio of the length of the
 * longest edge in the element.
 * \returns	integer to the first edge which is closer to its opposed edge
 *			than the given threshold allows. -1 if no such edge exists.
 *			Use tet_rules::OPPOSED_EDGE to retrieve the associated opposed edge.*/
UG_API int IsSliver(const vector3& v0, const vector3& v1, const vector3& v2,
			  		 const vector3& v3, number thresholdRatio);

///	Searchs for slivers in the given list of elements.
/**	Slivers are flat tetrahedrons. Only tetrahedral elements will be regarded!*/
template <class TIter, class TAAPos>
size_t FindSlivers(std::vector<typename TIter::value_type>& sliversOut,
				 TIter elemsBegin, TIter elemsEnd, number thresholdRatio,
				 TAAPos aaPos, bool clearContainer = true);

///	Logs all unconnected sides to UG_ERR_LOG and returns true if an unconnected side was found
bool CheckForUnconnectedSides(Grid& grid);

}//	end of namespace

////////////////////////////////////////
//	include implementation
#include "problem_detection_util_impl.h"

#endif	//__H__problem_detection_util
