Quantum::Number::GlobalState Struct Reference

A logical struct for global quantum numbers with species identifiers. More...

#include <quantum_numbers.h>

Public Member Functions
	GlobalState ()=default
	GlobalState (Index i, ValueList v={})
	GlobalState (const Species::IsotopeRecord &ir)
	GlobalState (std::string_view s, Index v=version)
Species::IsotopeRecord	Isotopologue () const noexcept
Species::Species	Species () const noexcept
GlobalState	LowerLevel () const
GlobalState	UpperLevel () const
std::strong_ordering	operator<=> (const GlobalState &g) const
auto	operator== (const GlobalState &g) const
auto	operator!= (const GlobalState &g) const
bool	part_of (const GlobalState &other) const
	Checks wheter all of the LHS is part of RHS.
LevelTest	part_of (const GlobalState &g, const LocalState &l) const
	Checks wheter all of the LHS is part of any of the RHS.
bool	good () const
	Test if there are bad quantum numbers (undefined ones) or if the isotopologue is not a normal target.

Public Attributes
Index	isotopologue_index {-1}
ValueList	val {}

Static Public Attributes
static constexpr Index	version = 1

Friends
std::ostream &	operator<< (std::ostream &os, const GlobalState &gs)
std::istream &	operator>> (std::istream &is, GlobalState &gs)

Detailed Description

A logical struct for global quantum numbers with species identifiers.

Definition at line 1045 of file quantum_numbers.h.

Constructor & Destructor Documentation

GlobalState() [1/4]

Quantum::Number::GlobalState::GlobalState ( )

default

GlobalState() [2/4]

Quantum::Number::GlobalState::GlobalState ( Index  i, ValueList  v = {}  )

inlineexplicit

Definition at line 1053 of file quantum_numbers.h.

GlobalState() [3/4]

Quantum::Number::GlobalState::GlobalState ( const Species::IsotopeRecord &  ir )

inlineexplicit

Definition at line 1056 of file quantum_numbers.h.

GlobalState() [4/4]

Quantum::Number::GlobalState::GlobalState ( std::string_view  s, Index  v = version  )

explicit

Definition at line 1033 of file quantum_numbers.cc.

References ARTS_USER_ERROR, ARTS_USER_ERROR_IF, Quantum::Number::count_items(), Species::find_species_index(), isotopologue_index, Quantum::Number::items(), v, val, and version.

Member Function Documentation

good()

bool Quantum::Number::GlobalState::good

(

)

const

Test if there are bad quantum numbers (undefined ones) or if the isotopologue is not a normal target.

Definition at line 1144 of file quantum_numbers.cc.

References Species::is_normal_isotopologue().

Referenced by xml_read_from_stream().

Isotopologue()

Species::IsotopeRecord Quantum::Number::GlobalState::Isotopologue ( ) const

noexcept

Definition at line 405 of file quantum_numbers.cc.

References isotopologue_index, and Species::Isotopologues.

Referenced by LineShape::from_artscat4(), global_quantumidentifier(), Absorption::Lines::Isotopologue(), Species(), species_iso_match(), species_match(), and Absorption::Lines::SpeciesName().

LowerLevel()

GlobalState Quantum::Number::GlobalState::LowerLevel

(

)

const

Definition at line 1007 of file quantum_numbers.cc.

References val.

Referenced by ArrayOfQuantumIdentifierFromLines().

operator!=()

auto Quantum::Number::GlobalState::operator!= ( const GlobalState &  g ) const

inline

Definition at line 1077 of file quantum_numbers.h.

operator<=>()

std::strong_ordering Quantum::Number::GlobalState::operator<=> ( const GlobalState &  g ) const

inline

Definition at line 1071 of file quantum_numbers.h.

operator==()

auto Quantum::Number::GlobalState::operator== ( const GlobalState &  g ) const

inline

Definition at line 1076 of file quantum_numbers.h.

part_of() [1/2]

LevelTest Quantum::Number::GlobalState::part_of	(	const GlobalState &	g,
		const LocalState &	l
	)		const

Checks wheter all of the LHS is part of any of the RHS.

Definition at line 1055 of file quantum_numbers.cc.

References ARTS_USER_ERROR_IF, Quantum::Number::ValueList::has(), isotopologue_index, v, Quantum::Number::LocalState::val, and val.

part_of() [2/2]

bool Quantum::Number::GlobalState::part_of

(

const GlobalState &

other

)

const

Checks wheter all of the LHS is part of RHS.

Definition at line 974 of file quantum_numbers.cc.

References Quantum::Number::ValueList::check_match(), isotopologue_index, and val.

Species()

Species::Species Quantum::Number::GlobalState::Species ( ) const

noexcept

Definition at line 409 of file quantum_numbers.cc.

References Isotopologue(), and Species::IsotopeRecord::spec.

Referenced by LineShape::from_artscat4(), LineShape::from_pressurebroadeningdata(), jacobianAddAbsSpecies(), jacobianAddBasicCatalogParameter(), jacobianAddNLTE(), jacobianAddShapeCatalogParameter(), Absorption::Lines::Lines(), Absorption::ReadFromHitran2001Stream(), Absorption::ReadFromHitran2004Stream(), Absorption::ReadFromHitranOnlineStream(), LineShape::LegacyPressureBroadeningData::self_listed(), Absorption::Lines::Species(), species_match(), and Quantum::Number::StateMatch::StateMatch().

UpperLevel()

GlobalState Quantum::Number::GlobalState::UpperLevel

(

)

const

Definition at line 1013 of file quantum_numbers.cc.

References val.

Referenced by ArrayOfQuantumIdentifierFromLines().

Friends And Related Function Documentation

operator<<

std::ostream & operator<< ( std::ostream &  os, const GlobalState &  gs  )

friend

Definition at line 413 of file quantum_numbers.cc.

operator>>

std::istream & operator>> ( std::istream &  is, GlobalState &  gs  )

friend

Definition at line 417 of file quantum_numbers.cc.

Member Data Documentation

isotopologue_index

Index Quantum::Number::GlobalState::isotopologue_index {-1}

Definition at line 1048 of file quantum_numbers.h.

Referenced by GlobalState(), Isotopologue(), part_of(), species_match(), Absorption::split_list_of_external_lines(), and Quantum::Number::StateMatch::StateMatch().

val

ValueList Quantum::Number::GlobalState::val {}

Definition at line 1049 of file quantum_numbers.h.

Referenced by lm_hitran_2017::calcw(), global_quantumidentifier(), GlobalState(), LowerLevel(), Quantum::Helpers::molecular_term_symbol(), part_of(), Absorption::Lines::QuantumIdentityOfLine(), lm_hitran_2017::read(), ReadArrayOfARTSCAT(), ReadARTSCAT(), Absorption::ReadFromArtscat5Stream(), Absorption::ReadFromHitranOnlineStream(), ReadHITRAN(), Absorption::LineMixing::Makarov2020etal::relaxation_matrix_offdiagonal(), Absorption::LineMixing::LinearRovibErrorCorrectedSudden::relaxation_matrix_offdiagonal(), Absorption::SingleLine::SetAutomaticZeeman(), lm_hitran_2017::sorter_calcw(), Quantum::Number::StateMatch::StateMatch(), and UpperLevel().

version

constexpr Index Quantum::Number::GlobalState::version = 1

staticconstexpr

Definition at line 1046 of file quantum_numbers.h.

Referenced by GlobalState(), xml_read_from_stream(), and xml_write_to_stream().

---

The documentation for this struct was generated from the following files:

• quantum_numbers.h
• quantum_numbers.cc