Fortran AutoDoc#

Modules#

ciaaw (module)#

Main module for the CIAAW library: API and C API.

Procedures

get_version (function)#

function get_version() -> fptr

Get the version. Deprecated. It will be removed in the next major release. Use version() instead.

Returns:

fptrcharacter(len=:), pointer: Fortran pointer to a string indicating the version..

capi_get_version (function)#

function capi_get_version()bind(c, name='ciaaw_get_version') -> cptr

C API.

Returns:

cptrtype(c_ptr): C pointer to a string indicating the version.

version (function)#

function version() -> fptr

Get the version.

Returns:

fptrcharacter(len=:), pointer: Pointer to a string (=>version).

capi_version (function)#

function capi_version()bind(C,name="ciaaw_version") -> cptr

C API - Get the version

Returns:

cptrtype(c_ptr): C pointer to a string indicating the version.

print_periodic_table (subroutine)#

subroutine print_periodic_table(): Print periodic table.

get_saw (function)#

function get_saw(s, abridged, uncertainty) -> res

Arguments:

scharacter(len=*), intent(in): Element symbol.
abridgedlogical, intent(in), optional: Set to False if the abridged value is not desired. Default to TRUE.
uncertaintylogical, intent(in), optional: Set to True if the uncertainty is desired. Default to FALSE.

Returns:

resreal(dp): NaN if the provided element is incorrect or -1 if the element does not have a SAW.

capi_get_saw (function)#

function capi_get_saw(s, n, abridged, uncertainty)bind(C, name="ciaaw_get_saw") -> res

Arguments:

stype(c_ptr), intent(in), value: Symbol.
ninteger(c_int), intent(in), value: Size of the symbol string.
abridgedlogical(c_bool), intent(in), value: Flag for setting if abridged value is desired.
uncertaintylogical(c_bool), intent(in), value: Flag for setting if the uncertainty is desired instead of the value.

Returns:

resreal(c_double): NaN if the provided element is incorrect or -1 if the element does not have a SAW.

saw (function)#

function saw(s, ab, u) -> res

Arguments:

scharacter(len=*), intent(in): Element symbol.
ablogical, intent(in), optional: Set to False if the abridged value is not desired. Default to TRUE.
ulogical, intent(in), optional: Set to True if the uncertainty is desired. Default to FALSE.

Returns:

resreal(dp): NaN if the provided element is incorrect or -1 if the element does not have a SAW.

capi_saw (function)#

function capi_saw(s, n, ab, u)bind(C, name="ciaaw_saw") -> res

Arguments:

stype(c_ptr), intent(in), value: Symbol.
ninteger(c_int), intent(in), value: Size of the symbol string.
ablogical(c_bool), intent(in), value: Flag for setting if abridged value is desired.
ulogical(c_bool), intent(in), value: Flag for setting if the uncertainty is desired instead of the value.

Returns:

resreal(c_double): NaN if the provided element is incorrect or -1 if the element does not have a SAW.

get_ice (function)#

function get_ice(s, A, uncertainty) -> res

Arguments:

scharacter(len=*), intent(in): Element symbol.
Ainteger(int32), intent(in): Mass number.
uncertaintylogical, intent(in), optional: Set to True if the uncertainty is desired. Default to FALSE.

Returns:

resreal(dp): NaN if the provided element or the mass number A are incorrect or -1 if the element does not have an ICE.

capi_get_ice (function)#

function capi_get_ice(s, n, A, uncertainty)bind(C, name="ciaaw_get_ice") -> res

Arguments:

stype(c_ptr), intent(in), value: Element symbol.
ninteger(c_int), intent(in), value: Size of the symbol string.
Ainteger(c_int), intent(in), value: Mass number.
uncertaintylogical(c_bool), intent(in), value: Flag for returning the uncertainty instead of the value. Default to FALSE.

Returns:

resreal(c_double): NaN if the provided element or the mass number A are incorrect or -1 if the element does not have an ICE.

ice (function)#

function ice(s, A, u) -> res

Arguments:

scharacter(len=*), intent(in): Element symbol.
Ainteger(int32), intent(in): Mass number.
ulogical, intent(in), optional: Set to True if the uncertainty is desired. Default to FALSE.

Returns:

resreal(dp): NaN if the provided element or the mass number A are incorrect or -1 if the element does not have an ICE.

capi_ice (function)#

