diff --git a/content/docs/configuration/basics/configuration-basics.md b/content/docs/configuration/basics/configuration-basics.md index e601abeec15..1c2a5b9d723 100644 --- a/content/docs/configuration/basics/configuration-basics.md +++ b/content/docs/configuration/basics/configuration-basics.md @@ -92,7 +92,7 @@ If a participant uses at least two meshes, you can define a data mapping between `nearest-neighbor` means that the nearest-neighbor mapping method is used to map data from `MyMesh1` to `MyMesh2`. -Read more about the [mapping configuration](configuration-mapping.html). +Read more about the [mapping configuration](configuration-mapping.html), or see the full [configuration reference](configuration-xml-reference.html). ## 4. Communication @@ -104,7 +104,7 @@ If two participants should exchange data, they need a communication channel. ``` -Read more about the [communication configuration](configuration-communication.html). +Read more about the [communication configuration](configuration-communication.html), or see the full [configuration reference](configuration-xml-reference.html). ## 5. Coupling scheme @@ -134,4 +134,4 @@ Both participants need to either `provide` or `receive` the mesh over which data For implicit coupling, i.e. both solver subiterate in every time window until convergence, the configuration looks a bit more complicated. -Read more about the [coupling scheme configuration](configuration-coupling.html). +Read more about the [coupling scheme configuration](configuration-coupling.html), or see the full [configuration reference](configuration-xml-reference.html). diff --git a/content/docs/configuration/basics/configuration-mapping.md b/content/docs/configuration/basics/configuration-mapping.md index 9f8cc43f35b..eaa477c1718 100644 --- a/content/docs/configuration/basics/configuration-mapping.md +++ b/content/docs/configuration/basics/configuration-mapping.md @@ -6,12 +6,12 @@ summary: "When coupling two participants at a common coupling interface, in gene Therefore, preCICE provides data mapping methods to map coupling data from one mesh to the other. On this page, we explain how to configure such data mapping methods." --- -## Basics - {% note %} -The mapping configuration has undergone a major revision between preCICE version 2 and preCICE version 3. For the documentation of version 2, checkout the documentation of [our previous versions](fundamentals-previous-versions.html). +The mapping configuration has undergone a major revision between preCICE version 2 and preCICE version 3. For the documentation of version 2, checkout the documentation of [our previous versions](fundamentals-previous-versions.html). Learn [how to upgrade](couple-your-code-porting-v2-3.html), or see the full [configuration reference](configuration-xml-reference.html). {% endnote %} +## Basics + Each data mapping definition refers to two meshes in the participant configuration: a `provide` mesh defined by the participant and a `receive` mesh defined by another participant (e.g. `MySolver2`): ```xml diff --git a/content/docs/configuration/configuration-overview.md b/content/docs/configuration/configuration-overview.md index 8ce97539dab..ab89fd34931 100644 --- a/content/docs/configuration/configuration-overview.md +++ b/content/docs/configuration/configuration-overview.md @@ -26,13 +26,13 @@ And some optional advanced parts: ## You are already familiar with the preCICE configuration, but you don't remember how a certain option was called? -Then you should look at the [configuration reference](configuration-xml-reference.html). Also try the search here on top. The configuration reference is up to date with the last release of preCICE. If you need an older version, you can always generate this documentation yourself: +Then you should look at the [configuration reference](configuration-xml-reference.html). Also try the search here on top. The configuration reference is up to date with the last release of preCICE. If you need a [previous version](fundamentals-previous-versions.html), you can always generate this documentation yourself: ```bash -./precice-tools md > reference.md +./precice-config-doc md > reference.md ``` -There is also an `xml` variant of the reference. Just call `precice-tools` without arguments to see all options. +There is also an `xml` variant of the reference. Just call `precice-config-doc` without arguments to see all options. ## You want to visualize your configuration file? diff --git a/content/docs/configuration/configuration-xml-reference.md b/content/docs/configuration/configuration-xml-reference.md index 42dfb8f364c..36d158c9b89 100644 --- a/content/docs/configuration/configuration-xml-reference.md +++ b/content/docs/configuration/configuration-xml-reference.md @@ -2,11 +2,12 @@ title: XML reference permalink: configuration-xml-reference.html keywords: configuration, xml, reference -summary: "This side contains the full reference of the XML configuration of preCICE, containing the tag structure as well as attributes and their types and values." +summary: "This side contains the full reference of the XML configuration of the preCICE library, containing the tag structure as well as attributes and their types and values." --- {% warning %} -This page is not for learning how the preCICE configuration works (better start [here](configuration-introduction.html)). It's the right place if you already know what you are looking for. +This page is not for learning how the preCICE configuration works or what good options for a feature are (better look at the [introduction to configuration](configuration-introduction.html)). It's the right place if are looking for specific details and possible options in the library configuration. +For the configuration of adapters, consult the respective adapter documentation. {% endwarning %} {% tip %} Also try the search bar at the top of the website. @@ -15,7 +16,7 @@ Also try the search bar at the top of the website. {{site.data.alerts.note}} You can generate the reference yourself: 
-./precice-tools md > reference.md
+./precice-config-doc md > reference.md
{{site.data.alerts.end}} diff --git a/content/docs/couple-your-code/porting/couple-your-code-porting-v2-3.md b/content/docs/couple-your-code/porting/couple-your-code-porting-v2-3.md index f90abd52a40..e95947bf916 100644 --- a/content/docs/couple-your-code/porting/couple-your-code-porting-v2-3.md +++ b/content/docs/couple-your-code/porting/couple-your-code-porting-v2-3.md @@ -211,6 +211,8 @@ error: ‘class precice::Participant’ has no member named ‘initializeData’ ## preCICE configuration file +See the [tutorials](tutorials.html) for some examples, and the [configuration reference](configuration-xml-reference.html) for more details. + - The XML tag `` was removed and all underlying functionality was moved to the `` tag. Remove the lines including `` and ``, and move any attributes (such as `experimental`) from the `solver-interface` to the `precice-configuration` tag. Move the `sync-mode` attribute to the new `` tag (see below). - The `dimensions` configuration is now defined per mesh. Move the `dimensions="2"` or `dimensions="3"` from the `` tag to each `` tag: ``. - Rename the `` attributes `from` -> `acceptor` and `to` -> `connector`. diff --git a/content/docs/tooling/tooling-builtin.md b/content/docs/tooling/tooling-builtin.md index 551ea5ff978..036cd76a3f0 100644 --- a/content/docs/tooling/tooling-builtin.md +++ b/content/docs/tooling/tooling-builtin.md @@ -5,17 +5,19 @@ keywords: tooling, xml, configuration, version summary: "Built-in tooling is always installed alongside preCICE and provides some basic functionality." --- -Part of a preCICE installation is the tool `precice-tools`. +Part of a preCICE installation is the tool `precice-tools` (deprecated and replaced by the [`precice-cli`](https://github.com/precice/cli) and other tools). It provides an easy-to-use interface to tooling API of the preCICE library. With `precice-tools`, you can get the installed preCICE version, generate a reference of all available configuration options, as well as check your configuration file for basic configuration issues. ## XML reference +For generating the XML reference, we can use `precice-config-doc` (or the deprecated `precice-tools`, with the same options): + ```bash -precice-tools md -precice-tools xml -precice-tools dtd +precice-config-doc md +precice-config-doc xml +precice-config-doc dtd ``` This prints the XML reference to the console in various flavors. @@ -29,7 +31,7 @@ It is possible to generate a local version of the reference by rendering the Mar Be aware that this version does not contain styling, LaTeX rendering, and functioning links. ```bash -precice-tools md | markdown > reference.html +precice-config-doc md | markdown > reference.html ``` ### `xml`