doc

Author: gtheler

ChangeLog.md

@@ -1,14 +1,14 @@
 # Current (under development)
 
- * ...
+ * basic example for a large-deformation mechanical case (NAFEMS GNL-5 benchmar problem)
  * outputs from `WRITE_RESULTS` or `WRITE_MESH` in `vtu` or `vtk` for transient problems create a `.pvd` file
  * instruction `PROBLEM_SOLVE` is not mandatory anymore, now FeenoX can guess where it should be called
  * keyword `READ_DATA` to read variables and vectors from files
  * `PROBLEM` can define `MESH` in a single line without an explicit `READ_MESH` instruction
  * neo-hookean material model
  * MMS verification for mechanical with both sdef & ldef
  * Saint Venant-Kirchoff material model for ldef
- * large deformation formulation for `mechanical`
+ * biasc large-deformation formulation for `mechanical`
 
 # v1.1 (Apr 2025)
 

README4academics.markdown

@@ -28,14 +28,16 @@ elemental objects which correspond the to chosen PDE. The list of
 available PDEs can be peeked by executing the `feenox` binary with the
 `--pdes` option:
 
-    $ feenox --pdes
-    laplace
-    mechanical
-    modal
-    neutron_diffusion
-    neutron_sn
-    thermal
-    $ 
+``` terminal
+$ feenox --pdes
+laplace
+mechanical
+modal
+neutron_diffusion
+neutron_sn
+thermal
+$ 
+```
 
 During the compilation procedure (based on Autotools), the source tree
 in [`src/pdes`] is parsed. For each subdirectory, a new PDE is embedded

README4hackers

@@ -174,11 +174,17 @@ Unlike these other FEA tools, FeenoX provides…
       6
       8
       10
-      $ 
+      $
 
 - flexibility to handle many workflows, including web-based interfaces
   and thin command-line clients.
 
+  - In particular, FeenoX is particularly well suited to be incldued in
+    workflows involving LLMs and/or AI agents.
+
+- official Debian and Ubuntu packages built on Salsa from the source
+  tarballs.
+
 The input file…
 
 - has a one-to-one correspondence with the human description of the
@@ -193,6 +199,7 @@ The input file…
 - is simple for simple files (but might get more complicated for more
   complex problems). Remember Alan Kay’s quote: “simple things should be
   simple and complex things should be possible.”
+- can be created using assistance from LLMs and AI agents.
 
 Following the Unix rule of silence, the output is 100% user-defined: if
 there are not explicit output instructions, FeenoX will not write

README4hackers.markdown

@@ -176,12 +176,18 @@ Unlike these other FEA tools, FeenoX provides…
   6
   8
   10
