|
|
|
# Introduction
|
|
|
|
The main part of W-SLDA Toolkit is an engine for solving BdG-type equations. However, the solution of these equations does not solve a full problem, which typically requires further exploration of results. For this you can use VisIt, however, in many cases it is not sufficient. For this reason [extensions](https://gitlab.fizyka.pw.edu.pl/gabrielw/wslda/-/tree/public/extensions) were introduced.
|
|
|
|
|
|
|
|
Extensions are small C codes that can be used to support the computation process and data analysis process. The toolkit is equipped with various templates for such codes and examples.
|
|
|
|
|
|
|
|
# API
|
|
|
|
To have access to implemented already functions and functionalities by W-SLDA Toolkit you need to add to your code the following header:
|
|
|
|
```c
|
|
|
|
// Optionally: if you want to use W-DATA format
|
|
|
|
// W-DATA Format
|
|
|
|
// Must be before wslda_toolkit.h!
|
|
|
|
#include "wdata.h"
|
|
|
|
|
|
|
|
// W-SLDA Toolkit API
|
|
|
|
// Note: it loads predefines.h!
|
|
|
|
#include "wslda_toolkit.h"
|
|
|
|
```
|
|
|
|
When using W-SLDA Toolkit API you are forced to use [C99](https://en.wikipedia.org/wiki/C99) standard. To compile code with such header use command of structure:
|
|
|
|
```bash
|
|
|
|
gcc -std=gnu99 -I$WSLDA/hpc-engine -I$WSLDA/lib-wdata -L$WSLDA/lib-wdata -lwdatac -I$YOUR_PROJECT_FOLDER ...
|
|
|
|
```
|
|
|
|
where `YOUR_PROJECT_FOLDER` points to the folder where your `predefines.h` is located. It is recommended to copy and compile extension codes in the project folder, then `YOUR_PROJECT_FOLDER=.`.
|
|
|
|
|
|
|
|
The simplest way of learning how to use W-SLDA Toolkit API is just to explore provided templates and codes in [extensions](https://gitlab.fizyka.pw.edu.pl/gabrielw/wslda/-/tree/public/extensions). |
|
|
\ No newline at end of file |
