Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/develop' into saigre/pyfeelpp
Browse files Browse the repository at this point in the history
  • Loading branch information
thomas-saigre committed Nov 16, 2022
2 parents 6957d20 + a5fb45b commit 03dee45
Show file tree
Hide file tree
Showing 281 changed files with 6,203 additions and 3,731 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/index.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ jobs:
# Steps represent a sequence of tasks that will be executed as part of the job
steps:
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
- uses: actions/checkout@v2.4.0
- uses: actions/checkout@v3

# Runs a single command using the runners shell
- name: Index
Expand Down
16 changes: 13 additions & 3 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,24 @@ name: Build and Deploy
on:
push:
branches: [ master,develop ]
repository_dispatch:
types:
- toolbox-update-trigger

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2.4.0
- uses: actions/checkout@v3
- name: Install
run: npm install
run: |
npm i
echo "${{ github.workspace }}/node_modules/.bin" >> $GITHUB_PATH
- name: Check
run: |
antora -v
asciidoctor -v
- name: Build
run: npm run build
env:
Expand All @@ -18,7 +28,7 @@ jobs:
ALGOLIA_INDEX_NAME: ${{ secrets.ALGOLIA_INDEX_NAME }}
ALGOLIA_APP_ID: ${{ secrets.ALGOLIA_APP_ID }}
- name: Deploy
uses: JamesIves/[email protected].6
uses: JamesIves/github-pages-deploy-action@v4.4.1
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
BRANCH: gh-pages # The branch the action should deploy to.
Expand Down
35 changes: 35 additions & 0 deletions .github/workflows/manual.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: Manual CI
run-name: "Build ${{ github.ref_name }}"
on: workflow_dispatch

jobs:

activate:
runs-on: ubuntu-latest
if: |
github.repository == 'feelpp/book.feelpp.org' &&
!startsWith(github.event.head_commit.message, 'Release ') &&
!contains(github.event.head_commit.message, 'ci skip')
steps:
- run: echo ok go

build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Install
run: npm install
- name: Build
run: npm run build
env:
GITHUB_OAUTH: ${{ secrets.DOCS_GITHUB_KEY }}
ALGOLIA_API_KEY: ${{ secrets.ALGOLIA_API_KEY }}
ALGOLIA_INDEX_NAME: ${{ secrets.ALGOLIA_INDEX_NAME }}
ALGOLIA_APP_ID: ${{ secrets.ALGOLIA_APP_ID }}
- name: Deploy
uses: JamesIves/[email protected]
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
BRANCH: gh-pages # The branch the action should deploy to.
FOLDER: build/site # The folder the action should deploy.

2 changes: 1 addition & 1 deletion .github/workflows/stale.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ jobs:
pull-requests: write

steps:
- uses: actions/stale@v3
- uses: actions/stale@v6
id: stale
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
Expand Down
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ vendor/
Gemfile.lock
.sass-cache
_site

jupyter/
/math/fem/anafunc.tex
/math/fem/ann-analyse-fonctionnelle.tex
/math/fem/ann-calcul-integrale.tex
Expand Down
15 changes: 7 additions & 8 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,6 @@ have. You can ask a question or signal an issue at the Gitter {feelpp} salon.
https://gitter.im/feelpp/feelpp?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge[
image:https://badges.gitter.im/Join%20Chat.svg[Join the chat at https://gitter.im/feelpp/feelpp]]


== Contribute to this documentation

You can http://docs.feelpp.org/docs/stable/#_how_to_contribute[contribute] to improve this documentation on
Expand Down Expand Up @@ -87,17 +86,17 @@ Once you have installed prerequisites, follow the next steps to generate a local

[source,sh]
----
git clone https://github.com/feelpp/book.feelpp.org.git <1>
git clone https://github.com/feelpp/toolbox.git <2>
cd book.feelpp.org <3>
npm install <4>
./node_modules/@antora/cli/bin/antora --pull site-dev.yml <5>
serve build/site <6>
git clone https://github.com/feelpp/book.feelpp.org.git # <1>
git clone https://github.com/feelpp/toolbox.git # <2>
cd book.feelpp.org # <3>
npm install # <4>
npm run dev # <5>
npm run serve # <6>
----
<1> clone the source for the website
<2> clone the source for toolbox cases doc
<3> go the toplevel directory
<4> install antora and some other dependencies
<5> build a local preview of the website with Antora
<6> start the node.ja webserver `serve`, see the https://docs.antora.org/antora/1.0/run-antora/#local-site-preview[docs].
<6> start the node.js webserver `serve`, see the https://docs.antora.org/antora/1.0/run-antora/#local-site-preview[docs].

