From 676dfba2d0c0aa456a49609bf3fc1cbd4afc4648 Mon Sep 17 00:00:00 2001
From: Nicolas Marsic <marsic@temf.tu-darmstadt.de>
Date: Wed, 24 May 2017 17:41:13 +0200
Subject: [PATCH] more with markdown
---
README.md | 2 +-
example/maxwell_linear/README.md | 31 ++++++++++++++++++++
example/maxwell_linear/README.txt | 22 --------------
example/maxwell_sibc/README.md | 38 +++++++++++++++++++++++++
example/maxwell_sibc/README.txt | 28 ------------------
example/maxwell_sibc_divfree/README.md | 5 ++++
example/maxwell_sibc_divfree/README.txt | 4 ---
7 files changed, 75 insertions(+), 55 deletions(-)
create mode 100644 example/maxwell_linear/README.md
delete mode 100644 example/maxwell_linear/README.txt
create mode 100644 example/maxwell_sibc/README.md
delete mode 100644 example/maxwell_sibc/README.txt
create mode 100644 example/maxwell_sibc_divfree/README.md
delete mode 100644 example/maxwell_sibc_divfree/README.txt
diff --git a/README.md b/README.md
index 22e7374..67cff0d 100644
--- a/README.md
+++ b/README.md
@@ -98,7 +98,7 @@ Python module:
getdp.py
-Finally, Don't forget to update your `PATH`, `PYTHONPATH` and `LD_LIBRARY_PATH`.
+Finally, don't forget to update your `PATH`, `PYTHONPATH` and `LD_LIBRARY_PATH`.
Enjoy!
diff --git a/example/maxwell_linear/README.md b/example/maxwell_linear/README.md
new file mode 100644
index 0000000..b845411
--- /dev/null
+++ b/example/maxwell_linear/README.md
@@ -0,0 +1,31 @@
+This is a simple linear eigenvalue problem example. It consists in a rectangular
+electromagnetic cavity. Simply run:
+
+ make cim
+
+to test cim.py.
+The [Makefile](Makefile) will first mesh the geometry [square.geo](square.geo)
+by calling [Gmsh](http://gmsh.info).
+Afterwards, cim.py is called. The [GetDP](http://getdp.info) formulation is
+located in [maxwell.pro](maxwell.pro). In the [GetDP](http://getdp.info)
+formulation, the variables:
+
+ angularFreqRe
+ angularFreqIm
+ x()
+ b()
+ imposeRHS
+ doPostpro
+ doApply
+ fileName
+
+are reserved for cim.py.
+
+In order to check the solution, simply run:
+
+ make ref
+
+This will solve the linear eigenvalue problem with a classical algorithm. This
+resolution is implemented in [ref.pro](ref.pro). If you use [GetDP](
+http://getdp.info) with [SLEPc](http://slepc.upv.es), the default algorithm
+should be [Krylov-Schur](https://dx.doi.org/10.1137/S0895479800371529).
diff --git a/example/maxwell_linear/README.txt b/example/maxwell_linear/README.txt
deleted file mode 100644
index 2b96765..0000000
--- a/example/maxwell_linear/README.txt
+++ /dev/null
@@ -1,22 +0,0 @@
-This is a simple linear eigenvalue problem example. It consists in a rectangular
-electromagnetic cavity. Simply run:
- make cim
-to test cim.py.
-The Makefile will first mesh the geometry square.geo by calling Gmsh.
-Afterwards, cim.py is called. The GetDP formulation is located in maxwell.pro.
-In the GetDP formulation, the variables:
- angularFreqRe
- angularFreqIm
- x()
- b()
- imposeRHS
- doPostpro
- doApply
- fileName
-are reserved for cim.py.
-
-In order to check the solution, simply run:
- make ref
-This will solve the linear eigenvalue problem with a classical algorithm.
-This resolution is implemented in ref.pro. If you use GetDP with SLEPc,
-the default algorithm should be Krylov-Schur.
diff --git a/example/maxwell_sibc/README.md b/example/maxwell_sibc/README.md
new file mode 100644
index 0000000..1830bff
--- /dev/null
+++ b/example/maxwell_sibc/README.md
@@ -0,0 +1,38 @@
+This is a non-linear eigenvalue problem example. It consists in a spherical
+electromagnetic cavity. The wall conductivity is modelled by a Leontovich
+surface impedance boundary condition (SIBC). Simply run:
+
+ make
+
+to test cim.py.
+The [Makefile](Makefile) will first mesh the geometry [sphere.geo](sphere.geo)
+by calling [Gmsh](http://gmsh.info). Afterwards, cim.py is called. The [GetDP](
+http://getdp.info) formulation is located in [sphere.pro](sphere.pro). In the
+[GetDP](http://getdp.info) formulation, the variables:
+
+ angularFreqRe
+ angularFreqIm
+ x()
+ b()
+ imposeRHS
+ doPostpro
+ doApply
+ fileName
+
+are reserved for cim.py. The parts of the [GetDP](http://getdp.info) code
+related to cim.py are located in [cimParameters.pro](cimParameters.pro) and
+[cimResolution.pro](cimResolution.pro).
+
+For the default parameters:
+
+ radius = 100 mm
+ conductivity = 1e15 S/m
+
+the analytical resonance angular frequency for the fundamental mode should be:
+
+ 8.22543e9+2.46361e1j
+
+where j is the imaginary unit. This analytical result comes from the reference:
+[S. Papantonis and S. Lucyszyn, "Lossy spherical cavity resonators for
+stress-testing arbitrary 3D eigenmode solvers," Progress In Electromagnetics
+Research, vol. 151, pp. 151-167, 2015.](https://dx.doi.org/10.2528/PIER15031702)
diff --git a/example/maxwell_sibc/README.txt b/example/maxwell_sibc/README.txt
deleted file mode 100644
index 45f4d07..0000000
--- a/example/maxwell_sibc/README.txt
+++ /dev/null
@@ -1,28 +0,0 @@
-This is a non-linear eigenvalue problem example. It consists in a spherical
-electromagnetic cavity. The wall conductivity is modelled by a Leontovich
-surface impedance boundary condition (SIBC). Simply run:
- make
-to test cim.py.
-The Makefile will first mesh the geometry square.geo by calling Gmsh.
-Afterwards, cim.py is called. The GetDP formulation is located in sphere.pro.
-In the GetDP formulation, the variables:
- angularFreqRe
- angularFreqIm
- x()
- b()
- imposeRHS
- doPostpro
- doApply
- fileName
-are reserved for cim.py. The parts of the GetDP code related to cim.py are
-located in cimParameters.pro and cimResolution.pro.
-
-For the default parameters:
- radius = 150e-6 m
- conductivity = 1e15 S/m
-the analytical resonance angular frequency for the fundamental mode should be:
- 5.48362e12+4.24068e05j
-where j is the imaginary unit. This analytical result comes from the reference:
- S. Papantonis and S. Lucyszyn, "Lossy spherical cavity resonators for
- stress-testing arbitrary 3D eigenmode solvers," Progress In Electromagnetics
- Research, vol. 151, pp. 151-167, 2015.
diff --git a/example/maxwell_sibc_divfree/README.md b/example/maxwell_sibc_divfree/README.md
new file mode 100644
index 0000000..6398569
--- /dev/null
+++ b/example/maxwell_sibc_divfree/README.md
@@ -0,0 +1,5 @@
+Same example as [maxwell\_sibc](../maxwell_sibc), but imposes a divergence free
+source for Beyn. This is achieved by taking the curl of the random Beyn source.
+
+This example requires a [GetDP](http://getdp.info) version compiled with [Gmsh](
+http://gmsh.info) to handle Fields.
diff --git a/example/maxwell_sibc_divfree/README.txt b/example/maxwell_sibc_divfree/README.txt
deleted file mode 100644
index 2aed69a..0000000
--- a/example/maxwell_sibc_divfree/README.txt
+++ /dev/null
@@ -1,4 +0,0 @@
-See as maxwell_sibc, but imposes a divergence free source for Beyn.
-This is achieved by taking the curl of the random Beyn source.
-
-This example requires a GetDP version compiled with Gmsh to handle Fields.
--
GitLab