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 #include <sys/utsname.h>
00035 
00044 class ExecutableSupport
00045 {
00046 public:
00053     static void InitializePetsc(int* pArgc, char*** pArgv);
00054 
00058     static void ShowCopyright();
00059 
00063     static void ShowParallelLaunching();
00064     
00072     static void SetOutputDirectory(const std::string& rOutputDirectory);
00073 
00080     static void WriteMachineInfoFile(std::string fileBaseName);
00081 
00086     static void WriteProvenanceInfoFile();
00087 
00094     static void WriteLibraryInfo( out_stream &outFile );
00095     
00102     static void StandardStartup(int* pArgc, char*** pArgv);
00103     
00110     static void PrintError(const std::string& rMessage, bool masterOnly=false);
00111 
00117     static void Print(const std::string& rMessage);
00118 
00122     static void FinalizePetsc();
00123     
00128     static const int EXIT_OK = 0;
00129     
00134     static const int EXIT_ERROR = 1;
00135     
00140     static const int EXIT_BAD_ARGUMENTS = 2;
00141 
00142 private:
00144     static std::string mOutputDirectory;
00145 };
00146 
00147 #endif /* EXECUTABLESUPPORT_HPP_ */

Generated on Mon Apr 18 11:35:28 2011 for Chaste by  doxygen 1.5.5