ExecutableSupport.hpp

00001 /*
00002 
00003 Copyright (C) University of Oxford, 2005-2011
00004 
00005 University of Oxford means the Chancellor, Masters and Scholars of the
00006 University of Oxford, having an administrative office at Wellington
00007 Square, Oxford OX1 2JD, UK.
00008 
00009 This file is part of Chaste.
00010 
00011 Chaste is free software: you can redistribute it and/or modify it
00012 under the terms of the GNU Lesser General Public License as published
00013 by the Free Software Foundation, either version 2.1 of the License, or
00014 (at your option) any later version.
00015 
00016 Chaste is distributed in the hope that it will be useful, but WITHOUT
00017 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
00019 License for more details. The offer of Chaste under the terms of the
00020 License is subject to the License being interpreted in accordance with
00021 English Law and subject to any action against the University of Oxford
00022 being under the jurisdiction of the English Courts.
00023 
00024 You should have received a copy of the GNU Lesser General Public License
00025 along with Chaste. If not, see <http://www.gnu.org/licenses/>.
00026 
00027 */
00028 
00029 #ifndef EXECUTABLESUPPORT_HPP_
00030 #define EXECUTABLESUPPORT_HPP_
00031 
00032 #include <string>
00033 #include "OutputFileHandler.hpp"
00034 
00043 class ExecutableSupport
00044 {
00045 public:
00052     static void InitializePetsc(int* pArgc, char*** pArgv);
00053 
00057     static void ShowCopyright();
00058 
00062     static void ShowParallelLaunching();
00063 
00071     static void SetOutputDirectory(const std::string& rOutputDirectory);
00072 
00079     static void WriteMachineInfoFile(std::string fileBaseName);
00080 
00085     static void WriteProvenanceInfoFile();
00086 
00093     static void WriteLibraryInfo( out_stream &outFile );
00094 
00101     static void StandardStartup(int* pArgc, char*** pArgv);
00102 
00109     static void PrintError(const std::string& rMessage, bool masterOnly=false);
00110 
00116     static void Print(const std::string& rMessage);
00117 
00121     static void FinalizePetsc();
00122 
00127     static const int EXIT_OK = 0;
00128 
00133     static const int EXIT_ERROR = 1;
00134 
00139     static const int EXIT_BAD_ARGUMENTS = 2;
00140 
00141 private:
00143     static std::string mOutputDirectory;
00144 };
00145 
00146 #endif /* EXECUTABLESUPPORT_HPP_ */

Generated on Tue May 31 14:31:41 2011 for Chaste by  doxygen 1.5.5