From 8a34000d767cdee9e258c19d7b10aef3ac37761b Mon Sep 17 00:00:00 2001
From: Armin Leonhard Roediger <b159cb14@fritz4.nhr.fau.de>
Date: Thu, 12 Jun 2025 14:43:12 +0200
Subject: [PATCH] Renamed write_slab to write_rslab. And added clarifying
 comment for this method.

---
 cpp/field.hpp    | 2 +-
 cpp/field_io.cpp | 6 +++++-
 2 files changed, 6 insertions(+), 2 deletions(-)

diff --git a/cpp/field.hpp b/cpp/field.hpp
index 41e7de7c..518cbfeb 100644
--- a/cpp/field.hpp
+++ b/cpp/field.hpp
@@ -89,7 +89,7 @@ class field
                 const std::string field_name,
                 const int iteration,
                 const bool read = true);
-        int write_slab(
+        int write_rslab(
                 const std::string fname,
                 const std::string field_name,
                 const int iteration,
diff --git a/cpp/field_io.cpp b/cpp/field_io.cpp
index 3804b16f..875e1cc6 100644
--- a/cpp/field_io.cpp
+++ b/cpp/field_io.cpp
@@ -345,10 +345,14 @@ int field<rnumber, be, fc>::io(
     return EXIT_SUCCESS;
 }
 
+ /** Writes a slab of a real field to a file. The slab starts at index 0 
+  * and ends at thickness in the lowest dimension (z-direction). 
+  * All other dimensions are kept untouched.
+ */
 template <typename rnumber,
           field_backend be,
           field_components fc>
-int field<rnumber, be, fc>::write_slab(
+int field<rnumber, be, fc>::write_rslab(
         const std::string fname,
         const std::string field_name,
         const int iteration,
-- 
GitLab