-  $ 
+  $
   ```
 
 - flexibility to handle many workflows, including [web-based interfaces]
   and [thin command-line clients].
 
+  - In particular, FeenoX is particularly well suited to be incldued in
+    workflows involving LLMs and/or AI agents.
+
+- official Debian and Ubuntu packages built on Salsa from the source
+  tarballs.
+
 The [input file][self-explanatory ASCII file]…
 
 - has a [one-to-one correspondence with the human description of the
@@ -197,6 +203,7 @@ The [input file][self-explanatory ASCII file]…
 - is [simple for simple files] (but might get [more complicated for more
   complex problems]). Remember [Alan Kay]’s quote: [“simple things
   should be simple and complex things should be possible.”]
+- can be created using assistance from LLMs and AI agents.
 
 Following the Unix rule of silence, [the output is 100% user-defined][]:
 if there are not explicit output instructions, FeenoX will not write

doc/CODE_OF_CONDUCT.markdown

@@ -20,7 +20,7 @@ chaptersDepth: 1
 codeBlockCaptions: false
 cref: false
 crossrefYaml: pandoc-crossref.yaml
-date: 2025-08-22
+date: 2025-08-26
 eqLabels: arabic
 eqnBlockInlineMath: false
 eqnBlockTemplate: |

doc/FAQ.markdown

@@ -20,7 +20,7 @@ chaptersDepth: 1
 codeBlockCaptions: false
 cref: false
 crossrefYaml: pandoc-crossref.yaml
-date: 2025-08-22
+date: 2025-08-26
 eqLabels: arabic
 eqnBlockInlineMath: false
 eqnBlockTemplate: |

doc/feenox.1

@@ -1,6 +1,6 @@
 .\" Automatically generated by Pandoc 3.7.0.2
 .\"
-.TH "FEENOX" "1" "2025\-08\-22" "FeenoX" "FeenoX User Manual"
+.TH "FEENOX" "1" "2025\-08\-26" "FeenoX" "FeenoX User Manual"
 .SH NAME
 FeenoX \- a cloud\-first free no\-X uniX\-like finite\-element(ish)
 computational engineering tool
@@ -1454,20 +1454,30 @@ It can be used in \f[CR]IF\f[R] blocks to check if the transient steps
 are finished or not.
 .SS \f[CR]dt\f[R]
 .PP
-Actual value of the time step for transient calculations.
-.PP
-When solving DAE systems, this variable is set by feenox.
-It can be written by the user for example by importing it from another
-transient code by means of shared\-memory objects.
-Care should be taken when solving DAE systems and overwriting
-\f[CR]t\f[R].
-Default value is DEFAULT_DT, which is a power of two and roundoff errors
-are thus reduced.
+Actual value of the time step for transient or quasi\-static
+calculations.
+.PP
+This variable can be \f[CR]PRINT\f[R]ed and used in expressions
+involving time and/or as arguments of time\-dependent functions.
+The initial time step can be set by assigning a non\-zero value to
+\f[CR]dt_0\f[R].
+Do not set \f[CR]dt\f[R] explicitly in an assignment.
+If you want to have a constant time step set both \f[CR]min_dt\f[R] and
+\f[CR]max_dt\f[R] to the same value.
+Default initial time step is DEFAULT_DT, which is a power of two and
+round\-off errors are thus reduced.
 .SS \f[CR]end_time\f[R]
 .PP
-Final time of the transient calculation, to be set by the user.
+Final time of the transient calculation.
 .PP
-The default value is zero, meaning no transient calculation.
+Set this variable to a positive value to ask for a transient
+calculation.
+For some PDEs, the default might be a quasi\-static problem instead of
+an actual transient one.
+For instance, setting a non\-zero \f[CR]end_time\f[R] in
+\f[CR]PROBLEM mechanical\f[R] starts a quasi\-static computation but a
+real transient one for \f[CR]PROBLEM thermal\f[R].
+The default value is zero, meaning a static problem.
 .SS \f[CR]i\f[R]
 .PP
 Dummy index, used mainly in vector and matrix row subindex expressions.
@@ -1513,12 +1523,12 @@ calculation.
 Dummy index, used mainly in matrix column subindex expressions.
 .SS \f[CR]max_dt\f[R]
 .PP
-Maximum bound for the time step that feenox should take when solving DAE
-systems.
+Maximum bound for the time step that FeenoX should take when solving
+transient systems.
 .SS \f[CR]min_dt\f[R]
 .PP
-Minimum bound for the time step that feenox should take when solving DAE
-systems.
+Minimum bound for the time step that FeenoX should take when solving
+transient problems.
 .SS \f[CR]mpi_rank\f[R]
 .PP
 The current rank in an MPI execution.
@@ -1541,7 +1551,7 @@ Not\-A\-Number signal (such as a division by zero) is generated when
 evaluating any expression within feenox.
 .SS \f[CR]pi\f[R]
 .PP
-A double\-precision floating point representation of the number
+A double\-precision floating· point representation of the number
 \f[I]π\f[R]
 .PP
 It is equal to the \f[CR]M_PI\f[R] constant in \f[CR]math.h\f[R] .
@@ -1568,13 +1578,13 @@ This is a read\-only variable that contains the current step of the
 transient calculation.
 .SS \f[CR]t\f[R]
 .PP
-Actual value of the time for transient calculations.
+Actual value of the time for transient or quasi\-static calculations.
 .PP
-This variable is set by FeenoX, but can be written by the user for
-example by importing it from another transient code by means of
-shared\-memory objects.
-Care should be taken when solving DAE systems and overwriting
-\f[CR]t\f[R].
+This variable can be \f[CR]PRINT\f[R]ed and used in expressions
+involving time and/or as arguments of time\-dependent functions.
+It stars equal to zero and it is updated by FeenoX according to the
+time\-stepping scheme.
+At the end, it is exactly equal to \f[CR]end_time\f[R].
 .SS \f[CR]zero\f[R]
 .PP
 A very small positive number.