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.

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

Fix various typos #187

Merged
merged 1 commit into from
Jul 27, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ You can now view website locally in your browser at [localhost:4000](http://loca

## Update submodules

Submodules do not yet get updated automatically. This means if you change something in the OpenFOAM adapter documentation or the description of the tutorials, you need to explicitely trigger an update here:
Submodules do not yet get updated automatically. This means if you change something in the OpenFOAM adapter documentation or the description of the tutorials, you need to explicitly trigger an update here:

```bash
git submodule update --remote --merge
Expand All @@ -33,7 +33,7 @@ Do not directly edit the content of the submodules from within the website repos

## Further information

If you would like to learn more about the preCICE documentation, a good start are the [documention of the documentation pages](https://precice.org/docs-meta-overview.html).
If you would like to learn more about the preCICE documentation, a good start are the [documentation of the documentation pages](https://precice.org/docs-meta-overview.html).

## Common issues while building the site

Expand Down
2 changes: 1 addition & 1 deletion _includes/xmlreference.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ Surface mesh consisting of vertices and (optional) of edges and triangles (only
| Attribute | Type | Description | Default | Options |
| --- | --- | --- | --- | --- |
| name | string | Unique name for the mesh. | _none_ | none |
| flip-normals | boolean | Deprectated. | `0` | none |
| flip-normals | boolean | Deprecated. | `0` | none |
Copy link
Member

Choose a reason for hiding this comment

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

That's a typo in the main repo, as the xmlreference is autogenerated by preCICE.

Copy link
Member

Choose a reason for hiding this comment

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

Ah, I missed that. Here, it does not matter, as it will get updated anyway by the next submodule update. Feel free to update in preCICE.


**Valid Subtags:**

Expand Down
2 changes: 1 addition & 1 deletion collections/_testimonials/01-CIRA.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@ img: testimonial-cira.jpg
---
The project FLEXCFD aims to upgrade our in-house developed aerodynamic solver in order to simulate unsteady configurations with flexible surfaces in relative motion.
Our main objective is to simulate dynamic fluid-structure interaction, with fluid and structural solvers synchronized by a partitioned approach.
We foresee aeronautic applications, such as flexible aircrafts and rotorcrafts.
We foresee aeronautic applications, such as flexible aircraft and rotorcraft.
We choose preCICE for several reasons: the open source environment, availability of non-linear structural dynamics, the possibility to test both explicit and implicit coupling, and the numerous already implemented interpolation and exchange methods for forces and deformations.
[Learn more](https://www.researchgate.net/publication/333651661_Framework_for_Fluid-Structure_Interaction_Simulations_with_UZEN_and_PreCICE_Simulations_procedure_and_Validation)
2 changes: 1 addition & 1 deletion collections/_testimonials/02-Siegen.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,5 @@ In a second project, a structural solver based on deal.
II was coupled with an OpenFOAM solver, capable of handling dynamic mesh movement for FSI simulations.
preCICE offers sophisticated post-processing methods, which considerably improved the convergence and stability of our implicitly coupled system.
Additionally, the capability of peer-to-peer communication in case of parallel simulations was a reason to choose preCICE.
From our point of view, preCICE proved to be a very promising and efficient coupling strategy supported by a commited community of users and a dedicated developer team.
From our point of view, preCICE proved to be a very promising and efficient coupling strategy supported by a committed community of users and a dedicated developer team.
For the future, we would like to further improve our self-written adapters as well as test and integrate available adapters.
2 changes: 1 addition & 1 deletion collections/_testimonials/18-precice-mbdyn.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,5 @@ organisation: "Department of Aerospace Science and Technology (DAER), Politecnic
organisation_link: https://www.aero.polimi.it/
img: testimonial-precice-mbdyn.png
---
When fluid-structure interaction involves slender or flat structures, it is interesting to apply reduced dimensionalty models (e.g. shells, or beams) to perform such computations. We coupled [MBDyn](www.mbdyn.org) (an open source multibody dynamics software developed at Politecnico of Milan) to preCICE within a master thesis project, exploiting the C++ interface provided by MBDyn. We validated the set-up in the incompressible regime coupling MBDyn and OpenFOAM and comparing our results with the well-known Turek & Hron bechmarks, which proved to be challenging because of added mass instability issues. Some preliminary results can be found in the [thesis](http://hdl.handle.net/10589/175517), while an extensive validation has been described [in a conference paper](https://www.researchgate.net/publication/352642167_COUPLING_MULTI-BODY_AND_FLUID_DYNAMICS_ANALYSIS_WITH_PRECICE_AND_MBDYN).
When fluid-structure interaction involves slender or flat structures, it is interesting to apply reduced dimensionalty models (e.g. shells, or beams) to perform such computations. We coupled [MBDyn](www.mbdyn.org) (an open source multibody dynamics software developed at Politecnico of Milan) to preCICE within a master thesis project, exploiting the C++ interface provided by MBDyn. We validated the set-up in the incompressible regime coupling MBDyn and OpenFOAM and comparing our results with the well-known Turek & Hron benchmarks, which proved to be challenging because of added mass instability issues. Some preliminary results can be found in the [thesis](http://hdl.handle.net/10589/175517), while an extensive validation has been described [in a conference paper](https://www.researchgate.net/publication/352642167_COUPLING_MULTI-BODY_AND_FLUID_DYNAMICS_ANALYSIS_WITH_PRECICE_AND_MBDYN).
[Learn more](https://public.gitlab.polimi.it/DAER/mbdyn/-/wikis/preCICE-MBDyn-adapter)
2 changes: 1 addition & 1 deletion pages/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ For the full list of contributors to preCICE please see our [community page](com
<li{% if forloop.first %} class="devlist-first"{% endif %}>
<div class="devlist-img">
{% if p.img %}
<img src="images/developer/{{ p.img }}.jpg" alt="Portait">
<img src="images/developer/{{ p.img }}.jpg" alt="Portrait">
{% endif %}
</div>
<div class="devlist-left">
Expand Down
2 changes: 1 addition & 1 deletion pages/community/community-contribute-to-precice.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ Your case may already fit into one of the existing tutorials. If not, feel free
- In the `README.md` file, document the scenario setup, the dependencies, how to run it, how to visualize the results, and an example picture or video of the results. Follow the general structure in the existing tutorials. Don't forget to adapt the `permalink:` field in the beginning of the file.
- The run scripts (`run.sh`) should be very short. You can probably reuse some of the scripts we already provide.
- For the `clean.sh` script, you can use the functions provided in `tools/cleaning-tools.sh`
- If there is already a `precice-config.xml` for the case you are simulating, please use the same one (or contribute changes to that). We want that all solvers that can simulate a given case use the same preCICE configuation file.
- If there is already a `precice-config.xml` for the case you are simulating, please use the same one (or contribute changes to that). We want that all solvers that can simulate a given case use the same preCICE configuration file.

### Naming conventions

Expand Down
4 changes: 2 additions & 2 deletions pages/community/precice-workshop-2021.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ The workshop stretches from Monday noon to Thursday evening.

<details class="workshop-event" id="Enders"><summary>A. Enders‐Seidlitz: Development of a python‐based crystal growth simulation framework</summary>
<p>Authors: <a>A. Enders‐Seidlitz</a>, J. Pal, K. Dadzis<br/></p>
<p>The NEMOCRYS project in the group “Model experiments” at the IKZ develops an open‐source‐based framework for coupled multiphysics simulation in crystal growth. Currently, Gmsh for FEM mesh generation and Elmer to solve the heat transfer problem including inductive heating are applied. These tools are wrapped in an easy‐to‐use python interface that allows for highly‐ parameterized models and enables automatized large‐scale studies. A major challenge in the present implementation is the coupling between Elmer and Gmsh: The transient simulation involves moving boundaries and requires mesh updates. In future, an additional coupling to OpenFOAM will be needed to consider the fluid dynamics of the liquid and gas phase. This requires transient bi‐directional multiscale coupling in 2D and 3D both on surfaces and in volumes. We consider preCICE a promising library to meet this challenge and would like to discuss the need for further adapters and coupling algorithms. </p>
<p>The NEMOCRYS project in the group “Model experiments” at the IKZ develops an open‐source‐based framework for coupled multiphysics simulation in crystal growth. Currently, Gmsh for FEM mesh generation and Elmer to solve the heat transfer problem including inductive heating are applied. These tools are wrapped in an easy‐to‐use python interface that allows for highly‐ parameterized models and enables automated large‐scale studies. A major challenge in the present implementation is the coupling between Elmer and Gmsh: The transient simulation involves moving boundaries and requires mesh updates. In future, an additional coupling to OpenFOAM will be needed to consider the fluid dynamics of the liquid and gas phase. This requires transient bi‐directional multiscale coupling in 2D and 3D both on surfaces and in volumes. We consider preCICE a promising library to meet this challenge and would like to discuss the need for further adapters and coupling algorithms. </p>
</details>

<details class="workshop-event" id="Heck"><summary>Ulrich Heck: Transfer of FSI coupling with preCICE, OpenFOAM and CalculiX to industrial applications‐Status and plans</summary>
Expand Down Expand Up @@ -108,7 +108,7 @@ The workshop stretches from Monday noon to Thursday evening.

<details class="workshop-event" id="Totounferoush"><summary>Amin Totounferoush: Two Step Parallel Communication Initialization for preCICE</summary>
<p>Authors: <a>Amin Totounferoush</a>, Benjamin Uekermann, Miriam Mehl<br/></p>
<p>This talk provides an overview of the current initialization method in preCICE, and introduces the new two step initilization method. The two step initialization provides a significant performance increase.</p>
<p>This talk provides an overview of the current initialization method in preCICE, and introduces the new two step initialization method. The two step initialization provides a significant performance increase.</p>
</details>

<details class="workshop-event" id="Davis"><summary>Kyle Davis: Data Mapping in preCICE</summary>
Expand Down
4 changes: 2 additions & 2 deletions pages/docs/adapters/adapter-code_aster.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ code_aster and the bundled dependencies will now be built. This can take a while

After the installation is done, check that all dependencies have been installed correctly. If a dependency was not installed correctly, go through the log file, and try to run the installation again. Alternatively, install the dependency manually and specify its path in `setup.cfg`. In this case, make sure that the required version of the tool is installed.

![Terminal output for a successfull installation](images/docs/adapter-codeaster-success.png)
![Terminal output for a successful installation](images/docs/adapter-codeaster-success.png)

Once the solver has been installed successfully, add the following line to the bashrc (run `gedit ~/.bashrc`) and start a new session:

Expand Down Expand Up @@ -157,7 +157,7 @@ See the respective [issue](https://github.com/precice/code_aster-adapter/issues/

There are two methods to visualize the results for Code_Aster:

1. [Salome-Meca](https://www.code-aster.org/spip.php?article303) is a intergated graphical interface, which also offers a post-processing unit called ParaViS (based on ParaView). The nice thing about ParaViS, is that it can open both the results of OpenFOAM and Code-Aster at the same time. Please make sure to have salome-meca 2018 or newer, as the med files are not compatible with older versions. Before installing Salome-Meca, please make sure that the environment on your system uses Python 2.7 (see the respective [Salome-Meca issue](https://code-aster.org/forum2/viewtopic.php?id=23294)).
1. [Salome-Meca](https://www.code-aster.org/spip.php?article303) is an integated graphical interface, which also offers a post-processing unit called ParaViS (based on ParaView). The nice thing about ParaViS, is that it can open both the results of OpenFOAM and Code-Aster at the same time. Please make sure to have salome-meca 2018 or newer, as the med files are not compatible with older versions. Before installing Salome-Meca, please make sure that the environment on your system uses Python 2.7 (see the respective [Salome-Meca issue](https://code-aster.org/forum2/viewtopic.php?id=23294)).

2. [GMSH](http://gmsh.info/) is a stand-alone visualization tool that can open files of med format. Please make sure to get a version that is compatible with med 4.0 (GMSH 4.5 is known to work).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ We started offering Debian packages for the CalculiX adapter since v2.19.0. Plea

### Building the adapter with PaStiX

Since version 2.17 of CalculiX, it is possible to link the PaStiX solver for increased performance, mostly through GPUs. Building the adapter with PaStiX is quite tedious, as most dependencies of PaStiX and PaStiX itslef must be built from source. Check our [detailed instructions on building the adapter with PaStiX](adapter-calculix-pastix-build.html).
Since version 2.17 of CalculiX, it is possible to link the PaStiX solver for increased performance, mostly through GPUs. Building the adapter with PaStiX is quite tedious, as most dependencies of PaStiX and PaStiX itself must be built from source. Check our [detailed instructions on building the adapter with PaStiX](adapter-calculix-pastix-build.html).

### Makefile options

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ You can get these elsewhere or build them from source. In particular, it is prob

## Downloading CalculiX source

This guide assumes Calculix's source code is in the user's home folder `/home/user_name`, with the alias `~`. If you don't want to follow this convention, you may have to adapt slightly the instructions below. Donwload can be done on command line:
This guide assumes Calculix's source code is in the user's home folder `/home/user_name`, with the alias `~`. If you don't want to follow this convention, you may have to adapt slightly the instructions below. Download can be done on command line:

```bash
cd ~ && wget http://www.dhondt.de/ccx_2.17.src.tar.bz2
Expand Down
2 changes: 1 addition & 1 deletion pages/docs/adapters/calculix/adapter-calculix-supermuc.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ summary: "This page explains how to build the CalculiX adapter on SuperMUC. Even
This page needs updates for preCICE v2.
{% endwarning %}

In order to install CalculiX and the adapter on superMUC, a number of depencies are first required. Initially, [preCICE must be installed](installation-overview.html)
In order to install CalculiX and the adapter on superMUC, a number of dependencies are first required. Initially, [preCICE must be installed](installation-overview.html)

Additionally, [SPOOLES](http://www.netlib.org/linalg/spooles/spooles.2.2.html), [ARPACK](https://www.caam.rice.edu/software/ARPACK/) and [yaml-cpp](https://github.com/jbeder/yaml-cpp) are required.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ keywords: adapter, calculix, error
summary: "While working with the CalculiX adapter, you may run onto common issues. This is a collection of what we know could go wrong."
---

This list is definietly not complete. If after reading this, you still have issues, please [ask in the preCICE forum](https://precice.discourse.group/).
This list is definitely not complete. If after reading this, you still have issues, please [ask in the preCICE forum](https://precice.discourse.group/).

## Things to check

Expand Down
2 changes: 1 addition & 1 deletion pages/docs/adapters/deal.II/adapter-dealii-configure.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ end

This subsection configures the numerical discretization: The polynomial degree is associated to the degree of the applied shape functions.
Theta is related to the time integration scheme of the linear solver, which is a one-step-theta method. Accordingly, its value can be chosen between 0 and 1, where 0 denotes an explicit forward Euler method and 1 denotes an implicit backward Euler method with each having first order accuracy. It is recommended to use theta to 0.5, which results in a second order accurate and energy-conserving Crank-Nicolson scheme. If you prefer dissipative behavior, you need to choose theta greater than 0.5. Have a look in the [Solver details](adapter-dealii-solver-details.html) for more information.
The non-linear solver uses, however, an implicit [Newmark scheme](https://en.wikipedia.org/wiki/Newmark-beta_method), which allows a configuration using the paramters beta and gamma.
The non-linear solver uses, however, an implicit [Newmark scheme](https://en.wikipedia.org/wiki/Newmark-beta_method), which allows a configuration using the parameters beta and gamma.

```text
subsection System properties
Expand Down
2 changes: 1 addition & 1 deletion pages/docs/adapters/deal.II/adapter-dealii-get.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ Have a look at our [preCICE installation guide](installation-overview.html).

If you have deal.II and preCICE globally installed in your system and want to run a tutorial, building the adapter is as simple as `cmake . && make`:

1. Clone the repository and naviagte to the top-level directory
1. Clone the repository and navigate to the top-level directory

```bash
git clone https://github.com/precice/dealii-adapter.git && cd dealii-adapter
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ $$
\end{aligned}
$$

Here, a block notation for the global vectors and matrices is used, where M denotes the mass matrix, K the stiffness matrix, D the displacement vector, V the velocity vector, and F the load vector, which includes body loads and the prescribed traction. Note that the load vetor F is due to the coupling time dependent. Time derivatives are approximated using a one-step theta method
Here, a block notation for the global vectors and matrices is used, where M denotes the mass matrix, K the stiffness matrix, D the displacement vector, V the velocity vector, and F the load vector, which includes body loads and the prescribed traction. Note that the load vector F is due to the coupling time dependent. Time derivatives are approximated using a one-step theta method

$$
\begin{aligned}\tag{2.2}
Expand Down
2 changes: 1 addition & 1 deletion pages/docs/configuration/configuration-communication.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ The most common case being participants distributed over multiple hosts aka runn
This may also be the case if you use participants in isolated Docker containers or if your system doesn't provide a loopback interface.

To manually specify a network interface use the `network="..."` attribute.
Common interface on clusters are the local ethernet `"eth0"` or the infiniband sytem `"ib0"`.
Common interface on clusters are the local ethernet `"eth0"` or the infiniband system `"ib0"`.

```xml
<m2n:sockets from="MySolver1" to="MySolver2" network="ib0" />
Expand Down
2 changes: 1 addition & 1 deletion pages/docs/configuration/configuration-export.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ def loadParallelCSV(name):
def loadParallelCSVSeries(name)
import re, glob, pandas
l = [(re.search("dt(\d+)_", s).group(1), s) for s in glob.glob(f"{name}.dt*_*.csv")]
retrun pandas.concat([pandas.read_csv(file, sep=";").assign(dt=dt) for dt, file in l], ignore_index=True)
return pandas.concat([pandas.read_csv(file, sep=";").assign(dt=dt) for dt, file in l], ignore_index=True)

pointData = loadParallelCSV("A-ExporterTwo.dt1")
pointDataSeries = loadParallelCSVSeries("A-ExporterTwo")
Expand Down
4 changes: 2 additions & 2 deletions pages/docs/configuration/configuration-logging.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Each sink has these attributes:
* `filter` is a boost.log [filter string](http://www.boost.org/doc/libs/release/libs/log/doc/html/log/detailed/utilities.html#log.detailed.utilities.setup.filter_formatter). The default filter string is `%Severity% > debug`
* `enabled` is a boolean value. It can be one of `0, 1, yes, no, true, false` Note that if all sinks are disabled, the default sink is used. Use `<log enabled="false">` to completely disable logging.

The `<log>` tag is optional. If it is ommitted, default values are used.
The `<log>` tag is optional. If it is omitted, default values are used.
`type` and `output` are mandatory, all others attributes are optional.

## log.conf
Expand All @@ -56,7 +56,7 @@ Type = file
output = precice.log
```

The `[SectionHeaders]` are just for distingushing the sections, the names are not used.
The `[SectionHeaders]` are just for distinguishing the sections, the names are not used.

## Attributes

Expand Down
Loading