Skip to content
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
Original file line number Diff line number Diff line change
Expand Up @@ -205,6 +205,10 @@ Look for [contributing guidelines](https://github.com/precice/precice/blob/devel
Read on our [Roadmap](fundamentals-roadmap.html) what is already in our to-do list before starting to write large parts of code.
{% endtip %}

{% tip %}
There are [guidelines for adapters](community-guidelines-adapters.html) and [guidelines for application cases](community-guidelines-application-cases.html).
{% endtip %}

## Helping other users

We would really appreciate it if you followed our [community channels](community-channels.html) and joined us in answering questions.
Expand Down
4 changes: 4 additions & 0 deletions content/docs/couple-your-code/couple-your-code-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@ There is a [step-by-step guide](couple-your-code-preparing-your-solver.html), wh

There is a list of advanced topics. These topics are not all relevant to every user. They deal with specific problems for certain types of codes: how to handle FEM meshes, how to handle moving meshes, etc.

## What best practices should I follow?

There are standardized [guidelines for adapters](community-guidelines-adapters.html) and [guidelines for application cases](https://precice.org/community-guidelines-application-cases.html).

## You want to port your adapter to a newer preCICE version?

There are specific pages on [porting adapters from preCICE between major versions](couple-your-code-porting-overview.html).
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,11 @@ summary: "This guide helps you to upgrade from preCICE 1.x to preCICE 2.x."
redirect_from: couple-your-code-porting-adapters.html
---

{% tip %}
Reviving that old adapter? Good opportunity to learn about some best practices and make it easier to reuse and maintain!
There are [guidelines for adapters](community-guidelines-adapters.html) and [guidelines for application cases](community-guidelines-application-cases.html).
{% endtip %}

## preCICE API

### Single-step setup
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,11 @@ Missing:
#1352
-->

{% tip %}
Reviving that old adapter? Good opportunity to learn about some best practices and make it easier to reuse and maintain!
There are [guidelines for adapters](community-guidelines-adapters.html) and [guidelines for application cases](community-guidelines-application-cases.html).
{% endtip %}

## preCICE API

The following is a diff of how an adapter-port could look like. The guide continues underneath the code.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,10 @@ In the following steps, we will slowly add more and more calls to the preCICE AP
Also have a look at the [definite C++ API documentation](https://precice.org/doxygen/main/classprecice_1_1Participant.html).
{% endtip %}

{% tip %}
Looking for best practices? There are [guidelines for adapters](community-guidelines-adapters.html) and [guidelines for application cases](community-guidelines-application-cases.html).
{% endtip %}

{% note %}
This example refers to preCICE v3.x: [see the differences from preCICE v2.x](couple-your-code-porting-v2-3.html).
{% endnote %}