ug.h

Go to the documentation of this file.

/*
 * Copyright (c) 2010-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__UG__
#define __H__UG__UG__
 
#include <string>
 
#include "common/profiler/profiler.h"
#include "common/ug_config.h"
 
namespace ug
{
 
//  INFORMATION ON UG
 
UG_API std::string UGGetVersionString();
 
 
//  INITIALISATION AND FINALISATION
 
UG_API int UGInit(int *argcp, char ***argvp, int parallelOutputProcRank = -1);
 
 
UG_API bool InitPaths(const char* argv0);
 
 
UG_API void SetRootPath(const std::string& strRoot);
UG_API void SetRootPath(const char* c_strRoot);
 
UG_API void SetScriptPath(const std::string& strScript);
UG_API void SetScriptPath(const char* c_strScript);
 
UG_API void SetAppsPath(const std::string& strApps);
UG_API void SetAppsPath(const char* c_strApps);
 
UG_API void SetPluginPath(const std::string& strPlugin);
UG_API void SetPluginPath(const char* c_strPlugin);
 
 
UG_API int UGFinalize();
 
 
UG_API void UGForceExit();
 
UG_API void UGOutputProfileStatsOnExit(bool bEnable);
 
UG_API bool UGInitPlugins();
 
UG_API void AbortRun();
UG_API void ClearAbortRunFlag();
UG_API void TerminateAbortedRun();
 
}// end of namespace
 
#endif