Skip to content

Commit 71de78f

Browse files
authored
Update readme.md introducing a title and markdown syntax
1 parent 8c356b8 commit 71de78f

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

src/irrevolutions/algorithms/readme.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
1-
This folder contains 3 python scripts.
2-
So.py (standing for Second Order) deals with solving PDEs via the Finite Element Method in Fenics and solving eigenvalue problems. Specificlly, it deals ith bifurcation problem and our concept of stability, which is encoded and solved as an eigenvalue problem in a cone of directions.
1+
# Algorithms
32

4-
Am.py
5-
Contains two classes, AlternateMinimisation and HybridSolver.
6-
7-
Class Definitions: Two classes, which are invoked elsewehere?, are defined here: AlternateMinimisation and HybridSolver.
3+
`so.py` (standing for Second Order) deals with solving PDEs via the Finite Element Method in Fenics and solving eigenvalue problems. Specificlly, it deals ith bifurcation problem and our concept of stability, which is encoded and solved as an eigenvalue problem in a cone of directions.
84

9-
AlternateMinimisation implements an alternate minimization algorithm by solving a system of equations.
5+
`am.py`
6+
Contains two classes, `AlternateMinimisation` and `HybridSolver`.
7+
8+
`AlternateMinimisation` implements an alternate minimization algorithm by solving a system of equations.
109
Depending on the specified convergence criteria (e.g., based on error norms vs. residual norms), the solver loop terminates if the specified tolerance is
1110
reached.
1211
It implements optimality conditions of the first order, via alternate variations.

0 commit comments

Comments
 (0)