ARTS  2.3.1285(git:92a29ea9-dirty)
abs_species_tags.h File Reference

Header file for stuff related to absorption species tags. More...

#include <stdexcept>
#include "array.h"
#include "bifstream.h"
#include "matpackI.h"
#include "mystring.h"

Go to the source code of this file.

Classes

class  SpeciesTag
 A tag group can consist of the sum of several of these. More...
 

Typedefs

typedef Array< SpeciesTagArrayOfSpeciesTag
 A tag group is an array of SpeciesTags. More...
 
typedef Array< ArrayOfSpeciesTagArrayOfArrayOfSpeciesTag
 Contains the available tag groups. More...
 

Functions

ostream & operator<< (ostream &os, const SpeciesTag &ot)
 Output operator for SpeciesTag. More...
 
String get_tag_group_name (const ArrayOfSpeciesTag &tg)
 Return the name of a tag group as a string. More...
 
String get_species_name (const ArrayOfSpeciesTag &tg)
 Return the species of a tag group as a string. More...
 
Index find_first_species_tg (const ArrayOfArrayOfSpeciesTag &tgs, const Index &spec)
 Find first occurrence of species in tag groups. More...
 
Index find_next_species_tg (const ArrayOfArrayOfSpeciesTag &tgs, const Index &spec, const Index &start)
 Find next occurrence of species in tag groups. More...
 
Index find_first_species_tg (const ArrayOfArrayOfSpeciesTag &list_of_tags, const SpeciesTag &tag)
 Return the position in the list of tags that contain tag. More...
 
void array_species_tag_from_string (ArrayOfSpeciesTag &tags, const String &names)
 Converts a String to ArrayOfSpeciesTag. More...
 
void check_abs_species (const ArrayOfArrayOfSpeciesTag &abs_species)
 Check the correctness of abs_species. More...
 
bool is_zeeman (const ArrayOfSpeciesTag &tg)
 Is this a Zeeman tag group? More...
 
void get_tag_group_index_for_tag_group (Index &tags1_index, const ArrayOfArrayOfSpeciesTag &tags1, const Array< SpeciesTag > &tags2)
 Returns the index of the tag group tg2 within the array of tag groups tgs1. More...
 

Detailed Description

Header file for stuff related to absorption species tags.

Author
Stefan Buehler sbueh.nosp@m.ler@.nosp@m.ltu.s.nosp@m.e
Date
Tue May 31 17:18:22 2005

This file contains class definition and function headers related to SpeciesTags. It is better to separate this from the other absorption functions, since this part was actually improved in arts-1-1 and should be kept, whereas most other absorption stuff is back-ported from arts-1-0.

Definition in file abs_species_tags.h.

Typedef Documentation

◆ ArrayOfArrayOfSpeciesTag

Contains the available tag groups.

Contrary to the Bredbeck definition, tag groups may only consist of tags belonging to the same species. The reason for this is that there is one VMR profile associated with each tag group.

Author
Stefan Buehler

Definition at line 255 of file abs_species_tags.h.

◆ ArrayOfSpeciesTag

A tag group is an array of SpeciesTags.

This corresponds to one "species" in the controlfile. Example: "O3-666, O3-668"

Author
Stefan Buehler

Definition at line 247 of file abs_species_tags.h.

Function Documentation

◆ array_species_tag_from_string()

void array_species_tag_from_string ( ArrayOfSpeciesTag tags,
const String names 
)

Converts a String to ArrayOfSpeciesTag.

This function is used when preparing strings read from e.g. control files to be stored as SpeciesTag in abs_species.

Note: This is originally a part of abs_speciesSet.

Parameters
tagsArray of SpeciesTag.
namesString with species.
Author
Mattias Ekstroem
Date
2004-09-30

Definition at line 586 of file abs_species_tags.cc.

References n, Array< base >::nelem(), my_basic_string< charT >::npos, SpeciesTag::Species(), SpeciesTag::Type(), SpeciesTag::TYPE_PLAIN, and SpeciesTag::TYPE_ZEEMAN.

Referenced by abs_speciesAdd(), abs_speciesAdd2(), abs_speciesSet(), f_gridFromabs_lines_per_speciesSetFromSpeciesTag(), get_pointers_for_analytical_jacobians(), jacobianAddAbsSpecies(), species_match(), vmr_fieldSetConstant(), x2artsAtmAndSurf(), and xaStandard().

◆ check_abs_species()

void check_abs_species ( const ArrayOfArrayOfSpeciesTag abs_species)

Check the correctness of abs_species.

Checks on the correctness of the tags will be performed, e.g. free_electrons and particles species are only allowed once in abs_species.

Parameters
tagsArray of Array of SpeciesTag.
Author
Oliver Lemke
Date
2013-04-23

Definition at line 649 of file abs_species_tags.cc.

References i, Array< base >::nelem(), Absorption::nelem(), SpeciesTag::Type(), SpeciesTag::TYPE_FREE_ELECTRONS, SpeciesTag::TYPE_HITRAN_XSEC, and SpeciesTag::TYPE_PARTICLES.

Referenced by abs_speciesAdd(), abs_speciesAdd2(), and abs_speciesSet().

◆ find_first_species_tg() [1/2]

Index find_first_species_tg ( const ArrayOfArrayOfSpeciesTag tgs,
const Index spec 
)

Find first occurrence of species in tag groups.

The species to look for must be specified by its species index, not by the name. Use the helper function to get the species index from the species name if necessary.

