Skip to content

Commit 1cedfbf

Browse files
gthelergtheler
committed
doc
1 parent ca49d35 commit 1cedfbf

15 files changed

Lines changed: 91 additions & 67 deletions

‎README‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Consider the following input file:
5151
nu = 0.3
5252

5353
BC left fixed # left face fully fixed
54-
BC top p=1e4*(1+x) # top face with a triapezoidal load
54+
BC top p=1e4*(1+x) # top face with a trapezoidal load
5555

5656
WRITE_RESULTS FORMAT vtu
5757

@@ -62,7 +62,7 @@ Note that
6262
straightforward task—hallucinations are easily detected.
6363
- Material properties and boundary conditions can be expressions of x, y
6464
and z
65-
- Input mesh is is Gmsh’s format .msh
65+
- Input mesh is in Gmsh’s format .msh
6666
- Output results are in Paraview’s .vtk/.vtu formats
6767

6868
Each of these items has a lot of design and usage implications,
@@ -486,6 +486,7 @@ hesitate to ask in FeenoX’s discussion page.
486486
./configure --prefix=$HOME
487487
make
488488
make install
489+
export PATH=$PATH:$HOME/bin
489490

490491
To stay up to date, pull and then autogen, configure and make (and
491492
optionally install):
@@ -640,8 +641,8 @@ Note that
640641
- Each author keeps the copyright of the contribution.
641642
- You can ask!
642643

643-
[hackers]: README4hackers.html
644-
[academics]: README4academics.html
644+
[hackers]: ../README4hackers.html
645+
[academics]: ../README4academics.html
645646
[src/pdes/laplace]: https://github.com/seamplex/feenox/tree/main/src/pdes/laplace
646647
[9]: https://seamplex.com/feenox/doc/programming.html
647648
[Github discussions]: https://github.com/seamplex/feenox/discussions

