Classes
struct	IsotopeRecord
	Struct containing all information needed about one isotope. More...

struct	IsotopologueRatios

Functions
ArrayOfIsotopeRecord	isotopologues (Species spec)

String	isotopologues_names (Species spec)

String	predefined_model_names () noexcept

String	update_isot_name (const String &old_name)
	Updates the name of the isotopologue based on updates of the isotopologues.

std::pair< ArrayOfString, ArrayOfString >	names_of_have_and_havenot_ratio (const Species spec, const IsotopologueRatios &ir) noexcept

consteval std::array< std::size_t, std::size_t(Species::FINAL)+1 >	start_positions () noexcept

template<Species spec>
consteval std::size_t	count_isotopologues () noexcept

template<Species spec>
consteval std::array< IsotopeRecord, count_isotopologues< spec >()>	isotopologues () noexcept

constexpr Index	find_species_index (const Species spec, const std::string_view isot) noexcept

constexpr Index	find_species_index (const IsotopeRecord ir) noexcept

constexpr Index	find_species_index (const std::string_view spec, const std::string_view isot) noexcept

constexpr Index	find_species_index (std::string_view s)

constexpr const IsotopeRecord &	select (Species spec, const std::string_view isotname) noexcept

constexpr const IsotopeRecord &	select (const std::string_view spec, const std::string_view isotname) noexcept

constexpr const IsotopeRecord &	select_joker (Species spec) noexcept

constexpr const IsotopeRecord &	select_joker (std::string_view spec) noexcept

constexpr bool	is_predefined_model (const IsotopeRecord &ir) noexcept

constexpr bool	is_normal_isotopologue (const IsotopeRecord &ir) noexcept

constexpr bool	same_or_joker (const IsotopeRecord &ir1, const IsotopeRecord &ir2) noexcept

constexpr IsotopologueRatios	isotopologue_ratiosInitFromBuiltin ()

constexpr Numeric	mean_mass (Species spec, const IsotopologueRatios &ir) noexcept

constexpr bool	all_have_ratio (const Species spec, const IsotopologueRatios &ir) noexcept

	ENUMCLASS (TagType, unsigned char, Plain, Zeeman, Predefined, Cia, FreeElectrons, Particles, XsecFit, NoLines) struct Tag

Numeric	first_vmr (const ArrayOfArrayOfSpeciesTag &abs_species, const Vector &rtp_vmr, const Species spec) ARTS_NOEXCEPT

Variables
constexpr std::string_view	Joker = "*"

constexpr std::array	Isotopologues
	A list of all ARTS isotopologues, note how the species enum class input HAS to be sorted.

constexpr auto	IsotopologuesStart = start_positions()

Function Documentation

◆ all_have_ratio()

constexpr bool Species::all_have_ratio	(	const Species	spec,
		const IsotopologueRatios &	ir
	)

constexprnoexcept

Definition at line 1143 of file isotopologues.h.

References is_predefined_model(), nonstd::isnan(), Isotopologues, IsotopologuesStart, and joker.

◆ count_isotopologues()

template<Species spec>

consteval std::size_t Species::count_isotopologues ( )

noexcept

Definition at line 602 of file isotopologues.h.

References IsotopologuesStart.

◆ ENUMCLASS()

Species::ENUMCLASS	(	TagType	,
		unsigned char	,
		Plain	,
		Zeeman	,
		Predefined	,
		Cia	,
		FreeElectrons	,
		Particles	,
		XsecFit	,
		NoLines
	)

Molecular species index in Species::Isotopologues

The lower limit line center frequency in Hz.

If this is < 0 it means no lower limit.

The upper line center frequency in Hz.

If this is < 0 it means no upper limit.

Flag for the type

2nd CIA species index.

Contains the second CIA species that should be used for this tag.

CIA dataset index.

A CIA file contains several datasets. This index specifies which one we want.

Definition at line 14 of file species_tags.h.

References ARTS_ASSERT, ARTS_NOEXCEPT, find_species_index(), is_predefined_model(), Isotopologues, operator!=(), operator<<(), and operator==().

◆ find_species_index() [1/4]

constexpr Index Species::find_species_index ( const IsotopeRecord ir )

constexprnoexcept

Definition at line 631 of file isotopologues.h.

References find_species_index().

◆ find_species_index() [2/4]

constexpr Index Species::find_species_index	(	const Species	spec,
		const std::string_view	isot
	)

constexprnoexcept

