solprop.physdata.species#

solprop.physdata.species(gas, *, selection=None)#

Return a custom species unchanged, or build a built-in gas from optmat.

Parameters:
gasGas or str or Species

A built-in gas’s name, or an existing custom species.

selectionMaterialSelection or None, optional

None (the default) is MaterialSelection(). The linear susceptibility is optmat’s (selection.linear: the recommended model, a model name, or an optmat model object for this gas) with its equation of state and transport properties (OptmatGas), and the electronic Kerr model (OptmatKerr, evaluated at a run’s carrier by kerr_coefficient(); gamma3 is then None). The species carries optmat’s first ionisation energy; its rate and Raman response are resolved by the drivers under the same selection.

Returns:
Species

The species, with its linear law, equation of state and data.

Raises:
MaterialError

If the name is unknown, a selection is given beside a custom species, or the selected linear model describes another gas.

Examples

>>> from solprop.physdata import species
>>> argon = species("Ar")
>>> argon.susceptibility.source, type(argon.equation_of_state).__name__
('fit/Ar', 'OptmatGas')
>>> from solprop.physdata import MaterialSelection
>>> chosen = MaterialSelection(linear="borzsonyi_2008/sellmeier_Ar")
>>> species("Ar", selection=chosen).susceptibility.source
'borzsonyi_2008/sellmeier_Ar'