|
1 | | -ADMSL |
2 | | -===== |
3 | | - |
4 | | -Algorithmically Differentiated Library of a part of the standard library Modelica.Electrical.Analog.Basic |
5 | | - |
6 | | - |
7 | | -Description |
8 | | -=========== |
9 | | - |
10 | | -ADMSL is the Algorithmically Differentiated (AD) version of a part of the Modelica standard package Modelica.Electrical.Analog.Basic. |
11 | | -The underlying promising goal is to become the AD version of the Modelica Standard Library. This is where the name ADMSL comes from (Algorithmically differentiated Modelica Standard Library). |
12 | | - |
13 | | -This library serves as a guide for illustrating equation-based algorithmic differentation techniques for Modelica libraries. |
14 | | -An algorithmically differentiated Modelica library contains everything the original version has together with parameter sensitivities. |
15 | | -The same models relying on that library can evaluates parameter sensitivities with few minimal efforts and slight changes. However these models preserve the same interface and outlook. |
16 | | - |
17 | | - |
18 | | -It represents a testing platform for algoirhtmic differerntiation of Modelica libraries w.r.t. |
19 | | - * algorithmic methodologies |
20 | | - * identifying current limitations towards AD of Modelica models |
21 | | - * suggesting / recommending further potential language improvements towards AD of Modelica models |
22 | | - |
23 | | - |
24 | | - |
25 | | - |
26 | | -Release Notes |
27 | | -============= |
28 | | - |
29 | | -current release 1.0 |
30 | | - |
31 | | - |
32 | | -r1.0 : 26.01.2014 - Algorithmic differentiation of some classes of the Modelica.Electrical.Analog.Basic |
33 | | - |
34 | | - |
35 | | -License |
36 | | -======= |
37 | | - |
38 | | -Copyright © 2013, Austrian Institute of Technology, Energy Department, Complex Energy Systems |
39 | | -This Modelica package is free software and the use is completely at your own risk; |
40 | | -it can be redistributed and/or modified under the terms of the [Modelica License 2](https://modelica.org/licenses/ModelicaLicense2). |
41 | | - |
42 | | -Author |
43 | | -====== |
44 | | - |
45 | | -Atiyah Elsheikh (Email: [email protected]) |
46 | | - |
47 | | - |
48 | | -Tested with |
49 | | -=========== |
50 | | - |
51 | | -Dymola 2014, Modelica library 3.2 |
52 | | - |
53 | | - |
54 | | -Literature |
55 | | -========== |
56 | | - |
57 | | -Please cite: |
58 | | - |
59 | | -1- Atiyah Elsheikh, Modeling parameter sensitivities via equation-based algorithmic differentiation techniques -- The ADMSL.Electrical.Analog.Library, |
60 | | -Modelica'2014: The 10th International Modelica Conference, Mar. 2014 Lund, Sweden, |
61 | | -2- Atiyah Elsheikh, Modelica-based computational tools for sensitivity analysis via automatic differentiation, Dissertation, RWTH Aachen University, Aachen, Germany, 2011. |
62 | | -3- Atiyah Elsheikh, ADGenKinetics: An algorithmically differentiated library for biochemical networks modeling via simplified kinetics formats |
63 | | - |
64 | | - |
65 | | -Online version of the paper can be found here: |
66 | | -http://www.researchgate.net/profile/Atiyah_Elsheikh/publications/ |
67 | | - |
68 | | -Bibtex source: |
69 | | -@CONFERENCE{Elsheikh2014a, |
70 | | - author = {Atiyah Elsheikh}, |
71 | | - title = {Modeling parameter sensitivities via equation-based algorithmic differentiation techniques: The {ADMSL.Electrical.Analog} library}, |
72 | | - booktitle = {Modelica'2014: The 10th International Modelica Conference}, |
73 | | - year = {2014}, |
74 | | - address = {Lund, Sweden}, |
75 | | - month = {Mar.} |
76 | | -} |
77 | | - |
78 | | -@PHDTHESIS{Elsheikh2011, |
79 | | -author = {Atiyah Elsheikh}, |
80 | | -title = {Modelica-based computational tools for sensitivity analysis via automatic differentiation}, |
81 | | -school = {RWTH Aachen university}, |
82 | | -year = {2011}, |
83 | | -type = {Dissertation}, |
84 | | -address = {Aachen, Germany} |
85 | | -} |
86 | | - |
87 | | -@INPROCEEDINGS{Elsheikh2012, |
88 | | -author = {Atiyah Elsheikh}, |
89 | | -title = {{ADGenKinetics}: An Algorithmically Differentiated Library for Biochemical Networks Modeling via Simplified Kinetics Formats}, |
90 | | -booktitle = {Modelica'2012: The 9th International Modelica Conference}, |
91 | | -year = {2012}, |
92 | | -number = {076}, |
93 | | -series = {Linköping Electronic Conference Proceedings}, |
94 | | -pages = {915 -- 926}, |
95 | | -address = {Munich, Germany}, |
96 | | -month = {Sep.}, |
97 | | -doi = {ecp12076915} |
98 | | -} |
99 | | - |
100 | | - |
101 | | -Further contribution |
102 | | -==================== |
103 | | - |
104 | | -Further contribution / collaboration on the topic of algorithmic differentiation of Modelica libraries are welcome |
| 1 | +ADMSL |
| 2 | +===== |
| 3 | + |
| 4 | +Algorithmically Differentiated Library of a part of the standard library Modelica.Electrical.Analog.Basic |
| 5 | + |
| 6 | +Author |
| 7 | +------ |
| 8 | + |
| 9 | +Atiyah Elsheikh [Email ]([email protected]) |
| 10 | +See [my Profile](http://mathemodica.com/members/atiyah/) |
| 11 | + |
| 12 | +Description |
| 13 | +----------- |
| 14 | + |
| 15 | +ADMSL is the Algorithmically Differentiated (AD) version of a part of the Modelica standard package Modelica.Electrical.Analog.Basic. |
| 16 | +The underlying promising goal is to become the AD version of the Modelica Standard Library. This is where the name ADMSL comes from (Algorithmically differentiated Modelica Standard Library). |
| 17 | + |
| 18 | +This library serves as a guide for illustrating equation-based algorithmic differentation techniques for Modelica libraries. |
| 19 | +An algorithmically differentiated Modelica library contains everything the original version has together with parameter sensitivities. |
| 20 | +The same models relying on that library can evaluates parameter sensitivities with few minimal efforts and slight changes. However these models preserve the same interface and outlook. |
| 21 | + |
| 22 | +It represents a testing platform for algoirhtmic differerntiation of Modelica libraries w.r.t. |
| 23 | + * algorithmic methodologies |
| 24 | + * identifying current limitations towards AD of Modelica models |
| 25 | + * suggesting / recommending further potential language improvements towards AD of Modelica models |
| 26 | + |
| 27 | + |
| 28 | + |
| 29 | + |
| 30 | +Further contribution |
| 31 | +-------------------- |
| 32 | + |
| 33 | +Further contribution / collaboration on the topic of algorithmic differentiation of Modelica libraries are welcome. |
| 34 | +Please consult [HowToAddComponent](https://github.com/AtiyahElsheikh/ADMSL/blob/master/UserGuide/HowToAddComponent.mo) using a |
| 35 | +a Modelica simulation environment. |
| 36 | + |
| 37 | + |
| 38 | +Releases |
| 39 | +======== |
| 40 | + |
| 41 | +Currenet Release |
| 42 | +---------------- |
| 43 | + |
| 44 | +current release is V1.1.0-alpha (Hamburg Release). Detailed release notes can be consulted [here](https://github.com/AtiyahElsheikh/ADMSL/blob/master/UserGuide/ReleaseNotes.mo) |
| 45 | +using a Modelica simulation environment. |
| 46 | + |
| 47 | +Tested with |
| 48 | +----------- |
| 49 | + |
| 50 | +- OpenModelica 1.13.2 |
| 51 | +- Dymola 2020 |
| 52 | +- MSL 3.2.3 |
| 53 | + |
| 54 | +History |
| 55 | +------- |
| 56 | + |
| 57 | +* v1.1.0-alpha (Hamburg Release ) : September 2019 |
| 58 | + - Improving the overall formulation and working version with OpenModelica 1.13.0 |
| 59 | + |
| 60 | +* v1.0 (Vienna Release) : January 2014 |
| 61 | + - Algorithmic differentiation of some classes of the Modelica.Electrical.Analog.Basic |
| 62 | + |
| 63 | + |
| 64 | +Licenses |
| 65 | +======== |
| 66 | + |
| 67 | +License V1.1.0 (Hamburg Release) |
| 68 | +-------------------------------- |
| 69 | + |
| 70 | +Copyright © 2019, Mathemodica.com |
| 71 | +This Modelica package is free software and the use is completely at your own risk; |
| 72 | +it can be redistributed and/or modified under the terms of the [3-BSD License of Modelica Association](https://www.modelica.org/licenses/modelica-3-clause-bsd). |
| 73 | + |
| 74 | +License V1.0 (Vienna Release) |
| 75 | +----------------------------- |
| 76 | + |
| 77 | +Copyright © 2013, Austrian Institute of Technology, Energy Department, Complex Energy Systems |
| 78 | +This Modelica package is free software and the use is completely at your own risk; |
| 79 | +it can be redistributed and/or modified under the terms of the [Modelica License 2](https://modelica.org/licenses/ModelicaLicense2). |
| 80 | + |
| 81 | + |
| 82 | +References |
| 83 | +========== |
| 84 | + |
| 85 | +* Atiyah Elsheikh, Dynamic Parameter Sensitivities: Summary of computation methods for continuous-time Modelica models, Modelica'2019: The 13th International Modelica Conference, Regensburg, Germany, 2019 |
| 86 | + |
| 87 | +* Atiyah Elsheikh, Modeling parameter sensitivities via equation-based algorithmic differentiation techniques: The ADMSL.Electrical.Analog.Library, Modelica'2014: The 10th International Modelica Conference, Lund, Sweden, 2014 |
| 88 | + |
| 89 | +* Atiyah Elsheikh, Modelica-based computational tools for sensitivity analysis via automatic differentiation, Dissertation, RWTH Aachen university, 2013. |
| 90 | + |
| 91 | +* Atiyah Elsheikh, ADGenKinetics: An algorithmically differentiated library for biochemical networks modeling via simplified kinetics formats, Modelica'2012, Munich, Germany, 2012 |
| 92 | + |
| 93 | +Online versions of the paper can be found here: |
| 94 | +http://www.researchgate.net/profile/Atiyah_Elsheikh/publications/ |
| 95 | + |
| 96 | +Bibtex sources |
| 97 | +-------------- |
| 98 | + |
| 99 | +@Conference{Elsheikh2019, |
| 100 | +author = {Atiyah Elsheikh}, |
| 101 | +title = {{Dynamic Parameter Sensitivities: Summary of computation methods for continuous-time Modelica models}}, |
| 102 | +booktitle = {Modelica'2019: The 13th International Modelica Conference}, |
| 103 | +year = {2019}, |
| 104 | +address = {Regensburg, Germany}, |
| 105 | +month = {Mar.}, |
| 106 | +} |
| 107 | + |
| 108 | +@CONFERENCE{Elsheikh2014a, |
| 109 | +author = {Atiyah Elsheikh}, |
| 110 | +title = {Modeling parameter sensitivities via equation-based algorithmic differentiation techniques: The {ADMSL.Electrical.Analog} library}, |
| 111 | +booktitle = {Modelica'2014: The 10th International Modelica Conference}, |
| 112 | +year = {2014}, |
| 113 | +address = {Lund, Sweden}, |
| 114 | +month = {Mar.} |
| 115 | +} |
| 116 | + |
| 117 | +@PHDTHESIS{Elsheikh2013, |
| 118 | +author = {Atiyah Elsheikh}, |
| 119 | +title = {Modelica-based computational tools for sensitivity analysis via automatic differentiation}, |
| 120 | +school = {RWTH Aachen university}, |
| 121 | +year = {2013}, |
| 122 | +type = {Dissertation}, |
| 123 | +address = {Aachen, Germany} |
| 124 | +} |
| 125 | + |
| 126 | +@INPROCEEDINGS{Elsheikh2012, |
| 127 | +author = {Atiyah Elsheikh}, |
| 128 | +title = {{ADGenKinetics}: An Algorithmically Differentiated Library for Biochemical Networks Modeling via Simplified Kinetics Formats}, |
| 129 | +booktitle = {Modelica'2012: The 9th International Modelica Conference}, |
| 130 | +year = {2012}, |
| 131 | +number = {076}, |
| 132 | +series = {Linköping Electronic Conference Proceedings}, |
| 133 | +pages = {915 -- 926}, |
| 134 | +address = {Munich, Germany}, |
| 135 | +month = {Sep.}, |
| 136 | +doi = {ecp12076915} |
| 137 | +} |
| 138 | + |
0 commit comments