PRISM
 v0.0.0
Loading...
Searching...
No Matches
SpeciesSummaryWriterBase.h
1//* This file is a part of PRISM: Plasma Reaction Input SysteM,
2//* A library for parcing chemical reaction networks for plasma chemistry
3//* https://github.com/NCSU-ComPS-Group/prism
4//*
5//* Licensed under MIT, please see LICENSE for details
6//* https://opensource.org/license/mit
7//*
8//* Copyright 2024, North Carolina State University
9//* ALL RIGHTS RESERVED
10//*
11#pragma once
12
13#include <sstream>
14#include <string>
15#include <vector>
16#include <map>
17#include <memory>
18
19namespace prism
20{
21
23{
24
25public:
36 void clear()
37 {
38 _summary_str.str("");
39 _summary_str.clear();
40 }
41
42 /*
43 * Getter method for the summary string
44 */
45 std::ostringstream & summaryString() { return _summary_str; }
49 virtual void addMiscSummary() = 0;
53 virtual void addLumpedSummary(std::map<std::string, std::vector<std::string>> lumped_map) = 0;
57 virtual void addSpeciesSummary() = 0;
58
59protected:
61 std::ostringstream _summary_str;
62};
63
64}
SpeciesSummaryWriterBase()
Helper method for writing species summary for the reaction mechanism several methods of this type get...
Definition SpeciesSummaryWriterBase.h:32
std::ostringstream _summary_str
the stream that is used to construct the summary
Definition SpeciesSummaryWriterBase.h:61
virtual void addLumpedSummary(std::map< std::string, std::vector< std::string > > lumped_map)=0
Method for summarizing which species have been lumped into which others.
virtual void addMiscSummary()=0
Method for adding any random summaries to the top of the summary file.
virtual void addSpeciesSummary()=0
Method for summarizing the reactions that each species is involved in.
void clear()
clears the state of the writer to begin a new file
Definition SpeciesSummaryWriterBase.h:36