From 0b39eaaa8e68cc9a134ad98e65aa9a3dd941e633 Mon Sep 17 00:00:00 2001
From: Stephane Del Pino <stephane.delpino44@gmail.com>
Date: Sun, 17 Jul 2022 22:31:13 +0200
Subject: [PATCH] Start writer module documentation
---
doc/userdoc.org | 13 +++++++++++++
1 file changed, 13 insertions(+)
diff --git a/doc/userdoc.org b/doc/userdoc.org
index a52f77264..a88ad5da0 100644
--- a/doc/userdoc.org
+++ b/doc/userdoc.org
@@ -4104,6 +4104,19 @@ Sets the preconditioner type.
Sets verbosity mode to ~true~ or ~false~ for linear solvers.
+*** The ~writer~ module
+
+This module provides functionalities to numerical results to files for
+post processing.
+
+It provides the following functions and types.
+#+NAME: get-module-info-writer
+#+BEGIN_SRC pugs :exports both :results output
+ cout << getModuleInfo("writer") << "\n";
+#+END_SRC
+#+RESULTS: get-module-info-writer
+
+
[fn:pugs-def] ~pugs~: Parallel Unstructured Grid Solvers
[fn:MPI-def] ~MPI~: Message Passing Interface
[fn:DSL-def] ~DSL~: Domain Specific Language~
--
GitLab