Feature #489

Create Fortran interface to API.

Added by Remko over 3 years ago. Updated about 3 years ago.

Status:ClosedStart date:2014-01-15
Priority:LowDue date:
Assignee:Remko% Done:

0%

Category:-Estimated time:20.00 hours
Target version:Candidate for next minor release
Platform:

Description

This is a general reminder that we want to work on creating a GMT API interface for Fortran.
I'd probably start with Fortran 90 first. Legacy Fortran 77 can be created later.

Some suggestions of how to work with structures that both C and Fortran can use:
http://www.amath.unc.edu/sysadmin/DOC4.0/fortran/prog_guide/11_cfort.doc.html

Any other GMT users who want to invest time into this are invited to collaborate with the developers.

mGMT-f90.zip (257 KB) Ladislav, 2014-01-23 15:49

History

#1 Updated by Eduardo over 3 years ago

I was studying this some months ago. The problem to me was porting C union to FORTRAN. It seems this is done using EQUIVALENCE (sigh).

http://www.codeproject.com/Articles/3757/Using-UNION-when-porting-a-Fortran-EQUIVALENCE-cod

Here are other links

http://gcc.gnu.org/onlinedocs/gfortran/Interoperability-with-C.html

http://fortranwiki.org/fortran/show/c_interface_module

#2 Updated by Ladislav over 3 years ago

Dear developers,

attached is my contribution to the "GMT API in Fortran" topic. It targets recent Fortran 2003 compilers with the C interoperability support (e.g., GNU, Intel, PGI and also g95, both Linux and Windows) and consists of one Fortran module with enumerations, derived types (structs) and function interfaces corresponding to those in gmt*.h files. It requires some knowledge of interoperability rules on Fortran side, perhaps not so common among traditional Fortran programmers, but paste and copy from attached examples might help. The examples cover (1) a trivial call of GMT API module with data specified as files in module arguments, (2) a call to a GMT API module (psxy) with 2D data in user arrays, (3) the same with GMT_Report calls added, (4) a series of GMT API module calls (xyz2grd, makecpt, psbasemap, grdimage, grdcontour, psscale, ps2raster) with 3D data in user arrays. A feature required by 5th example (gmtmath with struct GMT_MATRIX) seems as not implemented in GMT API yet. All examples are given as (Linux, Windows) shell scripts, C codes and equivalent Fortran codes. Commands needed for compilation and linking are given in headers of source files. Good luck.

A few notes:
- Attached mGMT.f90 implements Fortran interfaces to most of C GMT API functions using Fortran 2003 features. It is a way different from that of 3 GMT API functions (GMT_F77_*) that target Fortran 77 users. mGMT.f90 (when debugged and finished) allows to access the whole C GMT API.
- Attached mGMT.f90 does not implement interfaces for 12 secondary functions for argument and option parsing and 8 GMT_FFT_* functions. Moreover, it is debugged only to the extent to support attached examples; in other parts, there can be typos and other bugs.
- The way how to handle C unions on Fortran side (to the extent that GMT API requires) is extracted to attached pair of codes test-union-c.c and test-union-f.f90.
- I expect that args in GMT_Module_Call is sufficient to be a string only on Fortran side; using linked lists is slightly exotic in Fortran. It would also complicate the Fortran interface: the type of args could not be a comfortable CHARACTER but rather TYPE (c_ptr).
- A similar case are some double arrays (wesn, inc). They should be better declared as array on Fortran side but as such they could not send NULL values to C API. It is my hope GMT developers will give to 0. values in all array elements the same meaning as NULL in array pointer bears. Then, the TYPE (c_ptr) declaration for wesn and inc in mGMT.f90 could be replaced by native REAL (8) arrays.
- Another Fortran-inspired request for GMT developers: names of enum value GMT_DUPLICATE_DATA and function GMT_Duplicate_Data pose a problem to case-insensitive Fortran. In mGMT.f90, the former received a temporary name GMT_DUPLICATE_DATA_ENUM.
- I like simple INTEGER (c_int) for enum types on Fortran side (and default INTEGERs for int literals) instead of rather clumsy declarations INTEGER (KIND (SomeEnumValue)).
- Unsigned ints are not available in any Fortran standard. No problem, a lower half of unsigned extent should have the same math values as signed INTEGERs that are used in mGMT.f90.
- Zero-terminated C strings are a pain in Fortran: (a) when passing Fortran strings to C, an explicit c_null_char has to be appended to strings, (b) when using C strings in some contexts in Fortran, \0 must be cut - especially, when GMT_Call_Module' args are constructed, special GMT names should be specified as filename(1:15).
- Variable argument lists in GMT_Report and GMT_Message are not interoperable. No problem, reported strings can be formatted on Fortran side and sent as a single string. A fixed number of arguments in interfaces of those functions on Fortran side is satisfactory.
- PGI C reports a warning when compiling the examples: PGC-W-0221-Redefinition of symbol SIZE_MAX.
- In z4.c/z4.f90, there is a manifestation of an actual feature/bug of C GMT API - a need of double registration of a GRD file that is used twice. Double registration for a CPT file seems not needed within the example.
- In z5.c, there is an attempt to test a GMT_MATRIX structure. There is apparently working initialization of GMT_MATRIX struct, but a test with the GMP API counterpart of "gmtmath -T Ab.dat LSQFIT =" seems ahead of the game.

L.H.

#3 Updated by Remko over 3 years ago

Thanks, Eduardo and Ladislav, for the inputs so far.
I will carefully examine the code and your suggestions.

#4 Updated by Paul over 3 years ago

  • Status changed from New to Resolved

Just for the record, a separate repository called gmt-fortran has been created. Anyone interested in a Fortran/GMT API may check it out and contribute to the development.

#5 Updated by Paul about 3 years ago

  • Status changed from Resolved to Closed

Given its separate project page I am closing this issue.

Also available in: Atom PDF