Skip to content

Commit d5c3d4d

Browse files
scivisionscivision
committed
doc
1 parent d0017be commit d5c3d4d

15 files changed

+568
-0
lines changed

‎.github/CODE_OF_CONDUCT.md

+76
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at [email protected]. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72+
73+
[homepage]: https://www.contributor-covenant.org
74+
75+
For answers to common questions about this code of conduct, see
76+
https://www.contributor-covenant.org/faq

‎.github/FUNDING.yml

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# These are supported funding model platforms
2+
3+
github: [scivision]
4+
ko_fi: scivision

‎.github/workflows/ci_cmake.yml

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: ci_cmake
2+
3+
on:
4+
push:
5+
paths:
6+
- "**.f90"
7+
- "**.F90"
8+
- "**.cmake"
9+
- "**/CMakeLists.txt"
10+
- ".github/workflows/ci_cmake.yml"
11+
12+
jobs:
13+
14+
linux:
15+
runs-on: ubuntu-latest
16+
steps:
17+
- uses: actions/checkout@v2
18+
- uses: actions/setup-python@v2
19+
with:
20+
python-version: '3.x'
21+
22+
- run: ctest -S setup.cmake -VV
23+
env:
24+
FC: gfortran-9
25+
CC: gcc-9
26+
CXX: g++-9
27+
28+
macos:
29+
runs-on: macos-latest
30+
steps:
31+
- uses: actions/checkout@v2
32+
33+
- run: ctest -S setup.cmake -VV
34+
env:
35+
FC: gfortran-9
36+
CC: gcc-9
37+
CXX: g++-9
38+
39+
windows:
40+
runs-on: windows-latest
41+
steps:
42+
- uses: actions/checkout@v2
43+
44+
- run: ctest -S setup.cmake -VV

‎.github/workflows/ci_meson.yml

+95
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
name: ci_meson
2+
3+
on:
4+
push:
5+
paths:
6+
- "**/meson.build"
7+
- .github/workflows/ci_meson.yml
8+
9+
jobs:
10+
11+
linux:
12+
runs-on: ubuntu-latest
13+
steps:
14+
- uses: actions/checkout@v2
15+
- uses: actions/setup-python@v2
16+
with:
17+
python-version: '3.x'
18+
19+
- run: pip install meson ninja
20+
21+
- run: meson setup build
22+
env:
23+
FC: gfortran-9
24+
CC: gcc-9
25+
CXX: g++-9
26+
27+
- run: meson compile -C build
28+
- uses: actions/upload-artifact@v1
29+
if: failure()
30+
with:
31+
name: Linux_Meson_Configlog
32+
path: build/meson-logs/meson-log.txt
33+
34+
- run: meson test -C build -v
35+
- uses: actions/upload-artifact@v1
36+
if: failure()
37+
with:
38+
name: Linux_Meson_Testlog
39+
path: build/meson-logs/testlog.txt
40+
41+
macos:
42+
runs-on: macos-latest
43+
steps:
44+
- uses: actions/checkout@v2
45+
- uses: actions/setup-python@v2
46+
with:
47+
python-version: '3.x'
48+
49+
- run: pip install meson ninja
50+
51+
- run: meson setup build
52+
env:
53+
FC: gfortran-9
54+
CC: gcc-9
55+
CXX: g++-9
56+
57+
- run: meson compile -C build
58+
- uses: actions/upload-artifact@v1
59+
if: failure()
60+
with:
61+
name: Mac_Meson_Configlog
62+
path: build/meson-logs/meson-log.txt
63+
64+
- run: meson test -C build -v
65+
- uses: actions/upload-artifact@v1
66+
if: failure()
67+
with:
68+
name: MacOS_Meson_Testlog
69+
path: build/meson-logs/testlog.txt
70+
71+
windows:
72+
runs-on: windows-latest
73+
steps:
74+
- uses: actions/checkout@v2
75+
- uses: actions/setup-python@v2
76+
with:
77+
python-version: '3.x'
78+
79+
- run: pip install meson ninja
80+
81+
- run: meson setup build
82+
83+
- run: meson compile -C build
84+
- uses: actions/upload-artifact@v1
85+
if: failure()
86+
with:
87+
name: Windows_Meson_Configlog
88+
path: build/meson-logs/meson-log.txt
89+
90+
- run: meson test -C build -v
91+
- uses: actions/upload-artifact@v1
92+
if: failure()
93+
with:
94+
name: Windows_Meson_Testlog
95+
path: build/meson-logs/testlog.txt

