Skip to content

Commit a0fe436

Browse files
authored
Update README.md
1 parent 38615fc commit a0fe436

File tree

1 file changed

+48
-6
lines changed

1 file changed

+48
-6
lines changed

README.md

Lines changed: 48 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,38 @@
1010

1111
of large-scale port-Hamiltonian (pH) models. The model class of pH systems enables energy-based modeling and a flexible coupling of models across different physical domains. This makes them well-suited for the simulation and control of complex technical systems.
1212

13-
### The *phs* class
13+
## Port-Hamiltonian systems
1414

15-
In **MORpH**, pH models are represented as objects of the *phs* class. They can be created in the following way:
15+
In **MORpH**, we work with pH models of the following form:
16+
17+
$$
18+
\begin{align*}
19+
Ex(t) &= (J-R)Qx(t) + (G-P)u(t), \\
20+
y(t) &= (G+P)^TQx(t) + (S+N)u(t),
21+
\end{align*}
22+
$$
23+
24+
where $E,Q,J,R \in \mathbb{R}^{n \times n}$, $G,P \in \mathbb{R}^{n \times m}$, $S,N \in \mathbb{R}^{m \times m}$ fulfill the following constraints:
25+
26+
(i) The structure matrix
27+
28+
$$ \Gamma := \left\lbrack \matrix{Q^T J Q & Q^T G \cr -G^T Q & N} \right\rbrack $$
29+
30+
is skew-symmetric, i.e., $\Gamma=-\Gamma^T$.
31+
32+
(ii) The dissipation matrix
33+
34+
$$ W := \left\lbrack \matrix{Q^T R Q & Q^T P \cr P^T Q & S} \right\rbrack $$
35+
36+
is positive semi-definite, i.e., $W=W^T\geq 0$.
37+
38+
(iii) The quadratic Hamiltonian is stated as:
39+
40+
$$ \mathcal{H}(x) = \frac{1}{2}x^T Q^T E x $$
41+
42+
with $Q^T E = E^T Q \geq 0$.
43+
44+
PH models are represented as objects of the *phs* class. They can be created in the following way:
1645
```
1746
sys = phs(J,R,Q,G,E,P,S,N);
1847
```
@@ -25,21 +54,34 @@ bode(sys)
2554

2655
### Structure-preserving MOR
2756

28-
**MORpH** offers different ways to reduce large-scale pH models in a structure-preserving way, meaning that the reduced model also has pH form.
57+
The goal of structure-preserving MOR is to approximate a large-scale pH model with a much smaller reduced model
58+
59+
$$
60+
\begin{align*}
61+
\hat{E}\hat{x}(t) &= (\hat{J}-\hat{R})\hat{Q}\hat{x}(t) + (\hat{G}-\hat{P})u(t), \\
62+
\hat{y}(t) &= (\hat{G}+\hat{P})^T\hat{Q}\hat{x}(t) + (\hat{S}+\hat{N})u(t),
63+
\end{align*}
64+
$$
65+
66+
with reduced state vector $\hat{x} \in \mathbb{R}^{r}$ such that (i) $r \ll n$, (ii) $\hat{y} \approx y$ for certain $u$ and (iii) the reduced model fulfills the pH structural constraints.
67+
68+
**MORpH** offers different algorithms to reduce large-scale pH models with an intuitive user interface.
2969
For example, we can reduce our created pH model ```sys``` with the IRKA-PH algorithm (see [[1]](https://doi.org/10.1016/j.automatica.2012.05.052)) to a system with dimension ```redOrder``` via
3070
```
3171
redSys = irkaPH(sys, redOrder, Opts);
3272
```
3373
The ```Opts``` struct can be used to configure the algorithm's parameters.
34-
An overview of the implemented algorithms is given [HERE](src/MOR/README.md). For a more detailed description of the different algorithms, pleases have a look at the [DEMO](/demos) files.
74+
An overview of the implemented algorithms is given [here](src/MOR/README.md). For a more detailed description of the different algorithms, pleases have a look at the [demos](/demos).
3575

3676

3777
## Installation
3878

3979
After downloading **MORpH**, change to the installation directory in MATLAB and run the script `setup_morph.m`.
4080
It also assists with the installation of third-party software that may be required for some functionalities within **MORpH**.
4181

42-
### Toolbox structure
82+
## Getting started
83+
You successfully installed **MORpH**? Great! The best way to get familiar with the toolbox is the [demo for creating pH models](demos/demo_phs_class.mlx). After you created your first pH model, you can analyze your model with the functions provided [here](src/@phs). Next, you can have a look [here](src/MOR/README.md) for an overview of the different MOR methods.
84+
4385
The toolbox is structured as follows:
4486

4587
**MORpH** (main folder)
@@ -74,4 +116,4 @@ For more information on how to contribute, please look [HERE](/CONTRIBUTING.md).
74116

75117
## Copyright
76118
This toolbox is developed by [MORLab](https://www.epc.ed.tum.de/en/rt/research/model-order-reduction/), the model reduction lab at the [Chair of Automatic Control](https://www.epc.ed.tum.de/en/rt/home/) at [TUM](https://www.tum.de/en/).
77-
For more information, see [HERE](/LICENSE.md).
119+
For more information, see [HERE](/LICENSE.md).

0 commit comments

Comments
 (0)