2 changes: 1 addition & 1 deletion docs/dev/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@
** Profiling {feelpp}
* xref:tutorial-dev:ROOT:index.adoc[Feel++ Development Tutorial]
* xref:feelpp-project:ROOT:index.adoc[{feelpp} Template Project]
* xref:template_project:ROOT:index.adoc[{feelpp} Template Project]
4 changes: 2 additions & 2 deletions docs/dev/modules/ROOT/pages/08-ComputingIntegrals.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Computing integrals over mesh
-----------------------------

The next step is to compute integrals over the mesh ( See link:../07-quickref/integrals.adoc[this] for detailed methods ).
The next step is to compute integrals over the mesh.

=== Step by step explanations

Expand Down Expand Up @@ -94,7 +94,7 @@ int_{boundary of Omega} 1 = 3.14033
----

Note that we don't get the exact results due to the fact that
[stem]:[\Omega_h = \cup_{K \in \mathcal{T}_h} K] which we use for the numerical integration is different from the exact domain stem:[\Omega = \{ (x,y)\in \mathbb{R}^2 | x^2+y^2 < 1\}].
stem:[\Omega_h = \cup_{K \in \mathcal{T}_h} K] which we use for the numerical integration is different from the exact domain stem:[\Omega = \{ (x,y)\in \mathbb{R}^2 | x^2+y^2 < 1\}].


=== Implementation
Expand Down
1 change: 1 addition & 0 deletions docs/dev/modules/reference/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
** xref:Spaces/README.adoc[Function spaces]
*** xref:Spaces/notations.adoc[Notations]
*** xref:Spaces/functionspace.adoc[FunctionSpace]
*** xref:Spaces/projection.adoc[Projection]
*** xref:Spaces/interpolation.adoc[Interpolation]
*** xref:Spaces/save.adoc[Save]

Expand Down
8 changes: 4 additions & 4 deletions docs/dev/modules/reference/pages/Integrals/integrate.adoc
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
// -*- mode: adoc -*-

=== Integrals
== Integrals


Feel++ provide the integrate() function to define integral expressions
which can be used to compute integrals, define linear and bi-linear
forms.

==== Interface
=== Interface

[source,cpp]
----
Expand Down Expand Up @@ -53,7 +53,7 @@ IMPORTANT: Starting from v0.105, quadratures are built at runtime and no more at
| `GEOMAP_01` | Order 1 approximation (same of the mesh)
|===

==== Example
=== Example

From `doc/manual/tutorial/dar.cpp`

Expand Down Expand Up @@ -107,7 +107,7 @@ From `doc/manual/laplacian/laplacian.cpp`
_expr = nu*gradg*vf::N()*id( v ) );
----

=== Computing my first Integrals
== Computing my first Integrals

This part explains how to integrate on a mesh with Feel++ (source
`doc/manual/tutorial/myintegrals.cpp` ).
Expand Down
6 changes: 3 additions & 3 deletions docs/dev/modules/reference/pages/Integrals/mean.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// -*- mode: adoc -*-

=== Mean value of a function
== Mean value of a function

Let stem:[f] a bounded function on domain stem:[\Omega]. You can evaluate the mean value of a function thanks to the `mean()` function :

Expand All @@ -9,7 +9,7 @@ Let stem:[f] a bounded function on domain stem:[\Omega]. You can evaluate the me
\bar{f}=\frac{1}{|\Omega|}\int_\Omega f=\frac{1}{\int_\Omega 1}\int_\Omega f
++++

==== Interface
=== Interface

[source,cpp]
----
Expand All @@ -30,7 +30,7 @@ Optional parameters:
* `_geomap` = type of geometric mapping.
- Default = `GEOMAP_OPT`

==== Example
=== Example


.Stokes example using `mean`
Expand Down
22 changes: 11 additions & 11 deletions docs/dev/modules/reference/pages/Integrals/norms.adoc
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
// -*- mode: adoc -*-

=== Norms
== Norms

Let stem:[f] a bounded function on domain stem:[\Omega].

==== L^2^ norms
=== L^2^ norms

Let stem:[f \in L^2(\Omega)] you can evaluate the stem:[L^2] norm using the `normL2()` function:

