SpeciesBase.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 <iostream>
 
namespace prism
{
class SpeciesBase
{
public:
  SpeciesBase(const std::string & name);
  virtual ~SpeciesBase() {}
  bool operator==(const SpeciesBase & other) const;
  bool operator!=(const SpeciesBase & other) const;
  const std::string & name() const { return _name; }
  double mass() const { return _mass; }
  double molarMass() const { return _molar_mass; }
  int chargeNumber() const { return _charge_num; }
  double charge() const { return _charge; }
  const std::string & latexRepresentation() const { return _latex_name; }
  const std::string & neutralGroundState() const { return _neutral_ground_state; }
  virtual std::string to_string() const;
 
protected:
  std::string _name;
  double _mass;
  double _molar_mass;
  double _charge;
  int _charge_num;
  std::string _latex_name;
  std::string _neutral_ground_state;
  std::string checkName(const std::string & name);
  virtual void setMass() = 0;
  virtual void setCharge() = 0;
  virtual void setLatexName() = 0;
  virtual void setNeutralGroundState() = 0;
};
}
 
template <>
struct std::hash<prism::SpeciesBase>
{
  size_t operator()(const prism::SpeciesBase & obj) const;
};