ciaaw__api Module

API See specs


Uses

  • module~~ciaaw__api~~UsesGraph module~ciaaw__api ciaaw__api ieee_arithmetic ieee_arithmetic module~ciaaw__api->ieee_arithmetic module~ciaaw__common ciaaw__common module~ciaaw__api->module~ciaaw__common module~ciaaw__pte ciaaw__pte module~ciaaw__api->module~ciaaw__pte module~ciaaw__types ciaaw__types module~ciaaw__api->module~ciaaw__types module~ciaaw__version ciaaw__version module~ciaaw__api->module~ciaaw__version module~ciaaw__common->ieee_arithmetic stdlib_kinds stdlib_kinds module~ciaaw__common->stdlib_kinds stdlib_optval stdlib_optval module~ciaaw__common->stdlib_optval module~ciaaw__pte->module~ciaaw__common module~ciaaw__pte->module~ciaaw__types module~ciaaw__ice ciaaw__ice module~ciaaw__pte->module~ciaaw__ice module~ciaaw__naw ciaaw__naw module~ciaaw__pte->module~ciaaw__naw module~ciaaw__saw ciaaw__saw module~ciaaw__pte->module~ciaaw__saw module~ciaaw__types->module~ciaaw__common stdlib_string_type stdlib_string_type module~ciaaw__types->stdlib_string_type module~ciaaw__ice->module~ciaaw__common module~ciaaw__ice->module~ciaaw__types module~ciaaw__naw->module~ciaaw__common module~ciaaw__naw->module~ciaaw__types module~ciaaw__saw->module~ciaaw__common module~ciaaw__saw->module~ciaaw__types

Used by

  • module~~ciaaw__api~~UsedByGraph module~ciaaw__api ciaaw__api module~ciaaw ciaaw module~ciaaw->module~ciaaw__api module~ciaaw__capi ciaaw__capi module~ciaaw->module~ciaaw__capi module~ciaaw__capi->module~ciaaw__api

Functions

public function get_ice(s, A, uncertainty) result(res)

Get the isotopic composition of the element s for the mass number A. The uncertainty instead of the value can be retrieved if the uncertainty is set to true. Returns NaN if the provided symbol or A are incorrect or -1 if the element does not have an ICE.

Arguments

Type IntentOptional Attributes Name
character(len=*), intent(in) :: s

Element symbol.
integer(kind=int32), intent(in) :: A

Mass number.
logical, intent(in), optional :: uncertainty

Flag for returning the uncertainty instead of the value. Default to FALSE.

Return Value real(kind=dp)

public function get_ice_values(s) result(res)

Get the (n, 3) values array. See ice_type. Returns a null pointer if the provided symbol is incorrect.

Arguments

Type IntentOptional Attributes Name
character(len=*), intent(in) :: s

Element symbol.

Return Value real(kind=dp), pointer, (:,:)

public function get_naw(s, A, uncertainty) result(res)

Get the atomic weight of the nuclide s for the mass number A. The uncertainty instead of the value can be retrieved if the uncertainty is set to true. Returns NaN if provided symbol or A are incorrect or -1 if the element does not have an NAW.

Arguments

Type IntentOptional Attributes Name
character(len=*), intent(in) :: s

Element symbol.
integer(kind=int32), intent(in) :: A

Mass number.
logical, intent(in), optional :: uncertainty

Flag for returning the uncertainty instead of the value. Default to FALSE.

Return Value real(kind=dp)

public function get_nice(s) result(res)

Get the number of isotopes in ICE. Returns -1 if the provided symbol is incorrect.

Arguments

Type IntentOptional Attributes Name
character(len=*), intent(in) :: s

Element symbol.

Return Value integer(kind=int32)

public function get_nnaw(s) result(res)

Get the number of nuclides in NAW. Returns -1 if the provided symbol is incorrect.

Arguments

Type IntentOptional Attributes Name
character(len=*), intent(in) :: s

Element symbol.

Return Value integer(kind=int32)

public function get_saw(s, abridged, uncertainty) result(res)

Get the standard atomic weight. By default the abridged value is provided. If the non abridged value is desired, set abridged to false. The uncertainty instead of the value can be retrieved if the uncertainty is set to true. Returns NaN if provided symbol is incorrect or -1 if the element does not have a SAW.

Arguments

Type IntentOptional Attributes Name
character(len=*), intent(in) :: s

Element symbol.
logical, intent(in), optional :: abridged

Flag for returning the abridged standard atomic weight. Default to TRUE.
logical, intent(in), optional :: uncertainty

Flag for returning the uncertainty instead of the value. Default to FALSE.

Return Value real(kind=dp)

public function get_version() result(fptr)

Get the version

Arguments

None

Return Value character(len=:), pointer

Fortran pointer to a string indicating the version..