Definition at line 618 of file isotopologues.h.

References good_enum(), Isotopologues, and IsotopologuesStart.

Referenced by Absorption::PredefinedModel::compute_selection(), ENUMCLASS(), find_species_index(), Hitran::from_mol_iso(), Quantum::Number::GlobalState::GlobalState(), Jpl::id_from_lookup(), main(), Species::IsotopologueRatios::operator[](), Absorption::ReadFromArtscat3Stream(), Absorption::ReadFromArtscat4Stream(), Absorption::ReadFromArtscat5Stream(), select(), test_mpm20(), and xml_read_from_stream().

◆ find_species_index() [3/4]

constexpr Index Species::find_species_index	(	const std::string_view	spec,
		const std::string_view	isot
	)

constexprnoexcept

Definition at line 635 of file isotopologues.h.

References find_species_index().

◆ find_species_index() [4/4]

constexpr Index Species::find_species_index ( std::string_view s )

constexpr

Definition at line 640 of file isotopologues.h.

References find_species_index().

◆ first_vmr()

Numeric Species::first_vmr	(	const ArrayOfArrayOfSpeciesTag &	abs_species,
		const Vector &	rtp_vmr,
		const Species	spec
	)

First VMR or 0

Parameters

abs_species	As WSV
rtp_vmr	As WSV
spec	A species

Definition at line 488 of file species_tags.cc.

References ARTS_ASSERT.

◆ is_normal_isotopologue()

constexpr bool Species::is_normal_isotopologue ( const IsotopeRecord & ir )

constexprnoexcept

Definition at line 668 of file isotopologues.h.

References nonstd::isdigit(), and Joker.

Referenced by Quantum::Number::GlobalState::good().

◆ is_predefined_model()

constexpr bool Species::is_predefined_model ( const IsotopeRecord & ir )

constexprnoexcept

Definition at line 664 of file isotopologues.h.

References nonstd::isdigit().

Referenced by all_have_ratio(), Species::IsotopologueRatios::all_isotopes_have_a_value(), ENUMCLASS(), main(), names_of_have_and_havenot_ratio(), nonexistentPartfun(), and predefined_model_names().

◆ isotopologue_ratiosInitFromBuiltin()

constexpr IsotopologueRatios Species::isotopologue_ratiosInitFromBuiltin ( )

constexpr

Definition at line 719 of file isotopologues.h.

References set_isot_val.

Referenced by define_wsv_data(), isotopologue_ratiosInitFromBuiltin(), and main().

◆ isotopologues() [1/2]

template<Species spec>

consteval std::array< IsotopeRecord, count_isotopologues< spec >()> Species::isotopologues ( )

noexcept

Definition at line 607 of file isotopologues.h.

References Isotopologues, and IsotopologuesStart.

Referenced by abs_lines_per_speciesReadSpeciesSplitCatalog(), and isotopologues_names().

◆ isotopologues() [2/2]

Array< IsotopeRecord > Species::isotopologues ( Species spec )

Definition at line 6 of file isotopologues.cc.

References ARTS_USER_ERROR, and deal_with_spec.

◆ isotopologues_names()

String Species::isotopologues_names ( Species spec )

Definition at line 130 of file isotopologues.cc.

References isotopologues().

◆ mean_mass()

constexpr Numeric Species::mean_mass	(	Species	spec,
		const IsotopologueRatios &	ir
	)

constexprnoexcept

Computes the mean mass for all defined isotopes of the species with mass and isotopologue ratio

\[ m = \frac{ \sum_i r_i m_i }{ \sum_i r_i } \]

Parameters

[in]	spec	A species
[in]	ir	All isotopologue ratios

Returns: mean mass

Definition at line 1119 of file isotopologues.h.

References nonstd::isnan(), Isotopologues, and IsotopologuesStart.

Referenced by ecs_dataAddMakarov2020(), ecs_dataAddRodrigues1997(), ecs_dataAddSpeciesData(), ecs_dataAddTran2006(), ecs_dataAddTran2011(), and LineShape::mass().

◆ names_of_have_and_havenot_ratio()

std::pair< ArrayOfString, ArrayOfString > Species::names_of_have_and_havenot_ratio	(	const Species	spec,
		const IsotopologueRatios &	ir
	)

noexcept

Definition at line 166 of file isotopologues.cc.

References is_predefined_model(), nonstd::isnan(), Isotopologues, IsotopologuesStart, and joker.

◆ predefined_model_names()

String Species::predefined_model_names ( )

