Header menu logo BioFSharp

Elements Module

Contains chemical elements represented as a mixture of their stable isotopes and functionality for building them

Types and nested modules

Type/Module Description

Table

Contains the biologically relevant, chemical elements represented as a mixture of their stable isotopes

DiIsotopic

Di-isotopic elements consist of two isotopes

Element

Discriminant union type of Mono-,Di-,Tri- and Multi-isotopic elements

MonoIsotopic

Mono-isotopic elements consist of one isotope

MultiIsotopic

Multi-isotopic elements consist of more than three isotopes

TriIsotopic

Tri-isotopic elements consist of three isotopes

Functions and values

Function or value Description

createDi symbol (x, xcomp) (x1, x1comp)

Full Usage: createDi symbol (x, xcomp) (x1, x1comp)

Parameters:
    symbol : string
    x : Isotope
    xcomp : float
    x1 : Isotope
    x1comp : float

Returns: DiIsotopic

Create a di-isotopic element

symbol : string
x : Isotope
xcomp : float
x1 : Isotope
x1comp : float
Returns: DiIsotopic

createMono symbol (x, xcomp)

Full Usage: createMono symbol (x, xcomp)

Parameters:
    symbol : string
    x : Isotope
    xcomp : float

Returns: MonoIsotopic

Create a mono-isotopic element

symbol : string
x : Isotope
xcomp : float
Returns: MonoIsotopic

createMulti symbol (x, xcomp) (x1, x1comp) (x2, x2comp) xl

Full Usage: createMulti symbol (x, xcomp) (x1, x1comp) (x2, x2comp) xl

Parameters:
Returns: MultiIsotopic

Create a multi-isotopic element

symbol : string
x : Isotope
xcomp : float
x1 : Isotope
x1comp : float
x2 : Isotope
x2comp : float
xl : Isotope[]
Returns: MultiIsotopic

createTri symbol (x, xcomp) (x1, x1comp) (x2, x2comp)

Full Usage: createTri symbol (x, xcomp) (x1, x1comp) (x2, x2comp)

Parameters:
Returns: TriIsotopic

Create a three-isotopic element

symbol : string
x : Isotope
xcomp : float
x1 : Isotope
x1comp : float
x2 : Isotope
x2comp : float
Returns: TriIsotopic

getAtomicSymbol elem

Full Usage: getAtomicSymbol elem

Parameters:
Returns: string

Returns the atomic symbol of the given element

elem : Element
Returns: string

getMainIsotope elem

Full Usage: getMainIsotope elem

Parameters:
Returns: Isotope

Returns the main isotop of an Element

elem : Element
Returns: Isotope

getMainXComp elem

Full Usage: getMainXComp elem

Parameters:
Returns: float

Returns the main isotop of an Element

elem : Element
Returns: float

getSinglePhiL elem v l

Full Usage: getSinglePhiL elem v l

Parameters:
    elem : Element
    v : float
    l : float

Returns: float
elem : Element
v : float
l : float
Returns: float

getSinglePhiM elem v l

Full Usage: getSinglePhiM elem v l

Parameters:
    elem : Element
    v : float
    l : float

Returns: float
elem : Element
v : float
l : float
Returns: float

Type something to start searching.