ViennaSHE 1.3.0
Free open-source semiconductor device simulator using spherical harmonics expansions techniques.
libviennashe.h
Go to the documentation of this file.
1/* ============================================================================
2 Copyright (c) 2011-2022, Institute for Microelectronics,
3 Institute for Analysis and Scientific Computing,
4 TU Wien.
5
6 -----------------
7 ViennaSHE - The Vienna Spherical Harmonics Expansion Boltzmann Solver
8 -----------------
9
10 http://viennashe.sourceforge.net/
11
12 License: MIT (X11), see file LICENSE in the base directory
13=============================================================================== */
14/* ##################################### */
15/* This is the main header file
16 for the library users */
17/* ##################################### */
18
19#include "libviennashe/include/sys.h"
20#include "libviennashe/include/error.h"
21
22#ifndef LIBVIENNASHE_LIBVIENNASHE_H
23#define LIBVIENNASHE_LIBVIENNASHE_H
24/* ##################################### */
25
26#ifdef __cplusplus
27extern "C" {
28#endif
29
31VIENNASHE_EXPORT viennasheErrorCode viennashe_initalize(void);
32
34VIENNASHE_EXPORT viennasheErrorCode viennashe_finalize(void);
35
36#ifdef __cplusplus
37}
38#endif
39
40#endif /* LIBVIENNASHE_LIBVIENNASHE_H */
41
42
43/* ##################################### */
44/* Include all other header files here */
45/* ##################################### */
46
47#include "libviennashe/include/material.h"
48#include "libviennashe/include/device.h"
49#include "libviennashe/include/config.h"
50#include "libviennashe/include/simulator.h"
51#include "libviennashe/include/output.h"
52
53
54
55
viennasheErrorCode
int viennasheErrorCode
Definition: error.h:25
viennashe_finalize
VIENNASHE_EXPORT viennasheErrorCode viennashe_finalize(void)
Finalizes ViennaSHE.
viennashe_initalize
VIENNASHE_EXPORT viennasheErrorCode viennashe_initalize(void)
Initializes ViennaSHE. To be called before ViennaSHE is used.
VIENNASHE_EXPORT
#define VIENNASHE_EXPORT
Definition: sys.h:19