noexcept

Definition at line 137 of file isotopologues.cc.

References is_predefined_model(), and Isotopologues.

◆ same_or_joker()

constexpr bool Species::same_or_joker	(	const IsotopeRecord &	ir1,
		const IsotopeRecord &	ir2
	)

constexprnoexcept

Definition at line 674 of file isotopologues.h.

◆ select() [1/2]

constexpr const IsotopeRecord & Species::select	(	const std::string_view	spec,
		const std::string_view	isotname
	)

constexprnoexcept

Definition at line 649 of file isotopologues.h.

References find_species_index(), and Isotopologues.

◆ select() [2/2]

constexpr const IsotopeRecord & Species::select	(	Species	spec,
		const std::string_view	isotname
	)

constexprnoexcept

Definition at line 645 of file isotopologues.h.

References find_species_index(), and Isotopologues.

Referenced by select_joker().

◆ select_joker() [1/2]

constexpr const IsotopeRecord & Species::select_joker ( Species spec )

constexprnoexcept

Definition at line 654 of file isotopologues.h.

References select().

Referenced by abs_hitran_relmat_dataReadHitranRelmatDataAndLines().

◆ select_joker() [2/2]

constexpr const IsotopeRecord & Species::select_joker ( std::string_view spec )

constexprnoexcept

Definition at line 658 of file isotopologues.h.

References select().

◆ start_positions()

consteval std::array< std::size_t, std::size_t(Species::FINAL)+1 > Species::start_positions ( )

noexcept

Definition at line 582 of file isotopologues.h.

References Isotopologues.

◆ update_isot_name()

String Species::update_isot_name ( const String & old_name )

Updates the name of the isotopologue based on updates of the isotopologues.

This should only be invoked by versioned code as it is not very efficient.

Parameters

[in] old_name A valid isotopologue name in any version of ARTS

Returns: A name that is valid and equivalent in ARTS today (or a copy of old_name)

Definition at line 147 of file isotopologues.cc.

Referenced by Absorption::ReadFromArtscat3Stream(), Absorption::ReadFromArtscat4Stream(), and Absorption::ReadFromArtscat5Stream().

Variable Documentation

◆ Isotopologues

constexpr std::array Species::Isotopologues

inlineconstexpr

A list of all ARTS isotopologues, note how the species enum class input HAS to be sorted.

Definition at line 57 of file isotopologues.h.

Referenced by abs_linesReadSpeciesSplitCatalog(), all_have_ratio(), Species::IsotopologueRatios::all_isotopes_have_a_value(), ENUMCLASS(), find_species_index(), Quantum::Number::GlobalState::Isotopologue(), isotopologues(), main(), mean_mass(), names_of_have_and_havenot_ratio(), nonexistentPartfun(), predefined_model_names(), select(), start_positions(), test_ls(), test_mpm20(), Hitran::to_species_map(), and WriteBuiltinPartitionFunctionsXML().

◆ IsotopologuesStart

constexpr auto Species::IsotopologuesStart = start_positions()

inlineconstexpr

Definition at line 599 of file isotopologues.h.

Referenced by all_have_ratio(), count_isotopologues(), find_species_index(), isotopologues(), mean_mass(), and names_of_have_and_havenot_ratio().

◆ Joker

constexpr std::string_view Species::Joker = "*"

inlineconstexpr

Definition at line 13 of file isotopologues.h.

Referenced by is_normal_isotopologue(), Species::IsotopeRecord::joker(), species_iso_match(), and species_match().

Classes

Functions

Variables

Function Documentation

◆ all_have_ratio()

◆ count_isotopologues()

◆ ENUMCLASS()

◆ find_species_index() [1/4]

◆ find_species_index() [2/4]

◆ find_species_index() [3/4]

◆ find_species_index() [4/4]

◆ first_vmr()

◆ is_normal_isotopologue()

◆ is_predefined_model()

◆ isotopologue_ratiosInitFromBuiltin()

◆ isotopologues() [1/2]

◆ isotopologues() [2/2]

◆ isotopologues_names()

◆ mean_mass()

◆ names_of_have_and_havenot_ratio()

◆ predefined_model_names()

◆ same_or_joker()

◆ select() [1/2]

◆ select() [2/2]

◆ select_joker() [1/2]

◆ select_joker() [2/2]

◆ start_positions()

◆ update_isot_name()

Variable Documentation

◆ Isotopologues

◆ IsotopologuesStart

◆ Joker