boutpp-nightly 5.2.1.dev551__tar.gz → 5.2.1.dev574__tar.gz

{boutpp_nightly-5.2.1.dev551 → boutpp_nightly-5.2.1.dev574}/.git-blame-ignore-revs

@@ -14,3 +14,4 @@ c8f38049359170a34c915e209276238ea66b9a1e
 8d5cb39e03c2644715a50684f8cd0318b4e82676
 ec69e8838be2dde140a915e50506f8e1ce3cb534
 f2bc0488a298f136294c523bc5ab4086d090059b
+1b4707187a3a85126338303dc766280b8fb2dc56

{boutpp_nightly-5.2.1.dev551 → boutpp_nightly-5.2.1.dev574}/.github/workflows/tests.yml

@@ -216,39 +216,3 @@ jobs:
         shell: bash
         env:
           TRAVIS_BUILD_DIR: ${{ github.workspace }}
-  CUDA:
-    timeout-minutes: 60
-    runs-on: ubuntu-latest
-    container: ghcr.io/ggeorgakoudis/boutdev-cuda:latest
-    env:
-      BOUT_TEST_DOWNLOAD_FLAGS: --retry-on-http-error=502,503,504 --tries 3
-    steps:
-      - uses: actions/checkout@v6
-        with:
-          submodules: true
-
-      - name: Cache Zenodo test data
-        uses: actions/cache@v5
-        with:
-          path: build/tests/integrated/test-fci-mpi/grid.fci.nc
-          # If we update the test, invalidate the cache
-          key: zenodo-data-${{ hashFiles('tests/integrated/test-fci-mpi/CMakeLists.txt') }}
-
-      - name: Build minimal CUDA 12.2 @ GCC9.4.0 @ Ubuntu 20.04
-        run: |
-          . /spack/share/spack/setup-env.sh
-          spack env activate -p /spack-env
-          git config --global --add safe.directory $GITHUB_WORKSPACE
-          rm -rf build
-          cmake -S $GITHUB_WORKSPACE -B build \
-            -DCMAKE_C_COMPILER=gcc \
-            -DCMAKE_CXX_COMPILER=g++ \
-            -DBOUT_ENABLE_RAJA=on \
-            -DBOUT_ENABLE_UMPIRE=on \
-            -DBOUT_ENABLE_CUDA=on \
-            -DCMAKE_CUDA_ARCHITECTURES=80 \
-            -DCUDA_ARCH=compute_80,code=sm_80 \
-            -DBOUT_ENABLE_WARNINGS=off \
-            -DBOUT_USE_SYSTEM_FMT=on
-          cd build
-          make -j 4

{boutpp_nightly-5.2.1.dev551 → boutpp_nightly-5.2.1.dev574}/CMakeLists.txt

