quantity.h File Reference

#include "libviennashe/include/sys.h"
#include "libviennashe/include/error.h"
#include "libviennashe/include/simulator.h"

Go to the source code of this file.

Typedefs
typedef viennashe_quan_register_impl *	viennashe_quan_register

Enumerations
enum	viennashe_carrier_ids { viennashe_electron_id , viennashe_hole_id }
	Enum of available charge carrier types. More...

Functions
VIENNASHE_EXPORT viennasheErrorCode	viennashe_create_quantity_register (viennashe_quan_register *reg, viennashe_simulator sim)
VIENNASHE_EXPORT viennasheErrorCode	viennashe_free_quantity_register (viennashe_quan_register reg)
VIENNASHE_EXPORT viennasheErrorCode	viennashe_get_num_cell_based (viennashe_quan_register reg, viennashe_index_type *num)
VIENNASHE_EXPORT viennasheErrorCode	viennashe_get_cell_based_quantity_list (viennashe_quan_register reg, char **names)
VIENNASHE_EXPORT viennasheErrorCode	viennashe_has_cell_based_quantity (viennashe_quan_register reg, char const *name, libviennashe_bool *exists)
VIENNASHE_EXPORT viennasheErrorCode	viennashe_get_cell_based_quantity (viennashe_quan_register reg, char const *name, double **values, viennashe_index_type *len)
VIENNASHE_EXPORT viennasheErrorCode	viennashe_get_she_edf (viennashe_quan_register reg, viennashe_carrier_ids ctype, double **energies, double **values, viennashe_index_type *len)
VIENNASHE_EXPORT viennasheErrorCode	viennashe_get_she_dos (viennashe_quan_register reg, viennashe_carrier_ids ctype, double **energies, double **values, viennashe_index_type *len)
VIENNASHE_EXPORT viennasheErrorCode	viennashe_get_she_group_velocity (viennashe_quan_register reg, viennashe_carrier_ids ctype, double **energies, double **values, viennashe_index_type *len)
VIENNASHE_EXPORT viennasheErrorCode	viennashe_prealloc_cell_based_quantity (viennashe_device dev, double ***uarray, viennashe_index_type **len)
VIENNASHE_EXPORT viennasheErrorCode	viennashe_free_cell_based_quantity (viennashe_device dev, double ***uarray, viennashe_index_type **len)

Typedef Documentation

viennashe_quan_register

typedef viennashe_quan_register_impl* viennashe_quan_register

Definition at line 31 of file quantity.h.

Enumeration Type Documentation

viennashe_carrier_ids

enum viennashe_carrier_ids

Enum of available charge carrier types.

The quantity registry

Enumerator
viennashe_electron_id
viennashe_hole_id

Definition at line 34 of file quantity.h.

Function Documentation

viennashe_create_quantity_register()

VIENNASHE_EXPORT viennasheErrorCode viennashe_create_quantity_register	(	viennashe_quan_register *	reg,
		viennashe_simulator	sim
	)

Examples

resistor1d-c.c.

viennashe_free_cell_based_quantity()

VIENNASHE_EXPORT viennasheErrorCode viennashe_free_cell_based_quantity	(	viennashe_device	dev,
		double ***	uarray,
		viennashe_index_type **	len
	)

Examples

resistor1d-c.c.

viennashe_free_quantity_register()

VIENNASHE_EXPORT viennasheErrorCode viennashe_free_quantity_register

(

viennashe_quan_register

reg

)

Examples

resistor1d-c.c.

viennashe_get_cell_based_quantity()

VIENNASHE_EXPORT viennasheErrorCode viennashe_get_cell_based_quantity	(	viennashe_quan_register	reg,
		char const *	name,
		double **	values,
		viennashe_index_type *	len
	)

Examples

resistor1d-c.c.

viennashe_get_cell_based_quantity_list()

VIENNASHE_EXPORT viennasheErrorCode viennashe_get_cell_based_quantity_list	(	viennashe_quan_register	reg,
		char **	names
	)

Examples

resistor1d-c.c.

viennashe_get_num_cell_based()

VIENNASHE_EXPORT viennasheErrorCode viennashe_get_num_cell_based	(	viennashe_quan_register	reg,
		viennashe_index_type *	num
	)

Examples

resistor1d-c.c.

viennashe_get_she_dos()

VIENNASHE_EXPORT viennasheErrorCode viennashe_get_she_dos	(	viennashe_quan_register	reg,
		viennashe_carrier_ids	ctype,
		double **	energies,
		double **	values,
		viennashe_index_type *	len
	)

viennashe_get_she_edf()

VIENNASHE_EXPORT viennasheErrorCode viennashe_get_she_edf	(	viennashe_quan_register	reg,
		viennashe_carrier_ids	ctype,
		double **	energies,
		double **	values,
		viennashe_index_type *	len
	)

viennashe_get_she_group_velocity()

VIENNASHE_EXPORT viennasheErrorCode viennashe_get_she_group_velocity	(	viennashe_quan_register	reg,
		viennashe_carrier_ids	ctype,
		double **	energies,
		double **	values,
		viennashe_index_type *	len
	)

viennashe_has_cell_based_quantity()

VIENNASHE_EXPORT viennasheErrorCode viennashe_has_cell_based_quantity	(	viennashe_quan_register	reg,
		char const *	name,
		libviennashe_bool *	exists
	)

Examples

resistor1d-c.c.

viennashe_prealloc_cell_based_quantity()

VIENNASHE_EXPORT viennasheErrorCode viennashe_prealloc_cell_based_quantity	(	viennashe_device	dev,
		double ***	uarray,
		viennashe_index_type **	len
	)

Examples

resistor1d-c.c.