Skip to content

Update README.md #42

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Update README.md #42

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
41 changes: 20 additions & 21 deletions examples/solverdummy/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,27 +1,26 @@
# preCICE solverdummy in Fortran

This is an example of a Fortran 2003 solver dummy.

## Building

To build this project, make sure you have already build `precice.mod`.
Then simply run `make`.

Alternatively, build this solver including `precice.mod` and linking to the preCICE library:
# Fortran module for preCICE

This is a Fortran module that uses the [preCICE Fortran bindings](https://precice.org/couple-your-code-api.html) (written in C++) using the `iso_c_binding` intrinsic module.
The build process uses the GNU Fortran compiler (gfortran), which in turn depends on the default GCC version available on your system. You can check which version is being used with:
```shell
gfortran solverdummy.f90 -I../.. -L$(pkg-config --libs libprecice)
gfortran --version
```
If the version is not compatible with your setup, adjust your environment or compiler settings accordingly. Build the module using `make` which executes:
```shell
gfortran -c precice.f90
```

Where `../..` is the path to `precice.mod`.

## Run

You can test the dummy solver by coupling two instances with each other. Open two terminals and run

* `./solverdummy precice-config.xml SolverOne`
* `./solverdummy precice-config.xml SolverTwo`
If the version is not compatible with your setup, adjust your environment or compiler settings accordingly.
```shell
find_package(precice REQUIRED CONFIG)
target_link_libraries(executable_name PRIVATE precice::precice)
```
Replace <executable_name> with the actual name of your target executable. To ensure your executable can locate the preCICE shared library (libprecice.so) at runtime, you need to add the installation path of preCICE to your environment

## Next Steps
# Compilation check
After successful compilation, check if your executable can find the corresponding libprecice.so files by,
```shell
ldd executable_name
````

If you want to couple any other solver against the dummy be sure to adjust the preCICE configuration (participant names, mesh names, data names etc.) to the needs of your solver, compare our [step-by-step guide for new adapters](https://github.com/precice/precice/wiki/Adapter-Example).
This project was moved from the [main preCICE repository](https://github.com/precice/precice). See the [history](https://github.com/precice/precice/tree/d0fafbd912ad6cbf0727299d23e1210570957945/src/precice/bindings/f2003). Previous contributions by @haraldkl, @Krupp, @gatzhamm, @uekerman, @floli, @MakisH, @BenjaminRueth, @RPGP1.
Loading