From 4086d084a11fc4072bef283a1d89c96a644cfbba Mon Sep 17 00:00:00 2001
From: Matthieu Schaller <schaller@strw.leidenuniv.nl>
Date: Thu, 27 Feb 2020 09:55:21 +0800
Subject: [PATCH] Updated the README for the new runtime options
---
README | 1 +
README.md | 2 ++
doc/RTD/source/CommandLineOptions/index.rst | 2 ++
examples/main.c | 4 ++--
4 files changed, 7 insertions(+), 2 deletions(-)
diff --git a/README b/README
index ccbb7cfeb1..75bb3b2552 100644
--- a/README
+++ b/README
@@ -43,6 +43,7 @@ Parameters:
--limiter Run with time-step limiter.
--sync Run with time-step synchronization
of particles hit by feedback events.
+ --logger Run with the particle logger.
Simulation meta-options:
diff --git a/README.md b/README.md
index c9b373be64..b09f3d2c84 100644
--- a/README.md
+++ b/README.md
@@ -94,6 +94,8 @@ Parameters:
--limiter Run with time-step limiter.
--sync Run with time-step synchronization
of particles hit by feedback events.
+ --logger Run with the particle logger.
+
Simulation meta-options:
--eagle Run with all the options needed for the
diff --git a/doc/RTD/source/CommandLineOptions/index.rst b/doc/RTD/source/CommandLineOptions/index.rst
index f7cadd1f3a..b9bec3f52f 100644
--- a/doc/RTD/source/CommandLineOptions/index.rst
+++ b/doc/RTD/source/CommandLineOptions/index.rst
@@ -40,6 +40,8 @@ can be found by typing ``./swift -h``:
--limiter Run with time-step limiter.
--sync Run with time-step synchronization
of particles hit by feedback events.
+ --logger Run with the particle logger.
+
Simulation meta-options:
--eagle Run with all the options needed for the
diff --git a/examples/main.c b/examples/main.c
index 5da86de221..7f1e9bb0f0 100644
--- a/examples/main.c
+++ b/examples/main.c
@@ -228,6 +228,8 @@ int main(int argc, char *argv[]) {
"Run with time-step synchronization of particles hit by "
"feedback events.",
NULL, 0, 0),
+ OPT_BOOLEAN(0, "logger", &with_logger, "Run with the particle logger.",
+ NULL, 0, 0),
OPT_GROUP(" Simulation meta-options:\n"),
OPT_BOOLEAN(
@@ -253,8 +255,6 @@ int main(int argc, char *argv[]) {
"Overwrite the CPU "
"frequency (Hz) to be used for time measurements.",
NULL, 0, 0),
- OPT_BOOLEAN(0, "logger", &with_logger, "Run with the particle logger.",
- NULL, 0, 0),
OPT_INTEGER('n', "steps", &nsteps,
"Execute a fixed number of time steps. When unset use the "
"time_end parameter to stop.",
--
GitLab