‎.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
build/*
2+
13
# Prerequisites
24
*.d
35

‎CMakeLists.txt

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
cmake_minimum_required(VERSION 3.15)
2+
project(Fortran_C_CXX_interface
3+
LANGUAGES C Fortran CXX)
4+
enable_testing()
5+
6+
# Demonstrate linking of
7+
# * C++ calling Fortran
8+
# * Fortran calling C++
9+
# * Fortran calling C
10+
11+
# https://stackoverflow.com/tags/fortran-iso-c-binding/info
12+
13+
add_library(c_lib call_c.c)
14+
target_compile_features(c_lib PRIVATE c_std_99)
15+
16+
add_executable(f_call_c f_call_c.f90)
17+
target_link_libraries(f_call_c PRIVATE c_lib)
18+
add_test(NAME FortranCallC COMMAND f_call_c)
19+
20+
# -- C++ calling Fortran
21+
add_library(call_f OBJECT c_call_f.f90)
22+
23+
add_executable(cxx_call_f cxx_call_f.cxx)
24+
target_link_libraries(cxx_call_f PRIVATE call_f)
25+
target_compile_features(cxx_call_f PRIVATE cxx_std_11)
26+
add_test(NAME CXXCallFortran COMMAND cxx_call_f)
27+
28+
# -- Fortran calling C++
29+
add_library(cxx_lib OBJECT call_cxx.cxx)
30+
target_compile_features(cxx_lib PRIVATE cxx_std_11)
31+
32+
add_executable(f_call_cxx f_call_cxx.f90)
33+
target_link_libraries(f_call_cxx PRIVATE cxx_lib)
34+
# LINKER_LANGUAGE option is necessary for ifort at least
35+
set_target_properties(f_call_cxx PROPERTIES LINKER_LANGUAGE Fortran)
36+
add_test(NAME FortranCallC++ COMMAND f_call_cxx)

‎README.md

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Call Fortran from C++
2+
3+
![Actions Status](https://github.com/scivision/fortran-c-cpp-interface/workflows/ci_cmake/badge.svg)
4+
![Actions Status](https://github.com/scivision/fortran-c-cpp-interface/workflows/ci_meson/badge.svg)
5+
6+
Fortran subroutines and functions are easily called from C and C++.
7+
8+
Use the standard C binding to define variable and bind functions/subroutines.
9+
10+
## build
11+
12+
```sh
13+
ctest -S setup.cmake -VV
14+
```
15+
16+
## Example
17+
18+
```fortran
19+
module flibs
20+
21+
use,intrinsic:: iso_c_binding, only: c_int, c_float, c_double
22+
23+
implicit none
24+
25+
subroutine cool(X,N) bind(c)
26+
27+
real(c_double), intent(inout) :: X
28+
integer(c_int), intent(in) :: N
29+
30+
...
31+
32+
end subroutine cool
33+
```
34+
35+
`bind(c)` makes the name `cool` available to C/C++.
36+
In general, strongly avoid the FortranCInterface of CMake and mangling function names--just use Fortran 2003 standard `bind(C)`

‎c_call_f.f90

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
module mytest
2+
3+
use, intrinsic:: iso_c_binding, only: dp=>c_double, c_int
4+
5+
implicit none (type, external)
6+
7+
contains
8+
9+
pure subroutine timestwo(z,z2,N) bind(c)
10+
! elemental is not allowed with BIND(C)
11+
12+
integer(c_int), intent(in) :: N
13+
real(dp),intent(in) :: z(N)
14+
real(dp),intent(out) :: z2(N)
15+
16+
z2 = 2*z
17+
18+
end subroutine timestwo
19+
20+
end module mytest

‎call_c.c

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
void timestwo(double x[], double x2[], int N){
2+
for (int i=0; i<N; i++)
3+
x2[i] = x[i] * 2;
4+
}

‎call_cxx.cxx

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
// NOTE: extern "C" is necessary to get the function name in the library to be "timestwo"
2+
// as seen by
3+
// nm libcxx.a
4+
// or whatever you name this library file.
5+
6+
extern "C" void timestwo(double x[], double x2[], int N){
7+
for (auto i=0; i<N; i++)
8+
x2[i] = x[i] * 2;
9+
}

‎cxx_call_f.cxx

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
#include <iostream>
2+
#include <vector>
3+
4+
extern "C" void timestwo(double [],double [],int*);
5+
6+
7+
int main()
8+
{
9+
auto N = 3;
10+
std::vector<double> x(N);
11+
std::vector<double> x2(N);
12+
13+
for (auto i = 0; i < x.size(); i++)
14+
x[i] = i;
15+
16+
timestwo(&x.front(), &x2.front(), &N);
17+
18+
for (auto i: x2)
19+
std::cout << i << ' ';
20+
21+
return EXIT_SUCCESS;
22+
}

‎f_call_c.f90

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
program call_c
2+
!! Demonstrate Fortran calling C.
3+
!!
4+
!! Normally BIND(C) should be used after the function name in the interface block,
5+
!! rather than postpending underscore(s).
6+
7+
use, intrinsic :: iso_c_binding, only: dp=>c_double, c_int
8+
implicit none (type, external)
9+
10+
11+
interface
12+
13+
subroutine timestwo(x, x2, N) bind (c)
14+
import c_int, dp
15+
integer(c_int), value :: N
16+
real(dp) :: x(N), x2(N)
17+
end subroutine timestwo
18+
19+
end interface
20+
21+
integer(c_int) :: N, i
22+
real(dp), allocatable :: x(:), x2(:)
23+
24+
N = 3
25+
26+
allocate(x(N), x2(N))
27+
28+
!! dummy data
29+
do i=1,N
30+
x(i) = i
31+
enddo
32+
33+
call timestwo(x, x2, N)
34+
35+
if (any(2*x /= x2)) error stop 'x2 /= 2*x'
36+
37+
end program

0 commit comments

Comments
 (0)