eiram_octave.cpp File Reference

Go to the source code of this file.

Functions
	DEFUN_DLD (eiram, args, nargout,"\n\ Calculate reaction rates and cross-sections described by polynomial fit formulas \n\ (interface to fortran module EIRAM) \n\ \n\ [Y1 Y2 .. ] = eiram(X1, [X2,] name, type, index, [path]) \n\ \n\ Y1, Y2 ... : vectors or matrices with the results, \n\ each Y1, Y2 ..., corresponds to one reaction defined in INDEX, \n\ each column in Y1, Y2 ... corresponds to one value of X1 \n\ X1 : row vector, first argument of the fit \n\ X2 : optional, column vector, second argument of the fit \n\ name : string, name of the file with the data-set ('HYDHEL', 'AMJUEL' etc.) \n\ type : string, type of the reaction ('H.1','H.3','H.4' etc.) \n\ index : array of strings, index of the reaction ('3.1.8', '2.1.5' etc.) \n\ path : optional, string, complete path to the file defined by NAME, \n\ if PATH is omitted than it is assumed that the data-set is in the current folder \n\ \n\ Units : energy and temperature in [eV], density in [cm^-3], \n\ cross sections in cm^2, collision rates in cm^3/s, \n\ energy loss rates in cm^3/s*eV \n\ \n\ Examples: \n\ % Charge-exchange H + p, Ebeam=10 eV \n\ svcx = eiram(10,[1:100],'HYDHEL','H.3','3.1.8'); \n\ \n\ % Momentum transfer cross-sections for elastic collisions p+H, p+He, p+H2 \n\ [sel_D sel_He sel_D2] = eiram([0.1:10],'AMJUEL','H.1',['0.1D'; '0.2D'; '0.3D'],'.../eiram/data/'); \n\ \n\ % Ionization rate of H atoms, electron density 1e12 cm-3 and 1e14 cm-3 \n\ svi = eiram([1e12 1e14],[0.1:0.1:10 10+1:1:100],'AMJUEL','H.4','2.1.5');")

Function Documentation

DEFUN_DLD	(	eiram	,
		args	,
		nargout	,
		"\n\ Calculate reaction rates and cross-sections described by polynomial fit formulas \n\ (interface to fortran module EIRAM) \n\\n\	[Y1 Y2..] = eiram(X1, [X2,] name, type, index, [path]) \n\\n\   Y1,
		Y2...:vectors or matrices with the	results,
		\n\each	Y1,
		Y2...	,
		corresponds to one reaction defined in	INDEX,
		\n\each column in	Y1,
		Y2...corresponds to one value of X1\n\X1:row	vector,
		first argument of the fit\n\X2:optional	,
		column	vector,
		second argument of the fit\n\name:string	,
		name of the file with the data-set('HYDHEL', 'AMJUEL'etc.)\n\type:string	,
		type of the reaction('H.1','H.3','H.4'etc.)\n\index:array of	strings,
		index of the reaction('3.1.8', '2.1.5'etc.)\n\path:optional	,
		string	,
		complete path to the file defined by	NAME,
		\n\if PATH is omitted than it is assumed that the data-set is in the current folder\n\\n\Units:energy and temperature	in[eV],
		density	in[cm^-3],
		\n\cross sections in cm^	2,
		collision rates in cm^3/	s,
		\n\energy loss rates in cm^3/s *eV\n\\n\Examples:\n\%Charge-exchange H+	p,
		Ebeam	= 10 eV  \n\    svcx = eiram(10,[1:100],'HYDHEL','H.3','3.1.8'); \n\\n\  % Momentum transfer cross-sections for elastic collisions p+H,
		p+	He,
		p+H2\n\	[sel_D sel_He sel_D2] = eiram([0.1:10],'AMJUEL','H.1',['0.1D'; '0.2D'; '0.3D'],'.../eiram/data/'); \n\\n\  % Ionization rate of H atoms
	)

Definition at line 30 of file eiram_octave.cpp.

References eiram_deallocate_wrapper(), eiram_load_wrapper(), eiram_matlab_calc1(), eiram_matlab_calc2(), and eiram_test::n_reactions.

Here is the call graph for this function: