SpeciesSummaryWriterBase.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 <sstream>
#include <string>
#include <vector>
#include <map>
#include <memory>
 
namespace prism
{
 
class Species;
 
class Reaction;
 
class SpeciesSummaryWriterBase
{
 
public:
  SpeciesSummaryWriterBase() {}
  void clear()
  {
    _summary_str.str("");
    _summary_str.clear();
  }
 
  /*
   * Getter method for the summary string
   */
  std::ostringstream & summaryString() { return _summary_str; }
  virtual void addMiscSummary(const std::vector<std::shared_ptr<Species>> & species) = 0;
  virtual void addLumpedSummary(std::map<std::string, std::vector<std::string>> lumped_map) = 0;
  virtual void addSpeciesSummary(const std::vector<std::shared_ptr<Species>> & species,
                                 const std::vector<std::shared_ptr<Reaction>> & rate_based,
                                 const std::vector<std::shared_ptr<Reaction>> & xsec_based) = 0;
 
protected:
  std::ostringstream _summary_str;
};
 
}