‎README.markdown‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ E = 200e3 * (1-T(x,y,z)/300) # temperature-dependent Young modulus
5252
nu = 0.3
5353
5454
BC left fixed # left face fully fixed
55-
BC top p=1e4*(1+x) # top face with a triapezoidal load
55+
BC top p=1e4*(1+x) # top face with a trapezoidal load
5656
5757
WRITE_RESULTS FORMAT vtu
5858
```
@@ -65,7 +65,7 @@ Note that
6565
straightforward task—hallucinations are easily detected.
6666
- [Material properties and boundary conditions] can be [expressions of
6767
$`x`$, $`y`$ and $`z`$]
68-
- Input mesh is is [Gmsh’s format `.msh`]
68+
- Input mesh is in [Gmsh’s format `.msh`]
6969
- Output results are in [Paraview’s `.vtk`/`.vtu`
7070
formats][Gmsh’s format `.msh`]
7171

@@ -502,6 +502,7 @@ hesitate to ask in FeenoX’s [discussion page].
502502
> ./configure --prefix=$HOME
503503
> make
504504
> make install
505+
> export PATH=$PATH:$HOME/bin
505506
> ```
506507
507508
To stay up to date, pull and then `autogen`, `configure` and `make` (and
@@ -660,8 +661,8 @@ Note that
660661
- Each author keeps the copyright of the contribution.
661662
- You can [ask][Github discussions]!
662663

663-
[hackers]: README4hackers.html
664-
[academics]: README4academics.html
664+
[hackers]: ../README4hackers.html
665+
[academics]: ../README4academics.html
665666
[`src/pdes/laplace`]: https://github.com/seamplex/feenox/tree/main/src/pdes/laplace
666667
[9]: https://seamplex.com/feenox/doc/programming.html
667668
[Github discussions]: https://github.com/seamplex/feenox/discussions

‎README4academics‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,8 @@ It can be seen as a Unix filter (or as a transfer function)
6767

6868
+------------+
6969
mesh (*.msh) } | | { terminal
70-
data (*.dat) } input ----> | FeenoX |----> output { data files
71-
input (*.fee) } | | { post (vtk/msh)
70+
input (*.fee) } input ----> | FeenoX |----> output { data files
71+
data file } | | { post (vtk/msh)
7272
+------------+
7373

7474
which, when zoomed in, acts as a “glue layer” between a mesher (Gmsh)

‎README4academics.markdown‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,8 +73,8 @@ It can be seen as a Unix filter (or as a transfer function)
7373

7474
+------------+
7575
mesh (*.msh) } | | { terminal
76-
data (*.dat) } input ----> | FeenoX |----> output { data files
77-
input (*.fee) } | | { post (vtk/msh)
76+
input (*.fee) } input ----> | FeenoX |----> output { data files
77+
data file } | | { post (vtk/msh)
7878
+------------+
7979

8080
which, when zoomed in, acts as a “glue layer” between a mesher ([Gmsh])

‎README4engineers‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ between one or more input files and zero or more output files:
3131

3232
+------------+
3333
mesh (*.msh) } | | { terminal
34-
data (*.dat) } input ----> | FeenoX |----> output { data files
35-
input (*.fee) } | | { post (vtk/msh)
34+
input (*.fee) } input ----> | FeenoX |----> output { data files
35+
data file } | | { post (vtk/msh)
3636
+------------+
3737

3838
When solving problems using the finite element method, FeenoX sits in

‎README4engineers.markdown‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ between one or more [input files] and zero or more [output files][]:
3333

3434
+------------+
3535
mesh (*.msh) } | | { terminal
36-
data (*.dat) } input ----> | FeenoX |----> output { data files
37-
input (*.fee) } | | { post (vtk/msh)
36+
input (*.fee) } input ----> | FeenoX |----> output { data files
37+
data file } | | { post (vtk/msh)
3838
+------------+
3939

4040
When solving problems using the finite element method, FeenoX sits in

‎README4hackers‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -282,8 +282,8 @@ when solving PDEs FeenoX works very much as a Unix pipe between a mesher
282282

283283
+------------+
284284
mesh (*.msh) } | | { terminal
285-
data (*.dat) } input ----> | FeenoX |----> output { data files
286-
input (*.fee) } | | { post (vtk/msh)
285+
input (*.fee) } input ----> | FeenoX |----> output { data files
286+
data file } | | { post (vtk/msh)
287287
+------------+
288288

289289
FeenoX consists of a binary executable which is compiled using GNU

‎README4hackers.markdown‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -288,8 +288,8 @@ when solving PDEs FeenoX works very much as a Unix pipe between a mesher
288288

289289
+------------+
290290
mesh (*.msh) } | | { terminal
291-
data (*.dat) } input ----> | FeenoX |----> output { data files
292-
input (*.fee) } | | { post (vtk/msh)
291+
input (*.fee) } input ----> | FeenoX |----> output { data files
292+
data file } | | { post (vtk/msh)
293293
+------------+
294294

295295
FeenoX consists of a binary executable which is compiled using GNU

‎doc/CODE_OF_CONDUCT.markdown‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ chaptersDepth: 1
2020
codeBlockCaptions: false
2121
cref: false
2222
crossrefYaml: pandoc-crossref.yaml
23-
date: 2025-09-22
23+
date: 2026-02-10
2424
eqLabels: arabic
2525
eqnBlockInlineMath: false
2626
eqnBlockTemplate: |

‎doc/FAQ.markdown‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ chaptersDepth: 1
2020
codeBlockCaptions: false
2121
cref: false
2222
crossrefYaml: pandoc-crossref.yaml
23-
date: 2025-09-22
23+
date: 2026-02-10
2424
eqLabels: arabic
2525
eqnBlockInlineMath: false
2626
eqnBlockTemplate: |
@@ -436,8 +436,8 @@ files and zero or more output files:
436436

437437
+------------+
438438
mesh (*.msh) } | | { terminal
439-
data (*.dat) } input ----> | FeenoX |----> output { data files
440-
input (*.fee) } | | { post (vtk/msh)
439+
input (*.fee) } input ----> | FeenoX |----> output { data files
440+
data file } | | { post (vtk/msh)
441441
+------------+
442442

443443
Recall that FeenoX is designed as a cloud-first tool, and “the cloud”

0 commit comments

Comments
 (0)