Skip to content

Commit

Permalink
update doc and version
Browse files Browse the repository at this point in the history
  • Loading branch information
fnrizzi committed Oct 12, 2021
1 parent 01cb14f commit 049b7be
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 13 deletions.
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ include(colors)
# versioning
#=====================================================================
set(Pressio_VERSION_MAJOR 0)
set(Pressio_VERSION_MINOR 10)
set(Pressio_VERSION_MINOR 11)
set(Pressio_VERSION_PATCH 0)
set(Pressio_VERSION
"${Pressio_VERSION_MAJOR}.${Pressio_VERSION_MINOR}.${Pressio_VERSION_PATCH}")
Expand Down
2 changes: 1 addition & 1 deletion docs/html/md_pages_introduction.html
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@
<h1>
Introduction
</h1>
<p>Finish: graphic needs to be updated, content to add.</p><ul><li>ROMs are dense</li><li>pressio was designed with that in mind</li></ul><section id="autotoc_md154"><h2><a href="#autotoc_md154">In a nutshell</a></h2><p>Pressio can be applied to any dynamical system expressible in a <em>continuous-time</em> form as</p><div class="m-math"><svg style="width: 8.303em; height: 2.562em;" viewBox="155.014186 -24.590612 79.71012 24.590612">
<p><span class="m-text m-danger">todo</span>: finish</p><ul><li>graphic needs to be updated</li><li>ROMs are dense</li><li>pressio was designed with that in mind</li></ul><section id="autotoc_md154"><h2><a href="#autotoc_md154">In a nutshell</a></h2><p>Pressio contains model reduction methods supported applicable to any dynamical system expressible in a <em>continuous-time</em> form as</p><div class="m-math"><svg style="width: 8.303em; height: 2.562em;" viewBox="155.014186 -24.590612 79.71012 24.590612">
<title>
\[ \frac{d \boldsymbol{y}}{dt} = \boldsymbol{f}(\boldsymbol{y},t; ...) \]
</title>
Expand Down
7 changes: 3 additions & 4 deletions docs/latex/md_pages_introduction.tex
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
Finish\+: graphic needs to be updated, content to add.


todo\+: finish
\begin{DoxyItemize}
\item graphic needs to be updated
\item ROMs are dense
\item pressio was designed with that in mind
\end{DoxyItemize}\hypertarget{md_pages_introduction_autotoc_md154}{}\doxysection{In a nutshell}\label{md_pages_introduction_autotoc_md154}
Pressio can be applied to any dynamical system expressible in a {\itshape continuous-\/time} form as \[ \frac{d \boldsymbol{y}}{dt} = \boldsymbol{f}(\boldsymbol{y},t; ...) \] and/or in a {\itshape discrete-\/time} form \[ \boldsymbol{R}(\boldsymbol{y}, \boldsymbol{y_{n-1}}, ..., t_n, dt_n; ...) = \boldsymbol{0} \]
Pressio contains model reduction methods supported applicable to any dynamical system expressible in a {\itshape continuous-\/time} form as \[ \frac{d \boldsymbol{y}}{dt} = \boldsymbol{f}(\boldsymbol{y},t; ...) \] and/or in a {\itshape discrete-\/time} form \[ \boldsymbol{R}(\boldsymbol{y}, \boldsymbol{y_{n-1}}, ..., t_n, dt_n; ...) = \boldsymbol{0} \]

Here, $y$ is the full-\/order model (FOM) state, $f$ the FOM velocity, $t$ is time, and $R$ is the residual.

Expand Down
7 changes: 4 additions & 3 deletions docs/pages/introduction.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@

# Introduction

Finish: graphic needs to be updated, content to add.

\todo: finish
- graphic needs to be updated
- ROMs are dense
- pressio was designed with that in mind


## In a nutshell

Pressio can be applied to any dynamical system expressible in
Pressio contains model reduction methods supported applicable
to any dynamical system expressible in
a *continuous-time* form as
@f[
\frac{d \boldsymbol{y}}{dt} =
Expand Down
8 changes: 4 additions & 4 deletions docs/xml/md_pages_introduction.xml
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@
<briefdescription>
</briefdescription>
<detaileddescription>
<para>Finish: graphic needs to be updated, content to add.</para>
<para><itemizedlist>
<listitem><para>ROMs are dense</para>
<para> <mcss:span xmlns:mcss="http://mcss.mosra.cz/doxygen/" mcss:class="m-text m-danger">todo</mcss:span>: finish<itemizedlist>
<listitem><para>graphic needs to be updated</para>
</listitem><listitem><para>ROMs are dense</para>
</listitem><listitem><para>pressio was designed with that in mind</para>
</listitem></itemizedlist>
</para>
<sect1 id="md_pages_introduction_1autotoc_md154">
<title>In a nutshell</title>
<para>Pressio can be applied to any dynamical system expressible in a <emphasis>continuous-time</emphasis> form as <formula id="2">\[ \frac{d \boldsymbol{y}}{dt} = \boldsymbol{f}(\boldsymbol{y},t; ...) \]</formula> and/or in a <emphasis>discrete-time</emphasis> form <formula id="6">\[ \boldsymbol{R}(\boldsymbol{y}, \boldsymbol{y_{n-1}}, ..., t_n, dt_n; ...) = \boldsymbol{0} \]</formula></para>
<para>Pressio contains model reduction methods supported applicable to any dynamical system expressible in a <emphasis>continuous-time</emphasis> form as <formula id="2">\[ \frac{d \boldsymbol{y}}{dt} = \boldsymbol{f}(\boldsymbol{y},t; ...) \]</formula> and/or in a <emphasis>discrete-time</emphasis> form <formula id="6">\[ \boldsymbol{R}(\boldsymbol{y}, \boldsymbol{y_{n-1}}, ..., t_n, dt_n; ...) = \boldsymbol{0} \]</formula></para>
<para>Here, <formula id="3">$y$</formula> is the full-order model (FOM) state, <formula id="4">$f$</formula> the FOM velocity, <formula id="5">$t$</formula> is time, and <formula id="7">$R$</formula> is the residual.</para>
<para>We leverage this expressive mathematical framework as a pivotal design choice to enable a minimal application programming interface (API) that is natural to dynamical systems: you choose the formulation more convenient to you, and interface your application to Pressio by creating a corresponding <emphasis>adapter class</emphasis> to expose the operators needed for the chosen formulation. In general, you don&apos;t need to support both: there are advantages and disadvantages for both, and sometimes the choice is dictated directly by your native application (for example, in some cases it might be easier to directly expose the residual). Read <ulink url="md_pages_components_rom_fom_apis.html">the doc page</ulink> to learn more about the adapter classes and see code templates.</para>
<para><image type="html" name="frontpageschem.svg" width="70%"></image>
Expand Down

0 comments on commit 049b7be

Please sign in to comment.