Loading...
Searching...
No Matches
rheolef

reference manual

# Description

The reference manual is divided into sections:

1. Commands
2. Main classes
3. Main functions
4. Linalg classes
5. Linalg functions
6. Finite elements
7. Utilities
8. Internal classes
9. Internal functions

Casual users probably need concern themselves with only the three first sections: unix commands and main classes and functions. Advanced users would be interested by linalg (sparse distributed linear algebra) and utility classes and functions, while Rheolef's developers would be involved by internal details.

The reference manual is available both on the Rheolef web site and as individual unix man(1) pages.

Commands :

        man geo
        man field

Main classes :

        man form
        man problem
        man 2 field

Note that field has both a command and class entry: the 2 section number option allows one to select the class one. The same occurs for the geo and branch classes.

Main functions :

        man integrate
        man interpolate
        man damped_newton

Finally, for a fully developed table of contents:

        man -k rheolef

# Implementation

This documentation has been generated from file main/lib/rheolef.h