Chaste  Release::2018.1
ExecutableSupport.hpp
1 /*
2 
3 Copyright (c) 2005-2018, University of Oxford.
4 All rights reserved.
5 
6 University of Oxford means the Chancellor, Masters and Scholars of the
7 University of Oxford, having an administrative office at Wellington
8 Square, Oxford OX1 2JD, UK.
9 
10 This file is part of Chaste.
11 
12 Redistribution and use in source and binary forms, with or without
13 modification, are permitted provided that the following conditions are met:
14  * Redistributions of source code must retain the above copyright notice,
15  this list of conditions and the following disclaimer.
16  * Redistributions in binary form must reproduce the above copyright notice,
17  this list of conditions and the following disclaimer in the documentation
18  and/or other materials provided with the distribution.
19  * Neither the name of the University of Oxford nor the names of its
20  contributors may be used to endorse or promote products derived from this
21  software without specific prior written permission.
22 
23 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
24 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
27 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
29 GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32 OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 
34 */
35 
36 #ifndef EXECUTABLESUPPORT_HPP_
37 #define EXECUTABLESUPPORT_HPP_
38 
39 #include <string>
40 #include "FileFinder.hpp"
41 #include "OutputFileHandler.hpp" // For out_stream
42 
52 {
53 public:
60  static void InitializePetsc(int* pArgc, char*** pArgv);
61 
65  static void ShowCopyright();
66 
70  static void ShowParallelLaunching();
71 
79  static void SetOutputDirectory(const std::string& rOutputDirectory);
80 
87  static void WriteMachineInfoFile(std::string fileBaseName);
88 
93  static void WriteProvenanceInfoFile();
94 
100  static void GetBuildInfo(std::string& rInfo);
101 
108  static void StandardStartup(int* pArgc, char*** pArgv);
109 
116  static void StartupWithoutShowingCopyright(int* pArgc, char*** pArgv);
117 
124  static void PrintError(const std::string& rMessage, bool masterOnly=false);
125 
131  static void Print(const std::string& rMessage);
132 
136  static void FinalizePetsc();
137 
142  static const int EXIT_OK = 0;
143 
148  static const int EXIT_ERROR = 1;
149 
154  static const int EXIT_BAD_ARGUMENTS = 2;
155 
156 private:
159 };
160 
161 #endif /* EXECUTABLESUPPORT_HPP_ */
static void FinalizePetsc()
static const int EXIT_ERROR
static void Print(const std::string &rMessage)
static void ShowParallelLaunching()
static void WriteProvenanceInfoFile()
static const int EXIT_BAD_ARGUMENTS
static const int EXIT_OK
static void PrintError(const std::string &rMessage, bool masterOnly=false)
static void StandardStartup(int *pArgc, char ***pArgv)
static FileFinder mOutputDirectory
static void InitializePetsc(int *pArgc, char ***pArgv)
static void GetBuildInfo(std::string &rInfo)
static void StartupWithoutShowingCopyright(int *pArgc, char ***pArgv)
static void ShowCopyright()
static void WriteMachineInfoFile(std::string fileBaseName)
static void SetOutputDirectory(const std::string &rOutputDirectory)