Expand All @@ -13,7 +13,7 @@ Let stem:[f \in L^2(\Omega)] you can evaluate the stem:[L^2] norm using the `nor
\parallel f\parallel_{L^2(\Omega)}=\sqrt{\int_\Omega |f|^2}
++++

===== Interface
==== Interface

[source,cpp]
----
Expand Down Expand Up @@ -43,7 +43,7 @@ Optional parameters:

- Default = `GEOMAP_OPT`

===== Example
==== Example

From `doc/manual/laplacian/laplacian.cpp`

Expand All @@ -58,11 +58,11 @@ From `doc/manual/stokes/stokes.cpp`
.Stokes example using `mean`
[source,cpp]
----
include::../../../../codes/mystokes.cpp[tag=main]
include::example$mystokes.cpp[tag=main]
----


==== H^1 norm
=== H^1 norm

In the same idea, you can evaluate the H1 norm or semi norm, for any function stem:[f \in H^1(\Omega)]:

Expand All @@ -78,7 +78,7 @@ In the same idea, you can evaluate the H1 norm or semi norm, for any function st
where stem:[*] is the scalar product stem:[\cdot] when stem:[f] is a scalar
field and the frobenius scalar product stem:[:] when stem:[f] is a vector field.

===== Interface
==== Interface

[source,cpp]
----
Expand Down Expand Up @@ -112,7 +112,7 @@ Optional parameters:

normH1() returns a float containing the $$H^1$$ norm.

===== Example
==== Example

With expression:

Expand All @@ -137,7 +137,7 @@ With test or trial function `u`
_grad_expr=(gradv(u)-trans(gradg)) );
----

==== stem:[L^\infty] norm
=== stem:[L^\infty] norm

You can evaluate the infinity norm using the normLinf() function:

Expand All @@ -146,7 +146,7 @@ You can evaluate the infinity norm using the normLinf() function:
\parallel f \parallel_\infty=\sup_\Omega(|f|)
++++

===== Interface
==== Interface

[source,cpp]
----
Expand Down Expand Up @@ -178,7 +178,7 @@ returned data structure provides the following interface

* `arg()`: coordinates of the point where the function is maximum

===== Example
==== Example

[source,cpp]
----
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ You can use the usual operations and logical operators.
|`*` |stem:[ f*g]|tensor product
|`/` |stem:[ f/g]|tensor tensor division (stem:[g] scalar field)
|`<` |stem:[ f<g]|element wise less
|`<=` |stem:[ f<=g]|element wise less or equal
|`<=` |stem:[ f\leq g]|element wise less or equal
|`>` |stem:[ f>g]|element wise greater
|`>=` |stem:[ f>=g]|element wise greater or equal
|`>=` |stem:[ f \geq g]|element wise greater or equal
|`==` |stem:[ f==g]|element wise equal
|`!=` |stem:[ f!=g]|element wise not equal
|`!=` |stem:[ f \neq g]|element wise not equal
|`-` |stem:[ -g]|element wise unary minus
|`&&` |stem:[ f] and stem:[g]|element wise logical and
|`\|\|` |stem:[ f] or stem:[g]|element wise logical or
Expand All @@ -30,9 +30,10 @@ Feel++ finit element language use _test_ and _trial_ functions. Keywords are dif

Suppose that stem:[ f \in X_h ] reads

\[
[stem]
++++
f=\sum_{i=0}^{\mathcal{N}} f_i \phi_i
\]
++++

where stem:[ X_h = \mathrm{span}\{ \phi_i, i=1,\ldots,\mathcal{N}\} ]
is a finite element space.
Expand Down Expand Up @@ -60,7 +61,7 @@ is a finite element space.
|`tracev(f)`| stem:[ \mathrm{trace}( f ) ] | trace of matrix field stem:[ f ] | 0 | stem:[ 1 \times 1 ] stem:[ m=p=d ]
|`normal(f)`| stem:[ f \cdot \overrightarrow{N} ] | normal component of test function | rankstem:[(f(\overrightarrow{x}))-1]|
|`normalt(f)`| stem:[ f \cdot \overrightarrow{N} ] | normal component of trial function | rankstem:[(f(\overrightarrow{x}))-1]|
|`normalv(f)`| stem:[ f \cdot \overrightarrow{N} ] | normal component of function stem:[ f ] | rankstem:[(f(\overrightarrow{x}))-1]|
|`normalv(f)`| stem:[ f \cdot \overrightarrow{N} ] | normal component of function stem:[ f ] | rankstem:[(f(\overrightarrow{x}))-1]|
|`dn(f)`| stem:[ \nabla f \cdot \overrightarrow{N} ] | normal derivative of test function |0 |stem:[ 1 \times 1 ] stem:[ m=p=1 ]
|`dn(f)`| stem:[ \nabla f \ \overrightarrow{N} ] | normal derivative of test function |1 |stem:[ m \times 1 ] stem:[p=1 ]
|`dnt(f)`| stem:[ \nabla f \cdot \overrightarrow{N} ] | normal derivative of trial function |0 |stem:[ 1 \times1 ] stem:[m=p=1]
Expand Down
Loading

0 comments on commit 03dee45

Please sign in to comment.