SubSpecies.h

//* This file is a part of PRISM: Plasma Reaction Input SysteM,
//* A library for parcing chemical reaction networks for plasma chemistry
//* https://github.com/NCSU-ComPS-Group/prism
//*
//* Licensed under MIT, please see LICENSE for details
//* https://opensource.org/license/mit
//*
//* Copyright 2024, North Carolina State University
//* ALL RIGHTS RESERVED
//*
#pragma once
 
#include <string>
 
#include "SpeciesBase.h"
 
class SpeciesFactory;
 
namespace prism
{
class SubSpecies : public SpeciesBase
{
public:
  SubSpecies(const std::string & name);

  bool operator==(const SubSpecies & other) const;
  bool operator!=(const SubSpecies & other) const;

  const std::string & base() const { return _base; }
  const std::string & modifier() const { return _modifier; }
  unsigned int subscript() const { return _subscript; }
 
  virtual std::string to_string() const override;
 
  friend std::string to_string(const prism::SubSpecies & s);
  friend std::string to_string(prism::SubSpecies & s);
  friend std::ostream & operator<<(std::ostream & os, prism::SubSpecies & s);
  friend std::ostream & operator<<(std::ostream & os, const prism::SubSpecies & s);
 
private:
  const std::string _base;
  std::string _modifier;
  const unsigned int _subscript;
  std::string setBase();
  std::string setModifier();
  unsigned int setSubscript();
  void setMass() override;
  void setCharge() override;
  void setLatexName() override;
 
  virtual void setNeutralGroundState() override;
};
} // namespace RXN
template <>
struct std::hash<prism::SubSpecies>
{
  size_t operator()(const prism::SubSpecies & obj) const;
};