Skip to content

Commit

Permalink
fixes of some typos and remove files in double
Browse files Browse the repository at this point in the history
close #151
  • Loading branch information
thomas-saigre committed Nov 16, 2022
1 parent 5593f0f commit 461646a
Show file tree
Hide file tree
Showing 7 changed files with 48 additions and 353 deletions.
6 changes: 2 additions & 4 deletions docs/user/modules/python/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,16 @@
*** xref:pyfeelpp/discr.adoc[]
*** xref:pyfeelpp/integrals.adoc[Computing integrals]
*** xref:pyfeelpp/filters.adoc[Exporting results for visualisation]
*** xref:pyfeelpp/modelproperties.adoc[Model Properties]
** xref:pyfeelpptoolboxes/index.adoc[{pyfeelpptb}]
*** xref:pyfeelpptoolboxes/modelproperties.adoc[Model Properties]
*** xref:pyfeelpptoolboxes/heat.adoc[Heat Transfer]
*** xref:pyfeelpptoolboxes/electric.adoc[Electrostatic]
*** xref:pyfeelpptoolboxes/fluid.adoc[Fluid Mechanics]
*** xref:pyfeelpptoolboxes/solid.adoc[Solid Mechanics]
** xref:pyfeelppmor/index.adoc[{pyfeelppmor}]
*** xref:pyfeelppmor/parameters.adoc[Parameters]
*** xref:pyfeelppmor/parameterSpace.adoc[Parameter space]
*** xref:pyfeelppmor/parameters.adoc[Parameters]
*** xref:pyfeelppmor/petscDouble.adoc[PETSc vector and matrix]
*** xref:pyfeelppmor/toolboxmor.adoc[Toolbox MOR]
*** xref:pyfeelppmor/reducedbasis.adoc[Python module `reducedbasis`]
**** xref:pyfeelppmor/reducedbasis/reducedbasis.adoc[Offline stage]
**** xref:pyfeelppmor/reducedbasis/reducedbasis.adoc[Online stage]
**** xref:pyfeelppmor/reducedbasis_offline.adoc[Offline stage]
46 changes: 23 additions & 23 deletions docs/user/modules/python/pages/pyfeelpp/filters.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,30 +24,30 @@ app = feelpp.Environment(["myapp"],config=feelpp.localRepository("")) # <1>

[source,python]
----
app.setLogVerbosityLevel(0) # <0>
app.setLogVerbosityLevel(0) # <1>
geofilename=feelpp.download( "github:{repo:feelpp,path:feelpp/quickstart/laplacian/cases/feelpp2d/feelpp2d.geo}", worldComm=app.worldCommPtr() )[0]
mesh = feelpp.load(feelpp.mesh(dim=2,realdim=2), name=geofilename, h=0.1, verbose=1) # <1>
Xh=feelpp.functionSpace(mesh=mesh,space="Pch",order=1) # <2>
P0h=feelpp.functionSpace(mesh=mesh,space="Pdh",order=0) # <3>
u=Xh.element() # <4>
u.on(range=feelpp.elements(mesh), expr=feelpp.expr("sin(2*pi*x)*cos(pi*y):x:y")) # <5>
e = feelpp.exporter(mesh=mesh) # <6>
e.addScalar("a_scalar", 1.) # <7>
e.addP1c("u",u) # <8>
e.addP0d("pid",feelpp.pid( P0h )) # <9>
e.save() # <10>
mesh = feelpp.load(feelpp.mesh(dim=2,realdim=2), name=geofilename, h=0.1, verbose=1) # <2>
Xh=feelpp.functionSpace(mesh=mesh,space="Pch",order=1) # <3>
P0h=feelpp.functionSpace(mesh=mesh,space="Pdh",order=0) # <4>
u=Xh.element() # <5>
u.on(range=feelpp.elements(mesh), expr=feelpp.expr("sin(2*pi*x)*cos(pi*y):x:y")) # <6>
e = feelpp.exporter(mesh=mesh) # <7>
e.addScalar("a_scalar", 1.) # <8>
e.addP1c("u",u) # <9>
e.addP0d("pid",feelpp.pid( P0h )) # <10>
e.save() # <11>
----
<0> The verbosity level is set to 0 (only `VLOG(level)` with `level <= 0` are displayed)
<1> The mesh is loaded from the {uri-github-feelpp} repository
<2> The function space stem:[X_h] is built from the mesh stem:[mesh] and the space stem:[Pch] and order stem:[1]
<3> The function space stem:[P0_h] is built from the mesh stem:[mesh] and the space stem:[Pdh] and order stem:[0]
<4> The element stem:[u] is built from the function space stem:[X_h]
<5> The element stem:[u] is interpolated with the expression stem:[{sin(2*pi*x)*cos(pi*y)}:x:y]
<6> The exporter is built from the mesh stem:[mesh]
<7> The scalar stem:[a_scalar] is added to the exporter stem:[e]
<8> The element stem:[u] is added to the exporter stem:[e]
<9> The element stem:[pid] is added to the exporter stem:[e]
<10> The exporter stem:[e] is saved to the disk
<1> The verbosity level is set to 0 (only `VLOG(level)` with `level <= 0` are displayed)
<2> The mesh is loaded from the {uri-github-feelpp} repository
<3> The function space stem:[X_h] is built from the mesh `mesh` and the space `Pch` and order `1`
<4> The function space stem:[P0_h] is built from the mesh `mesh` and the space `Pdh` and order `0`
<5> The element `u` is built from the function space `Xh`
<6> The element `u` is interpolated with the expression `{sin(2*pi*x)*cos(pi*y)}:x:y`
<7> The exporter is built from the mesh `mesh`
<8> The scalar `a_scalar` is added to the exporter `e`
<9> The element `u` is added to the exporter `e`
<10> The element `pid` is added to the exporter `e`
<11> The exporter `e` is saved to the disk


