File options.cxx#

Functions

template<> std::string as<std::string>(const std::string &similar_to) const#: Specialised as routines.

std::string toString(const Options &value)#: Convert value to string.

Variables

constexpr auto conditionally_used_attribute = "conditionally used"#: Name of the attribute to indicate an Option should always count as having been used

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

void checkForUnusedOptions()#: Check if the global Options contains any unused keys and throw an exception if so. This check can be skipped by setting input:error_on_unused_options=false in the global Options.

void checkForUnusedOptions(const Options &options, const std::string &data_dir, const std::string &option_file)#

Check if the given options contains any unused keys and throw an exception if so.

The error message contains helpful suggestions on possible misspellings, and how to automatically fix most common errors with library options. The data_dir and option_file arguments are used to customise the error message for the actual input file used