Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add pages for adapters of DuMuX and DUNE #364

Merged
merged 13 commits into from
Apr 5, 2024
Merged

Add pages for adapters of DuMuX and DUNE #364

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
ebfdbbb
Add pages for adapters of DuMuX and DUNE
IshaanDesai Mar 27, 2024
271bb6a
Formatting
IshaanDesai Mar 27, 2024
53af436
Add DuMuX and DUNE adapters to the sidebar
IshaanDesai Mar 29, 2024
26ad74e
Merge branch 'master' into add-dune-dumux
MakisH Apr 4, 2024
dd7bc4b
Remove adapter-dune.md
MakisH Apr 4, 2024
f16b0ec
Add dune-adapter submodule
MakisH Apr 4, 2024
b4d137f
Add dune-adapter submodule to _config.yml
MakisH Apr 4, 2024
2ae6a11
Merge branch 'master' into add-dune-dumux
MakisH Apr 5, 2024
0e53674
Add dumux-adapter in gitmodules
MakisH Apr 5, 2024
1263192
Add dumux-adapter subproject
MakisH Apr 5, 2024
9837030
Remove duplicate dumux adapter docs page
MakisH Apr 5, 2024
551d05b
Add dumux subproject
MakisH Apr 5, 2024
1943dda
Arrange the adapters sidebar (need to make everything folders)
MakisH Apr 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .gitmodules
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,11 @@
path = imported/su2-adapter
url = https://github.com/precice/su2-adapter
branch = develop
[submodule "imported/dune-adapter"]
path = imported/dune-adapter
url = https://github.com/precice/dune-adapter
branch = main
[submodule "imported/dumux-adapter"]
path = imported/dumux-adapter
url = https://github.com/precice/dumux-adapter
branch = develop
26 changes: 26 additions & 0 deletions _config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,30 @@ defaults:
topnav: topnav
toc: true
github_editme_path: https://github.com/precice/su2-adapter/edit/develop/ # ends in /
-
scope:
path: "imported/dune-adapter/"
type: "pages"
values:
layout: "page"
comments: false
search: true
sidebar: docs_sidebar
topnav: topnav
toc: true
github_editme_path: https://github.com/precice/dune-adapter/edit/main/ # ends in /
-
scope:
path: "imported/dumux-adapter/"
type: "pages"
values:
layout: "page"
comments: false
search: true
sidebar: docs_sidebar
topnav: topnav
toc: true
github_editme_path: https://github.com/precice/dumux-adapter/edit/develop/ # ends in /
-
scope:
path: "pages/community"
Expand Down Expand Up @@ -266,6 +290,8 @@ subprojects:
- imported/fmi-runner/docs
- imported/aste/docs
- imported/su2-adapter/docs
- imported/dune-adapter/docs
- imported/dumux-adapter/docs

# We use these versions to centrally update links
# and other version-specific information.
Expand Down
55 changes: 46 additions & 9 deletions _data/sidebars/docs_sidebar.yml
View file
Open in desktop
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wanted DUNE to appear before DuMuX, but DuMuX has multiple pages (it is a folder), while DUNE does not (it is not a folder). To be able to rearrange the sidebar, I made everything folders, as more entries would likely come. In a follow-up, I would probably sort these alphabetically already.

Original file line number Diff line number Diff line change
Expand Up @@ -388,17 +388,54 @@ entries:
url: /adapter-su2-configure.html
output: web, pdf

- title: FEniCS
url: /adapter-fenics.html
output: web, pdf
- title: FEniCS
output: web, pdf
subfolderitems:

- title: code_aster
url: /adapter-code_aster.html
output: web, pdf
- title: Overview
url: /adapter-fenics.html
output: web, pdf

- title: Nutils
url: /adapter-nutils.html
output: web, pdf
- title: Nutils
output: web, pdf
subfolderitems:

- title: Overview
url: /adapter-nutils.html
output: web, pdf

- title: DUNE
output: web, pdf
subfolderitems:

- title: Overview
url: /adapter-dune.html
output: web, pdf

- title: DuMuX
output: web, pdf
subfolderitems:

- title: Overview
url: /adapter-dumux.html
output: web, pdf

- title: Get the adapter
url: /adapter-dumux-get.html
output: web, pdf

- title: Use the adapter
url: /adapter-dumux-use.html
output: web, pdf

- title: code_aster
url: /adapter-code_aster.html
output: web, pdf
subfolderitems:

- title: Overview
url: /adapter-code_aster.html
output: web, pdf

- title: Couple your code
output: web, pdf
Expand Down
1 change: 1 addition & 0 deletions imported/dumux-adapter
Open in desktop
Submodule dumux-adapter added at 7d0e01
1 change: 1 addition & 0 deletions imported/dune-adapter
Open in desktop
Submodule dune-adapter added at 75edcc
2 changes: 2 additions & 0 deletions pages/docs/adapters/adapter-overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ We host adapters for the following codes in the [preCICE GitHub organization](ht
| [Nutils](http://www.nutils.org/) | preCICE Developers | [docs](adapter-nutils.html) | Structure part in CHT, any FEM | |
| [OpenFOAM](https://www.openfoam.com/) | preCICE Developers | [code](https://github.com/precice/openfoam-adapter), [docs](adapter-openfoam-overview.html) | Fluid part in CHT, FSI, FF | |
| [SU2](https://su2code.github.io/) | preCICE Developers | [code](https://github.com/precice/su2-adapter), [docs](adapter-su2-overview.html) | Fluid part in FSI | [Maintainer needed](https://github.com/precice/su2-adapter/issues/16) |
| [DuMuX](https://dumux.org/) | preCICE Developers | [code](https://github.com/precice/dumux-adapter), [docs](adapter-dumux.html) | Darcy-scale in mutliscale, porous media | |
| [DUNE](https://www.dune-project.org/) | preCICE Developers | [code](https://github.com/precice/dune-adapter), [docs](adapter-dune.html) | Structure part in FSI | |

## Third-party adapters

Expand Down
Loading