[%collapsible.result]
Expand All @@ -59,7 +59,7 @@ e.save() # <10>
----
====
The results are stored in the directory `feelppdb`` and can be visualized with {paraview-website} or {ensight}.
The results are stored in the directory `feelppdb` and can be visualized with {paraview-website} or {ensight}.
INFO: The file `exports/ensightgold/myapp/myapp.case` can be opened directly in {paraview} or {ensight} to visualize the mesh and the fields.
Expand Down
2 changes: 1 addition & 1 deletion docs/user/modules/python/pages/pyfeelpp/mesh.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -208,4 +208,4 @@ i1 = [3.24282386], i2 = [149.465], i3 = [0.]
== Next steps

- [x] xref:pyfeelpp/discr.adoc[Manipulate functions and function spaces]
- [x] Export to paraview
- [x] xref:pyfeelpp/filters.adoc[Export to paraview]
148 changes: 0 additions & 148 deletions docs/user/modules/python/pages/pyfeelpp/modelproperties.adoc

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ This part can be run in parallel.
|name of the case
|`generate_basis`

|dim`
|`dim`
|dimension of the case (must be `2` or `3`)
|_mandatory_

Expand All @@ -59,7 +59,6 @@ This part can be run in parallel.
|`False`
|===

WARNING: The time-dependant case it net yet functionnal...


[[Algorithms]]
Expand All @@ -71,15 +70,15 @@ WARNING: The time-dependant case it net yet functionnal...
|===
|Value|Algorithm|Description

|0
|`0`
|From sample
|Generates a basis of size stem:[N=]`train-size` elements, [log-]randomly taken in the space.

|1
|`1`
|Greedy algorithm
|Run the greedy algorithm on a train set of element of size `train-size`. This algorithm also stores the evolution of the maximal error bound at each step.

|2
|`2`
|POD generation
|Takes the largest POD modes from a basis of size `train-size`. The resulting basis will have a size stem:[N\leqslant]`train-size`. This algorithm also stores the evolution of the maximal error bound at each step.

Expand All @@ -96,7 +95,7 @@ Here is a description of the generated files :
- `Qa` : Size of the decomposition of stem:[A(\mu)]
- `Qf` : Size of the decomposition of stem:[F(\mu)]
- `QLk` : Sizes of the decompositions of stem:[L_k(\mu)] for stem:[k\in\{1,n_\text{output}\}], gathers in a list.
- `N_output` : Number pof output described in the JSON (`CRBOutput`)
- `N_output` : Number of output described in the JSON (`CRBOutput`)
- `output_names` : names of those outputs
- `N` : Size of the reduced basis
- `path` : Path where `h5` file is stored
Expand Down Expand Up @@ -128,7 +127,7 @@ config = generateBasisConfig(dim, config_file, time_dependant, odir, case, algo,

The description and the default values of those parameters are descirbed <<parameters,above>>.

If `odir` contains `$name`, this expression will be replaced by the _name_ of the case, defined by concatenation `{case}-np_{nproc}`, where `case` is the name of the case given in the configuration, and `nproc` is the number of processors where the simulation is run.
If `odir` contains `$name`, this expression will be replaced by the _name_ of the case, defined by concatenation `<case>-np_<nproc>`, where `case` is the name of the case given in the configuration, and `nproc` is the number of processors where the simulation is run.


[[files]]
Expand Down
Loading

0 comments on commit 461646a

Please sign in to comment.