File bout++.cxx#
Defines
-
GLOBALORIGIN#
-
BOUT_NO_USING_NAMESPACE_BOUTGLOBALS#
-
BUILDFLAG1_(x)#
-
BUILDFLAG(x)#
-
INDIRECT1_BOUTMAIN(a)#
-
INDIRECT0_BOUTMAIN(...)#
-
STRINGIFY(a)#
Functions
-
void bout_signal_handler(int sig)#
Signal handler - handles all signals.
-
char get_spin()#
Produce a spinning bar character.
-
int BoutInitialise(int &argc, char **&argv)#
Initialise BOUT++
Inputs
The command-line arguments argc and argv are passed by reference, and pointers to these will be stored in various places in BOUT++.
Outputs
Any non-zero return value should halt the simulation. If the return value is less than zero, the exit status from BOUT++ is 0, otherwise it is the return value of BoutInitialise.
-
int BoutFinalise(bool write_settings)#
BOUT++ finalisation. This should be called at the end of the program.
Frees memory, flushes buffers, and closes files. If BOUT++ initialised MPI or external libraries, then these are also finalised.
If
write_settingsis true, output the settings, showing which options were used. This overwrites the file written during initialisation (BOUT.settings by default)
-
namespace bout
Provides access to the Hypre library, handling initialisation and finalisation.
Usage
#include <bout/hyprelib.hxx>
class MyClass { public:
private: HypreLib lib; };
This will then automatically initialise Hypre the first time an object is created, and finalise it when the last object is destroyed.
Copyright 2012 B.D.Dudson, S.Farley, M.V.Umansky, X.Q.Xu
Contact: Ben Dudson, bd512@york.ac.uk
This file is part of BOUT++.
BOUT++ is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
BOUT++ 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.
You should have received a copy of the GNU Lesser General Public License along with BOUT++. If not, see http://www.gnu.org/licenses/.
Information about the version of BOUT++
The build system will update this file on every commit, which may result in files that include it getting rebuilt. Therefore it should be included in as few places as possible
Information about the version of BOUT++
The build system will update this file at configure-time
SNB model
-
namespace experimental#
-
namespace experimental#