abs_species_tags.h

Go to the documentation of this file.

/* Copyright (C) 2002-2012 Stefan Buehler  <sbuehler@ltu.se>

   This program is free software; you can redistribute it and/or modify it
   under the terms of the GNU General Public License as published by the
   Free Software Foundation; either version 2, or (at your option) any
   later version.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
   USA. */

#ifndef abs_species_h
#define abs_species_h

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


class SpeciesTag {
public:
  SpeciesTag() : mspecies(-1),
                 misotopologue(-1),
                 mlf(0.),
                 muf(0.),
                 mtype(-1),
                 mline_mixing_type(LINE_MIXING_TYPE_NONE),
                 mcia_second(-1),
                 mcia_dataset(-1)
  { /* Nothing to be done here. */ }

  // Documentation is with implementation.
  SpeciesTag(String def); 

  // Documentation is with implementation.
  String Name() const;
    
  Index Species() const { return mspecies; }

  Index Isotopologue() const { return misotopologue; }

  Numeric Lf() const { return mlf; }

  Numeric Uf() const { return muf; }

  Index CIASecond() const { return mcia_second; }

  Index CIADataset() const { return mcia_dataset; }


  bool operator==(const SpeciesTag& other) const
  {
    if ( other.mspecies          != mspecies ) return false;
    if ( other.misotopologue     != misotopologue ) return false;
    if ( other.mlf               != mlf      ) return false;
    if ( other.muf               != muf      ) return false;
    if ( other.mtype             != mtype    ) return false;
    if ( other.mline_mixing_type != mline_mixing_type ) return false;
    if ( mtype == TYPE_CIA && (other.mcia_second != mcia_second
                               || other.mcia_dataset != mcia_dataset)) return false;
    return true;
  }


   enum {
       TYPE_PLAIN,
       TYPE_ZEEMAN,
       TYPE_PREDEF,
       TYPE_CIA,
       TYPE_FREE_ELECTRONS,
       TYPE_PARTICLES
   };


   enum {
       LINE_MIXING_TYPE_NONE,
       LINE_MIXING_TYPE_2NDORDER
   };
  

  Index Type() const { return mtype; }


  Index LineMixingType() const { return mline_mixing_type; }


private:
  Index mspecies;


  Index misotopologue;


  Numeric mlf;


  Numeric muf;

  Index mtype;

  Index mline_mixing_type;


  Index mcia_second;


  Index mcia_dataset;
};


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


typedef  Array<SpeciesTag> ArrayOfSpeciesTag;

typedef  Array<ArrayOfSpeciesTag> ArrayOfArrayOfSpeciesTag;


//======================================================================
//             Functions related to species and tags
//======================================================================

String get_tag_group_name( const ArrayOfSpeciesTag& tg );

String get_species_name( const ArrayOfSpeciesTag& tg );

Index find_first_species_tg( const ArrayOfArrayOfSpeciesTag& tgs,
                             const Index& spec );

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

void array_species_tag_from_string( ArrayOfSpeciesTag& tags,
                                    const String& names );

void check_abs_species( const ArrayOfArrayOfSpeciesTag& tags );

bool is_zeeman(const ArrayOfSpeciesTag& tg);


//--------------------------------------------------------------------------------
// Functions from ARTS-1-0. Are they still needed?
//--------------------------------------------------------------------------------

void get_tag_group_index_for_tag_group(
              Index&         tags1_index, 
        const ArrayOfArrayOfSpeciesTag&      tags1, 
        const Array<SpeciesTag>&  tags2 );


#endif // abs_species_h