preCICE Source Code Documentation
preCICE Source Code Documentation
Description Namespaces Classes Functions Graph
The directory src contains the sources of preCICE. The library API of preCICE is contained in the directory precice, which brings together the functionalities contained in the other components of preCICE. Every component has its own directory, and the following components exist currently:


Additionally, preCICE uses components which are contained in the source code repository of Peano. These components are also implemented into separate directories


The components of preCICE have some common subdirectory structure. Some typical directories appearing are tests, config, and impl. tests holds classes for automated testing of the corresponding component. config provides functionality to configure the classes of a component from xml files. impl contains implementation of a component which is not part of its interface and used only internally.

The hierarchical dependencies of different components is as follows:

component-dependencies.png