@@ -525,10 +525,10 @@ set_target_properties(
 set(CONFIG_LDFLAGS "${CONFIG_LDFLAGS} -L\$BOUT_LIB_PATH -lbout++")
 set(BOUT_INCLUDE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/include")
 set(CONFIG_CFLAGS
-    "${CONFIG_CFLAGS} -I\${BOUT_INCLUDE_PATH} -I${CMAKE_CURRENT_BINARY_DIR}/include ${CMAKE_CXX_FLAGS} -std=c++17"
+    "${CONFIG_CFLAGS} -I\${BOUT_INCLUDE_PATH} -I${CMAKE_CURRENT_BINARY_DIR}/include ${CMAKE_CXX_FLAGS} -std=c++20"
 )
 
-target_compile_features(bout++ PUBLIC cxx_std_17)
+target_compile_features(bout++ PUBLIC cxx_std_20)
 set_target_properties(bout++ PROPERTIES CXX_EXTENSIONS OFF)
 
 # Optional compiler features

{boutpp_nightly-5.2.1.dev551 → boutpp_nightly-5.2.1.dev574}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: boutpp-nightly
-Version: 5.2.1.dev551
+Version: 5.2.1.dev574
 License: 		   GNU LESSER GENERAL PUBLIC LICENSE
                                 Version 3, 29 June 2007
          

boutpp_nightly-5.2.1.dev574/_version.txt

@@ -0,0 +1 @@
+v5.2.1.dev574

{boutpp_nightly-5.2.1.dev551 → boutpp_nightly-5.2.1.dev574}/include/bout/boutexception.hxx

@@ -5,6 +5,7 @@
 #include <string>
 #include <utility>
 
+#include "fmt/base.h"
 #include "fmt/core.h"
 
 /// Throw BoutRhsFail with \p message if any one process has non-zero
@@ -19,10 +20,10 @@ public:
   BoutException& operator=(BoutException&&) = delete;
   BoutException(std::string msg);
 
-  template <class S, class... Args>
-  BoutException(S&& format, Args&&... args)
-      : BoutException(fmt::format(std::forward<S>(format),
-                                  std::forward<decltype(args)>(args)...)) {}
+  template <class... Args>
+  // NOLINTNEXTLINE(cppcoreguidelines-missing-std-forward)
+  BoutException(fmt::format_string<Args...> format, Args&&... args)
+      : BoutException(fmt::vformat(format, fmt::make_format_args(args...))) {}
 
   ~BoutException() override;
 
@@ -44,19 +45,19 @@ private:
 class BoutRhsFail : public BoutException {
 public:
   BoutRhsFail(std::string message) : BoutException(std::move(message)) {}
-  template <class S, class... Args>
-  BoutRhsFail(S&& format, Args&&... args)
-      : BoutRhsFail(fmt::format(std::forward<S>(format),
-                                std::forward<decltype(args)>(args)...)) {}
+  template <class... Args>
+  // NOLINTNEXTLINE(cppcoreguidelines-missing-std-forward)
+  BoutRhsFail(fmt::format_string<Args...> format, Args&&... args)
+      : BoutRhsFail(fmt::vformat(format, fmt::make_format_args(args...))) {}
 };
 
 class BoutIterationFail : public BoutException {
 public:
   BoutIterationFail(std::string message) : BoutException(std::move(message)) {}
-  template <class S, class... Args>
-  BoutIterationFail(S&& format, Args&&... args)
-      : BoutIterationFail(fmt::format(std::forward<S>(format),
-                                      std::forward<decltype(args)>(args)...)) {}
+  template <class... Args>
+  // NOLINTNEXTLINE(cppcoreguidelines-missing-std-forward)
+  BoutIterationFail(fmt::format_string<Args...> format, Args&&... args)
+      : BoutIterationFail(fmt::vformat(format, fmt::make_format_args(args...))) {}
 };
 
 #endif

{boutpp_nightly-5.2.1.dev551 → boutpp_nightly-5.2.1.dev574}/include/bout/msg_stack.hxx

@@ -31,6 +31,7 @@ class MsgStack;
 
 #include "bout/build_defines.hxx"
 
+#include "fmt/base.h"
 #include "fmt/core.h"
 
 #include <cstddef>
@@ -60,9 +61,10 @@ public:
   int push(std::string message);
   int push() { return push(""); }
 
-  template <class S, class... Args>
-  int push(const S& format, const Args&... args) {
-    return push(fmt::format(format, args...));
+  template <class... Args>
+  // NOLINTNEXTLINE(cppcoreguidelines-missing-std-forward)
+  int push(fmt::format_string<Args...> format, Args&&... args) {
+    return push(fmt::vformat(format, fmt::make_format_args(args...)));
   }
 
   void pop();       ///< Remove the last message
@@ -74,8 +76,8 @@ public:
 #else
   /// Dummy functions which should be optimised out
   int push(const std::string&) { return 0; }
-  template <class S, class... Args>
-  int push(const S&, const Args&...) {
+  template <class... Args>
+  int push(fmt::format_string<Args...> format, const Args&... args) {
     return 0;
   }
 
@@ -132,10 +134,13 @@ public:
   MsgStackItem(const std::string& file, int line, const char* msg)
       : point(msg_stack.push("{:s} on line {:d} of '{:s}'", msg, line, file)) {}
 
-  template <class S, class... Args>
-  MsgStackItem(const std::string& file, int line, const S& msg, const Args&... args)
-      : point(msg_stack.push("{:s} on line {:d} of '{:s}'", fmt::format(msg, args...),
-                             line, file)) {}
+  template <class... Args>
+  // NOLINTNEXTLINE(cppcoreguidelines-missing-std-forward)
+  MsgStackItem(const std::string& file, int line, fmt::format_string<Args...> msg,
+               Args&&... args)
+      : point(msg_stack.push("{:s} on line {:d} of '{:s}'",
+                             fmt::vformat(msg, fmt::make_format_args(args...)), line,
+                             file)) {}
   ~MsgStackItem() {
     // If an exception has occurred, don't pop the message
     if (exception_count == std::uncaught_exceptions()) {

{boutpp_nightly-5.2.1.dev551 → boutpp_nightly-5.2.1.dev574}/include/bout/options.hxx

@@ -52,6 +52,7 @@ class Options;
 #include "bout/utils.hxx"
 
 #include <fmt/core.h>
+#include <fmt/format.h>
 
 #include <cmath>
 #include <functional>
@@ -626,8 +627,8 @@ public:
       // Option not found. Copy the value from the default.
       this->_set_no_check(def.value, DEFAULT_SOURCE);
 
-      output_info << _("\tOption ") << full_name << " = " << def.full_name << " ("
-                  << DEFAULT_SOURCE << ")\n";
+      output_info.write("{}{} = {}({})\n", _("\tOption "), full_name, def.full_name,
+                        DEFAULT_SOURCE);
     } else {
       // Check if this was previously set as a default option
       if (bout::utils::variantEqualTo(attributes.at("source"), DEFAULT_SOURCE)) {
@@ -911,8 +912,8 @@ private:
                       << ")\n";
         } else {
           throw BoutException(
-              _("Options: Setting a value from same source ({:s}) to new value "
-                "'{:s}' - old value was '{:s}'."),
+              _f("Options: Setting a value from same source ({:s}) to new value "
+                 "'{:s}' - old value was '{:s}'."),
               source, toString(val), bout::utils::variantToString(value));
         }
       }
@@ -1046,7 +1047,40 @@ namespace details {
 /// so that we can put the function definitions in the .cxx file,
 /// avoiding lengthy recompilation if we change it
 struct OptionsFormatterBase {
-  auto parse(fmt::format_parse_context& ctx) -> fmt::format_parse_context::iterator;
+  constexpr auto parse(fmt::format_parse_context& ctx) {
+    const auto* it = ctx.begin();
+    const auto* const end = ctx.end();
+
+    while (it != end and *it != '}') {
+      switch (*it) {
+      case 'd':
+        docstrings = true;
+        ++it;
+        break;
+      case 'i':
+        inline_section_names = true;
+        ++it;
+        break;
+      case 'k':
+        key_only = true;
+        ++it;
+        break;
+      case 's':
+        source = true;
+        ++it;
+        break;
+      case 'u':
+        unused = true;
+        ++it;
+        break;
+      default:
+        throw fmt::format_error("invalid format for 'Options'");
+      }
+    }
+
+    return it;
+  }
+
   auto format(const Options& options, fmt::format_context& ctx) const
       -> fmt::format_context::iterator;
 
@@ -1063,8 +1097,6 @@ private:
   bool key_only{false};
   /// Include the 'source' attribute, if present
   bool source{false};
-  /// Format string to passed down to subsections
-  std::string format_string;
 };
 } // namespace details
 } // namespace bout

{boutpp_nightly-5.2.1.dev551 → boutpp_nightly-5.2.1.dev574}/include/bout/options_io.hxx

@@ -1,3 +1,19 @@
+#pragma once
+
+#ifndef OPTIONS_IO_H
+#define OPTIONS_IO_H
+
+#include "bout/build_defines.hxx"
+#include "bout/generic_factory.hxx"
+#include "bout/options.hxx"
+
+#include <memory>
+#include <string>
+
+class Mesh;
+
+namespace bout {
+
 /// Parent class for IO to binary files and streams
 ///
 ///
@@ -36,22 +52,6 @@
 ///
 ///    if mesh is omitted, no grid information is added.
 ///
-
-#pragma once
-
-#ifndef OPTIONS_IO_H
-#define OPTIONS_IO_H
-
-#include "bout/build_defines.hxx"
-#include "bout/generic_factory.hxx"
-#include "bout/mesh.hxx"
-#include "bout/options.hxx"
-
-#include <memory>
-#include <string>
-
-namespace bout {
-
 class OptionsIO {
 public:
   /// No default constructor, as settings are required
@@ -59,7 +59,7 @@ public:
 
   /// Constructor specifies the kind of file, and options to control
   /// the name of file, mode of operation etc.
-  OptionsIO(Options&) {}
+  OptionsIO(Options& /*unused*/) {}
 
   virtual ~OptionsIO() = default;
 
@@ -81,6 +81,9 @@ public:
   /// ADIOS: Indicate completion of an output step.
   virtual void verifyTimesteps() const = 0;
 
+  /// NetCDF: Flush file to disk
+  virtual void flush() {}
+
   /// Create an OptionsIO for I/O to the given file.
   /// This uses the default file type and default options.
   static std::unique_ptr<OptionsIO> create(const std::string& file);

{boutpp_nightly-5.2.1.dev551 → boutpp_nightly-5.2.1.dev574}/include/bout/optionsreader.hxx

@@ -36,7 +36,8 @@ class OptionsReader;
 
 #include "bout/options.hxx"
 
-#include "fmt/core.h"
+#include <fmt/base.h>
+#include <fmt/core.h>
 
 #include <string>
 #include <vector>
@@ -69,9 +70,10 @@ public:
   /// @param[in] file  The name of the file. printf style arguments can be used to create the file name.
   void read(Options* options, const std::string& filename);
 
-  template <class S, class... Args>
-  void read(Options* options, const S& format, const Args&... args) {
-    return read(options, fmt::format(format, args...));
+  template <class... Args>
+  // NOLINTNEXTLINE(cppcoreguidelines-missing-std-forward)
+  void read(Options* options, fmt::format_string<Args...> format, Args&&... args) {
+    return read(options, fmt::vformat(format, fmt::make_format_args(args...)));
   }
 
   /// Write options to file
@@ -80,9 +82,10 @@ public:
   /// @param[in] file   The name of the file to (over)write
   void write(Options* options, const std::string& filename);
 
-  template <class S, class... Args>
-  void write(Options* options, const S& format, const Args&... args) {
-    return write(options, fmt::format(format, args...));
+  template <class... Args>
+  // NOLINTNEXTLINE(cppcoreguidelines-missing-std-forward)
+  void write(Options* options, fmt::format_string<Args...> format, Args&&... args) {
+    return write(options, fmt::vformat(format, fmt::make_format_args(args...)));
   }
 
   /// Parse options from the command line

{boutpp_nightly-5.2.1.dev551 → boutpp_nightly-5.2.1.dev574}/include/bout/output.hxx

@@ -39,7 +39,8 @@ class Output;
 #include "bout/sys/gettext.hxx" // IWYU pragma: keep for gettext _() macro
 #include "bout/unused.hxx"
 
-#include "fmt/core.h"
+#include <fmt/base.h>
+#include <fmt/core.h>
 
 #include <utility>
 
@@ -81,9 +82,10 @@ public:
     open(filename);
   }
 
-  template <class S, class... Args>
-  Output(const S& format, Args&&... args)
-      : Output(fmt::format(format, std::forward<decltype(args)>(args)...)) {}
+  template <class... Args>
+  // NOLINTNEXTLINE(cppcoreguidelines-missing-std-forward)
+  Output(fmt::format_string<Args...> format, Args&&... args)
+      : Output(fmt::vformat(format, fmt::make_format_args(args...))) {}
 
   ~Output() override { close(); }
 
@@ -93,9 +95,10 @@ public:
   /// Open an output log file
   int open(const std::string& filename);
 
-  template <class S, class... Args>
-  int open(const S& format, Args&&... args) {
-    return open(fmt::format(format, std::forward<decltype(args)>(args)...));
+  template <class... Args>
+  // NOLINTNEXTLINE(cppcoreguidelines-missing-std-forward)
+  int open(fmt::format_string<Args...> format, Args&&... args) {
+    return open(fmt::vformat(format, fmt::make_format_args(args...)));
   }
 
   /// Close the log file
@@ -104,16 +107,18 @@ public:
   /// Write a string using fmt format
   virtual void write(const std::string& message);
 
-  template <class S, class... Args>
-  void write(const S& format, Args&&... args) {
-    write(fmt::format(format, std::forward<decltype(args)>(args)...));
+  template <class... Args>
+  // NOLINTNEXTLINE(cppcoreguidelines-missing-std-forward)
+  void write(fmt::format_string<Args...> format, Args&&... args) {
+    write(fmt::vformat(format, fmt::make_format_args(args...)));
   }
   /// Same as write, but only to screen
   virtual void print(const std::string& message);
 
-  template <class S, class... Args>
-  void print(const S& format, Args&&... args) {
-    print(fmt::format(format, std::forward<decltype(args)>(args)...));
+  template <class... Args>
+  // NOLINTNEXTLINE(cppcoreguidelines-missing-std-forward)
+  void print(fmt::format_string<Args...> format, Args&&... args) {
+    print(fmt::vformat(format, fmt::make_format_args(args...)));
   }
 
   /// Add an output stream. All output will be sent to all streams
@@ -174,11 +179,12 @@ public:
   /// This string is then sent to log file and stdout (on processor 0)
   void write(const std::string& message) override;
 
-  template <class S, class... Args>
-  void write(const S& format, Args&&... args) {
+  template <class... Args>
+  // NOLINTNEXTLINE(cppcoreguidelines-missing-std-forward)
+  void write(fmt::format_string<Args...> format, Args&&... args) {
     if (enabled) {
       ASSERT1(base != nullptr);
-      base->write(fmt::format(format, std::forward<decltype(args)>(args)...));
+      base->write(fmt::vformat(format, fmt::make_format_args(args...)));
     }
   }
 
@@ -186,11 +192,12 @@ public:
   /// note: unlike write, this is not also sent to log files
   void print(const std::string& message) override;
 
-  template <class S, class... Args>
-  void print(const S& format, Args&&... args) {
+  template <class... Args>
+  // NOLINTNEXTLINE(cppcoreguidelines-missing-std-forward)
+  void print(fmt::format_string<Args...> format, Args&&... args) {
     if (enabled) {
       ASSERT1(base != nullptr);
-      base->print(fmt::format(format, std::forward<decltype(args)>(args)...));
+      base->print(fmt::vformat(format, fmt::make_format_args(args...)));
     }
   }
 

{boutpp_nightly-5.2.1.dev551 → boutpp_nightly-5.2.1.dev574}/include/bout/physicsmodel.hxx

@@ -48,6 +48,7 @@ class PhysicsModel;
 #include "bout/utils.hxx"
 
 #include <chrono>
+#include <cstddef>
 #include <thread>
 #include <type_traits>
 #include <vector>
@@ -378,6 +379,9 @@ protected:
     PhysicsModel* model;
   };
 
+  /// Set timestep counter for flushing file
+  void setFlushCounter(std::size_t iteration) { flush_counter = iteration; }
+
 private:
   /// State for outputs
   Options output_options;
@@ -401,6 +405,10 @@ private:
   bool initialised{false};
   /// write restarts and pass outputMonitor method inside a Monitor subclass
   PhysicsModelMonitor modelMonitor{this};
+  /// How often to flush to disk
+  std::size_t flush_frequency{1};
+  /// Current timestep counter
+  std::size_t flush_counter{0};
 };
 
 /*!

{boutpp_nightly-5.2.1.dev551 → boutpp_nightly-5.2.1.dev574}/include/bout/region.hxx

@@ -972,6 +972,12 @@ Region<T> operator+(const Region<T>& lhs, const Region<T>& rhs) {
   return Region<T>(indices);
 }
 
+template <typename T>
+Region<T> operator+(Region<T>&& lhs, const Region<T>& rhs) {
+  lhs += rhs;
+  return std::move(lhs);
+}
+
 /// Returns a new region based on input but with indices offset by
 /// a constant
 template <typename T>

{boutpp_nightly-5.2.1.dev551 → boutpp_nightly-5.2.1.dev574}/include/bout/sys/expressionparser.hxx

@@ -29,7 +29,8 @@
 
 #include "bout/unused.hxx"
 
-#include "fmt/core.h"
+#include <fmt/base.h>
+#include <fmt/core.h>
 
 #include <exception>
 #include <list>
@@ -239,11 +240,16 @@ private:
 
 class ParseException : public std::exception {
 public:
+  ParseException(const ParseException&) = default;
+  ParseException(ParseException&&) = delete;
+  ParseException& operator=(const ParseException&) = default;
+  ParseException& operator=(ParseException&&) = delete;
   ParseException(const std::string& message_) : message(message_) {}
 
-  template <class S, class... Args>
-  ParseException(const S& format, const Args&... args)
-      : message(fmt::format(format, args...)) {}
+  template <class... Args>
+  // NOLINTNEXTLINE(cppcoreguidelines-missing-std-forward)
+  ParseException(fmt::format_string<Args...> format, Args&&... args)
+      : message(fmt::vformat(format, fmt::make_format_args(args...))) {}
 
   ~ParseException() override = default;
 

boutpp_nightly-5.2.1.dev574/include/bout/sys/gettext.hxx

@@ -0,0 +1,54 @@
+/// Support for i18n using GNU gettext
+
+#ifndef BOUT_GETTEXT_H
+#define BOUT_GETTEXT_H
+
+#include "bout/build_defines.hxx"
+
+#if BOUT_HAS_GETTEXT
+
+#include <clocale> // IWYU pragma: keep
+
+#include <libintl.h>
+
+#define GETTEXT_PACKAGE "libbout"
+
+// If we have C++23, we can get fmt to do compile-time checks of our format
+// strings, _and_ have gettext do runtime replacement
+#if __cpp_if_consteval >= 202106L
+constexpr const char* dgettext_wrap(const char* __domainname, const char* __msgid) __THROW
+    __attribute_format_arg__(2);
+
+constexpr const char* dgettext_wrap(const char* __domainname, const char* __msgid) {
+  if consteval {
+    return __msgid;
+  }
+  return dgettext(__domainname, __msgid);
+}
+
+/// Gettext i18n macro for text containing fmt format specifiers
+// NOLINTNEXTLINE(cppcoreguidelines-macro-usage)
+#define _f(string) dgettext_wrap(GETTEXT_PACKAGE, string)
+
+#else
+// We're pre-C++23, so all our i18n text must be fmt runtime formats
+#include "fmt/base.h" // IWYU pragma: keep
+
+/// Gettext i18n macro for text containing fmt format specifiers
+// NOLINTNEXTLINE(cppcoreguidelines-macro-usage)
+#define _f(string) fmt::runtime(dgettext(GETTEXT_PACKAGE, string))
+#endif
+
+/// Gettext i18n macro for plain text that doesn't need formatting
+// NOLINTNEXTLINE(cppcoreguidelines-macro-usage)
+#define _(string) dgettext(GETTEXT_PACKAGE, string)
+
+#else // BOUT_HAS_GETTEXT
+
+// NOLINTNEXTLINE(cppcoreguidelines-macro-usage)
+#define _f(string) string
+// NOLINTNEXTLINE(cppcoreguidelines-macro-usage)
+#define _(string) string
+
+#endif // BOUT_HAS_GETTEXT
+#endif // BOUT_GETTEXT_H

{boutpp_nightly-5.2.1.dev551 → boutpp_nightly-5.2.1.dev574}/include/bout/utils.hxx

@@ -186,6 +186,7 @@ typename std::vector<T, Alloc>::size_type erase_if(std::vector<T, Alloc>& c, Pre
   return r;
 }
 #else
+using std::erase;
 using std::erase_if;
 #endif
 } // namespace utils

{boutpp_nightly-5.2.1.dev551 → boutpp_nightly-5.2.1.dev574}/manual/sphinx/user_docs/bout_options.rst

@@ -554,42 +554,42 @@ may be useful anyway. See :ref:`sec-output` for more details.
 Input and Output
 ----------------
 
-The output (dump) files with time-history are controlled by settings
-in a section called “output”. Restart files contain a single
-time-slice, and are controlled by a section called “restart”. The
-options available are listed in table :numref:`tab-outputopts`.
+The output (dump) files with time-history are controlled by settings in a
+section called ``"output"``. Restart files contain a single time-slice, and are
+controlled by a section called ``"restart"``. The options available are listed
+in table :numref:`tab-outputopts`.
 
 .. _tab-outputopts:
 .. table:: Output file options
 	   
-   +-------------+----------------------------------------------------+--------------+
-   | Option      | Description                                        | Default      |
-   |             |                                                    | value        |
-   +-------------+----------------------------------------------------+--------------+
-   | enabled     | Writing is enabled                                 | true         |
-   +-------------+----------------------------------------------------+--------------+
-   | type        | File type e.g. "netcdf" or "adios"                 | "netcdf"     |
-   +-------------+----------------------------------------------------+--------------+
-   | prefix      | File name prefix                                   | "BOUT.dmp"   |
-   +-------------+----------------------------------------------------+--------------+
-   | path        | Directory to write the file into                   | ``datadir``  |
-   +-------------+----------------------------------------------------+--------------+
-   | floats      | Write floats rather than doubles                   | false        |
-   +-------------+----------------------------------------------------+--------------+
-   | flush       | Flush the file to disk after each write            | true         |
-   +-------------+----------------------------------------------------+--------------+
-   | guards      | Output guard cells                                 | true         |
-   +-------------+----------------------------------------------------+--------------+
-   | openclose   | Re-open the file for each write, and close after   | true         |
-   +-------------+----------------------------------------------------+--------------+
+   +----------------------+-----------------------------------------+----------------+
+   | Option               | Description                             | Default value  |
+   +======================+=========================================+================+
+   | ``append``           | Append to existing file if true,        | ``false``      |
+   |                      | otherwise overwrite                     |                |
+   +----------------------+-----------------------------------------+----------------+
+   | ``enabled``          | Writing is enabled                      | ``true``       |
+   +----------------------+-----------------------------------------+----------------+
+   | ``flush_frequency``  | How many output timesteps between       | ``1``          |
+   |                      | writing output to disk (NetCDF only)    |                |
+   +----------------------+-----------------------------------------+----------------+
+   | ``prefix``           | File name prefix                        | ``"BOUT.dmp"`` |
+   +----------------------+-----------------------------------------+----------------+
+   | ``path``             | Directory to write the file into        | ``datadir``    |
+   +----------------------+-----------------------------------------+----------------+
+   | ``type``             | File type, either ``"netcdf"`` or       | ``"netcdf"``   |
+   |                      | ``"adios"``                             |                |
+   +----------------------+-----------------------------------------+----------------+
 
 |
 
-**enabled** is useful mainly for doing performance or scaling tests, where you
-want to exclude I/O from the timings. **floats** can be used to reduce the size
-of the output files: files are stored as double by default, but setting
-**floats = true** changes the output to single-precision floats.
-
+- ``enabled`` is useful mainly for doing performance or scaling tests, where you
+  want to exclude I/O from the timings.
+- If you find that IO is taking more and more time as your simulation goes on,
+  try setting ``flush_frequency`` to a larger value such as ``10``. This can
+  workaround an issue with NetCDF where subsequent writes take longer and
+  longer. However, larger values risk losing more data in the event of a crash
+  or the simulation being killed early.
 
 Implementation
 --------------