function capi_ice(s, n, A, u)bind(C, name="ciaaw_ice") -> res

Arguments:

stype(c_ptr), intent(in), value: Element symbol.
ninteger(c_int), intent(in), value: Size of the symbol string.
Ainteger(c_int), intent(in), value: Mass number.
ulogical(c_bool), intent(in), value: Flag for returning the uncertainty instead of the value. Default to FALSE.

Returns:

resreal(c_double): NaN if the provided element or the mass number A are incorrect or -1 if the element does not have an ICE.

get_nice (function)#

function get_nice(s) -> res

Arguments:

scharacter(len=*), intent(in): Element symbol.

Returns:

resinteger(int32): >0 if found or -1 if not found.

capi_get_nice (function)#

function capi_get_nice(s,n)bind(C, name="ciaaw_get_nice") -> res

Arguments:

stype(c_ptr), intent(in), value: Element symbol.
ninteger(c_int), intent(in), value: Size of the symbol string.

Returns:

resinteger(c_int): >0 if found or -1 if not found.

nice (function)#

function nice(s) -> res

Arguments:

scharacter(len=*), intent(in): Element symbol.

Returns:

resinteger(int32): >0 if found or -1 if not found.

capi_nice (function)#

function capi_nice(s,n)bind(C, name="ciaaw_nice") -> res

Arguments:

stype(c_ptr), intent(in), value: Element symbol.
ninteger(c_int), intent(in), value: Size of the symbol string.

Returns:

resinteger(c_int): >0 if found or -1 if not found.

get_naw (function)#

function get_naw(s, A, uncertainty) -> res

Arguments:

scharacter(len=*), intent(in): Element symbol.
Ainteger(int32), intent(in): Mass number.
uncertaintylogical, intent(in), optional: Flag for returning the uncertainty instead of the value. Default to FALSE.

Returns:

resreal(dp): NaN if the provided element or A are incorrect or -1 if the element does not have an NAW.

capi_get_naw (function)#

function capi_get_naw(s, n, A, uncertainty)bind(C, name="ciaaw_get_naw") -> res

Arguments:

stype(c_ptr), intent(in), value: Element symbol.
ninteger(c_int), intent(in), value: Size of the symbol string.
Ainteger(c_int), intent(in), value: Mass number.
uncertaintylogical(c_bool), intent(in), value: Flag for returning the uncertainty instead of the value. Default to FALSE.

Returns:

resreal(c_double): NaN if the provided element or A are incorrect or -1 if the element does not have an NAW.

naw (function)#

function naw(s, A, u) -> res

Arguments:

scharacter(len=*), intent(in): Element symbol.
Ainteger(int32), intent(in): Mass number.
ulogical, intent(in), optional: Flag for returning the uncertainty instead of the value. Default to FALSE.

Returns:

resreal(dp): NaN if the provided element or A are incorrect or -1 if the element does not have an NAW.

capi_naw (function)#

function capi_naw(s, n, A, u)bind(C, name="ciaaw_naw") -> res

Arguments:

stype(c_ptr), intent(in), value: Element symbol.
ninteger(c_int), intent(in), value: Size of the symbol string.
Ainteger(c_int), intent(in), value: Mass number.
ulogical(c_bool), intent(in), value: Flag for returning the uncertainty instead of the value. Default to FALSE.

Returns:

resreal(c_double): NaN if the provided element or A are incorrect or -1 if the element does not have an NAW.

get_nnaw (function)#

function get_nnaw(s) -> res

Arguments:

scharacter(len=*), intent(in): Element symbol.

Returns:

resinteger(int32): >0 if found or -1 if not found.

capi_get_nnaw (function)#

function capi_get_nnaw(s,n)bind(C, name="ciaaw_get_nnaw") -> res

Arguments:

stype(c_ptr), intent(in), value: Element symbol.
ninteger(c_int), intent(in), value: Size of the symbol string.

Returns:

resinteger(c_int)

nnaw (function)#

function nnaw(s) -> res

Arguments:

scharacter(len=*), intent(in): Element symbol.

Returns:

resinteger(int32): >0 if found or -1 if not found.

capi_nnaw (function)#

function capi_nnaw(s,n)bind(C, name="ciaaw_nnaw") -> res

Arguments:

stype(c_ptr), intent(in), value: Element symbol.
ninteger(c_int), intent(in), value: Size of the symbol string.

Returns:

resinteger(c_int)

Warning