Skip to content

Commit

Permalink
closes #254 Use page-tag to display mor cases (#255)
Browse files Browse the repository at this point in the history
- add keywords to display manuals and cases
- move cases folders inside ROOT
- add DS_Store to gitignore
- move images
  • Loading branch information
lberti authored Aug 2, 2023
1 parent 365dcb1 commit eea1686
Show file tree
Hide file tree
Showing 15 changed files with 22 additions and 32 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,4 @@ jupyter/
/**/feelppdb/
feelppdb/
toto/
*DS_Store
11 changes: 0 additions & 11 deletions docs/mor/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
@@ -1,11 +0,0 @@
* xref:toolboxmor.adoc[ToolboxMor]
** xref:toolboxmor.adoc#_creating_a_model_from_scratch[Creating a model from scratch]
** xref:toolboxmor.adoc#_creating_a_model_from_a_toolbox[Creating a model from a toolbox]
** xref:toolboxmor.adoc#_configuration[Configuration]
* xref:pbdw.adoc[PBDW]
** xref:pbdw.adoc#_sensors[Sensors]
** xref:pbdw.adoc#_using_pbdw[Using PBDW]
* xref:index.adoc#_cases[Cases]
** xref:opusheat:index.adoc[OpusHeat]
** xref:thermalfin:index.adoc[ThermalFin]
** xref:thermalbuilding:index.adoc[Thermal simulation of 3D building]
14 changes: 2 additions & 12 deletions docs/mor/modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -1,16 +1,6 @@
= Model Order Reduction
:page-layout: case-study
:page-tags: toolbox

Welcome to the documentation of the Feel++ Model Order Reduction.

== Introduction

Feel++ provides a framework for model order reduction. +
One easy way to use it, is to use the xref:toolboxmor.adoc[ToolboxMor] class.

The Parametrized Background Data Weak (xref:pbdw.adoc[PBDW]) method has also been implemented in Feel++.

== Cases

- xref:opusheat:index.adoc[Opus Heat]
- xref:thermalfin:index.adoc[Thermal Fin]
- xref:thermalbuilding:index.adoc[Thermal simulation of 3D building]
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
= Opus Heat
:page-tags: case
:page-illustration: opusheat/eads_geometry.png
:description: We consider a reduced 2D model of the surroundings of an electronic component submitted to a cooling air flow.


This test case has been proposed by mailto:[email protected][Annabelle Le-Hyaric] and
mailto:[email protected][Michel Fouquembergh] formerly at AIRBUS.
Expand Down Expand Up @@ -28,7 +32,7 @@ stem:[k_1] and stem:[k_2] are parameters of the model.

ICs dissipate heat, so the volumic heat dissipated stem:[Q_1] and stem:[Q_2] are also parameters of the model, while stem:[Q_3=Q_4=0].

image::eads_geometry.png[]
image::opusheat/eads_geometry.png[]

One should notice that the convection term in heat transfer equation
may lead to spatial oscillations which can be overcome by
Expand Down
3 changes: 3 additions & 0 deletions docs/mor/modules/ROOT/pages/pbdw.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
= Parametrized Background Data Weak
:page-tags: manual
:description: PBDW manual
:page-illustration: pass:[toolboxes::manual.svg]

== Sensors

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= Thermal simulation of 3D building
:stem: latexmath
:page-tags: case
:page-illustration: 3d_building.png
:page-illustration: thermalbuilding/3d_building.png
:description: We create a reduced order model for the thermal simulation of a 3D building using the stationary heat equation.
:uri-data: https://github.com/feelpp/feelpp/blob/develop/mor/examples/thermalbuilding/

Expand Down Expand Up @@ -91,7 +91,7 @@ F_6 (v) &= \int_{\partial \Omega_D} \sigma v.

=== Geometry

image::heat_3d.png[]
image::thermalbuilding/heat_3d.png[]

The geometry file can be found in Github link:{uri-data}/thermalbuilding/thermalbuilding.geo[here].

Expand Down
6 changes: 6 additions & 0 deletions docs/mor/modules/ROOT/pages/thermalfin/index.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
= Thermal fin
:page-tags: case
:page-illustration: pass:[toolboxes::wip/wip-1.svg]
:description: Work in progress.

The redaction of this page is in progress.
3 changes: 3 additions & 0 deletions docs/mor/modules/ROOT/pages/toolboxmor.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
= ToolboxMor
:page-tags: manual
:description: ToolboxMor manual
:page-illustration: pass:[toolboxes::manual.svg]

ToolboxMor is a class aiming to ease the use of the model order reduction framework of Feel++.
Usually, you would need to define a class which would handle the initialization of the model, its affine decomposition and possibly the use of the EIM methods.
Expand Down
1 change: 0 additions & 1 deletion docs/mor/modules/opusheat/nav.adoc

This file was deleted.

1 change: 0 additions & 1 deletion docs/mor/modules/thermalbuilding/nav.adoc

This file was deleted.

1 change: 0 additions & 1 deletion docs/mor/modules/thermalfin/nav.adoc

This file was deleted.

3 changes: 0 additions & 3 deletions docs/mor/modules/thermalfin/pages/index.adoc

This file was deleted.

0 comments on commit eea1686

Please sign in to comment.