FeenoX documentation index


FeenoX documentation is released under the terms of the GNU Free Documentation License v1.3, or any later version.

1 FeenoX manual and description

As per the GNU Coding Standards, “a manual should serve both as tutorial and reference.” Due to the formatting restrictions, the Texinfo version contains only the description and not the full reference.

The sources are in the doc directory of the Git repository. They are in Pandoc-flavored Markdown.

1.1 Design

The FeenoX project starts as an offer to an imaginary “request for quotations” that defines software requirements specifications for an open source computational tool. Then a fictitious “offer” to the above tender is given in a software design specifications document that explains the design decisions and features included in FeenoX.

1.2 Frequently Asked Questions

1.3 UNIX manpage

See UNIX manpage converted to HTML. It should be accessible with man feenox after (global) installation and its sources are available in the Git repository.

2 Hands on

Go directly to the point and see how to solve problems with FeenoX. Everything (except the case files) is included in the Git repository.

2.1 Quick examples

Annotated examples can be found in the examples directory. These are simple and quick (but varied) cases. They are based on the August 2021 presentation:

2.2 Tutorials

Step-by-step instructions and explanations to solve increasingly-complex problems are given in the tutorials directory.

TO BE DONE

2.3 Case files

Detailed solutions of benchmarks, V&V cases and/or problems with industrial interest. These cases include parametric studies for mesh convergence, comparisons with analytical or other programs, efficiency measurements, etc. Since these cases involve other tools, figures, data files, etc. they have a separate repository.

TO BE DONE

3 Background and generalities

3.1 Software requirements specifications

The FeenoX project starts as an offer to an imaginary “request for quotations” that defines software requirements specifications for a computational tool.

3.2 Software design specifications

The “quotation” to the above tender is given in a software design specifications document that explains the design decisions and features included in FeenoX.

3.3 History

See the FeenoX history.

4 Programming and contributing

4.1 Asking questions & reporting bugs

4.2 Compiling from source

4.3 Contributing guidelines

Any contribution is welcome, especially new types of PDEs and new formulations of existing PDEs. For elliptic operators feel free to use the Laplace equation as a template.

  1. Read the programming guide
  2. Browse Github discussions
  3. Fork the Github repository
  4. Create a pull request

It is mandatory to observe the Code of Conduct.

4.4 How FeenoX documentation system works

TO BE DONE