See also
species_index_from_species_name.
Parameters
tgsThe species tags to search in.
specThe species index of the species to look for.
Returns
The index of spec in tgs, -1 if not found.
Author
Stefan Buehler
Date
2003-01-13

Definition at line 532 of file abs_species_tags.cc.

References find_next_species_tg().

Referenced by abs_lookupCalc(), abs_lookupSetup(), abs_lookupSetupBatch(), abs_lookupTestAccMC(), abs_lookupTestAccuracy(), abs_xsec_agenda_checkedCalc(), abs_xsec_per_speciesAddCIA(), abs_xsec_per_speciesAddPredefinedO2MPM2020(), GasAbsLookup::Extract(), refr_index_airMicrowavesEarth(), set_vmr_from_first_species(), and z_fieldFromHSE().

◆ find_first_species_tg() [2/2]

Index find_first_species_tg ( const ArrayOfArrayOfSpeciesTag list_of_tags,
const SpeciesTag tag 
)

Return the position in the list of tags that contain tag.

If there is no tag in the list of tags, then return -1

Parameters
[in]list_of_tagsA list of several tags
[in]tagA single tag that might be in one of the listed tags
Returns
Position in list or -1

Definition at line 750 of file abs_species_tags.cc.

References i, and Array< base >::nelem().

◆ find_next_species_tg()

Index find_next_species_tg ( const ArrayOfArrayOfSpeciesTag tgs,
const Index spec,
const Index start 
)

Find next occurrence of species in tag groups.

The species to look for must be specified by its species index, not by the name. Use the helper function to get the species index from the species name if necessary.

See also
species_index_from_species_name.
Parameters
tgsThe species tags to search in.
specThe species index of the species to look for.
startThe index position at which to start the search (0 would be the very beginning).
Returns
The index of spec in tgs, -1 if not found.
Author
Stefan Buehler
Date
2007-11-16

Definition at line 555 of file abs_species_tags.cc.

References i, Array< base >::nelem(), and SpeciesTag::Species().

Referenced by choose_abs_nls(), and find_first_species_tg().

◆ get_species_name()

String get_species_name ( const ArrayOfSpeciesTag tg)

Return the species of a tag group as a string.

A tag group consists of several elementary SpeciesTags, which must all belong to the same molecular species. This function returns a string with the name of the species. This is nice for informational output messages, for example in the absorption routines.

E.g., if the tag group is: "H2O-161, H2O-181", then the function will return "H2O".

It also does a safety check that really all tags belong to the same species.

Parameters
tgThe tag group in question.
Returns
The name of the species, as it should be used in gridded atmospheric fields, for example.
Author
Stefan Buehler
Date
2009-06-11

Definition at line 497 of file abs_species_tags.cc.

References get_tag_group_name(), i, Array< base >::nelem(), SpeciesTag::Species(), species_name_from_species_index(), and _CS_basic_sstream_base< _CS_cT, _CS_Tr, _CS_Al >::str().

Referenced by abs_lookupSetupBatch().

◆ get_tag_group_index_for_tag_group()

void get_tag_group_index_for_tag_group ( Index tags1_index,
const ArrayOfArrayOfSpeciesTag tags1,
const ArrayOfSpeciesTag tag2 
)

Returns the index of the tag group tg2 within the array of tag groups tgs1.

Slightly modified copy of get_tagindex_for_Strings.

Exceptions
runtime_errorCould not find tg2 in tgs1.
Return values
tgs1_indexIndex in tgs1 for tg2
Parameters
tgs1The tags groups to search in.
tg2The tag group for which the index shall be found.
Author
Patrick Eriksson, Axel von Engeln, and Stefan Buehler
Date
2001-01-31

Definition at line 720 of file abs_species_tags.cc.

References i, SpeciesTag::Name(), Array< base >::nelem(), and _CS_basic_sstream_base< _CS_cT, _CS_Tr, _CS_Al >::str().

◆ get_tag_group_name()

String get_tag_group_name ( const ArrayOfSpeciesTag tg)

Return the name of a tag group as a string.

A tag group consists of several elementary SpeciesTags. This function returns a String with the name of the entire tag group. This is nice for informational output messages, for example in the absorption routines.

Parameters
tgThe tag group in question.
Returns
The full name of the tag group, as it could occur in the controlfile.
Author
Stefan Buehler
Date
2001-03-13

Definition at line 464 of file abs_species_tags.cc.

References i, and Array< base >::nelem().

Referenced by abs_lookupCalc(), get_species_name(), and vmr_fieldSetAllConstant().

◆ is_zeeman()

bool is_zeeman ( const ArrayOfSpeciesTag tg)

Is this a Zeeman tag group?

It is not enough to just look at the first tag to find out if this is a Zeeman tag group, since there could be some predefined absorption or CIA tag first.

Returns
true if this is a Zeeman tag group, otherwise false.
Parameters
tgThe tag group to check
Author
Stefan Buehler
Date
2013-01-15

Definition at line 702 of file abs_species_tags.cc.

References Array< base >::nelem(), SpeciesTag::Type(), and SpeciesTag::TYPE_ZEEMAN.

Referenced by abs_xsec_per_speciesAddLines(), and zeeman_on_the_fly().

◆ operator<<()

ostream& operator<< ( ostream &  os,
const SpeciesTag ot 
)

Output operator for SpeciesTag.

Author
Stefan Buehler

Definition at line 447 of file abs_species_tags.cc.

References SpeciesTag::Name().