File options_netcdf.cxx#

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.

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

Functions

std::string getRestartDirectoryName(Options &options)#: Name of the directory for restart files.

std::string getRestartFilename(Options &options)#: Name of the restart file on this rank.

std::string getRestartFilename(Options &options, int rank)#: Name of the restart file on rank.

std::string getOutputFilename(Options &options)#: Name of the main output file on this rank.

std::string getOutputFilename(Options &options, int rank)#: Name of the main output file on rank.

void writeDefaultOutputFile()#: Write Options::root() to the main output file, overwriting any existing files

void writeDefaultOutputFile(Options &options)#: Write options to the main output file, overwriting any existing files