YetAnotherCoupler  2.4.1
Interface Overview

The coupling and associated tasks can be grouped into four different phases, the initialisation and definition phase; the neighbourhood search and calculation of interpolation weights; the data exchange; and the finalisation of the coupling.

In the initialisation phase the grids and coupling fields are defined by the user via the user interfaces. The initialisation and definition phase is terminated with a single command which at the same time invokes the neighbourhood search and calculation of weights. The data exchange consists of pairs of calls to send and receive routines while the end of the coupling is announced with a single finalising call.

The coupling configuration, e.g. the definition of exchange timesteps or the interpolation method that shall be applied for a data exchange is specified in an xml configuration file.

We use the git version control system, inline Doxygen documentation, and autoconf for the configuration management.

YAC is programmed in C, user interfaces to Fortran (prefix yac_f) and C (prefix yac_c) are available. The Fortran interface is provided using the ISO-C standard.

A detailed description of the Fortran and C interfaces can be found here and here respectively.

The GUI comes with its own documentation available in the local distribution or repository under gui/doc/index.html.