debug_util.h

Go to the documentation of this file.

/*
 * Copyright (c) 2011-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__LIB_GIRD__DEBUG_UTIL__
#define __H__UG__LIB_GIRD__DEBUG_UTIL__
 
#include "lib_grid/lg_base.h"
#include "lib_grid/tools/surface_view.h"
 
namespace ug
{
 
void PrintElementNumbers(const GridObjectCollection& goc);
 
void PrintGridElementNumbers(Grid& grid);
 
void PrintGridElementNumbers(MultiGrid& mg);
 
void PrintGridElementNumbers(GridSubsetHandler& sh);
 
 
void PrintAttachmentInfo(Grid& grid);
 
 
 
 
template <class TElem>
vector3 GetGridObjectCenter(Grid& g, TElem* elem);
inline vector3 GetGridObjectCenter(Grid& g, GridObject* elem);
template <class TElem, class TAValue>
void WriteDebugValuesToFile(const char* filename, Grid& grid,
              TAValue& aVal, bool levelWise);
 
 
 
template <class TElem>
int GetGridObjectIndex(Grid& g, TElem* elem);
 
 
void CheckMultiGridConsistency(MultiGrid& mg);
 
bool CheckHangingNodeConsistency(Grid& g);
 
 
bool CheckHangingNodeConsistency(MultiGrid& mg);
 
 
 
 
bool CheckDistributedObjectConstraintTypes(MultiGrid& mg);
 
 
bool CheckDistributedParentTypes(MultiGrid& mg);
 
 
 
bool CheckElementConsistency(MultiGrid& mg, Vertex* v);
bool CheckElementConsistency(MultiGrid& mg, Edge* e);
bool CheckElementConsistency(MultiGrid& mg, Face* f);
 
std::string ElementDebugInfo(const Grid& grid, GridObject* e);
//void CheckSurfaceViewConsistency(SurfaceView& sv);
 // end of doxygen defgroup command
}// end of namespace
 
//  include implementation
#include "debug_util_impl.hpp"
 
#endif