prism::DefaultSpeciesSummaryWriter Class Reference

Inheritance diagram for prism::DefaultSpeciesSummaryWriter:

Public Member Functions
virtual void	addMiscSummary (const std::vector< std::shared_ptr< Species > > &species) override
	Method for adding any random summaries to the top of the summary file.
virtual void	addLumpedSummary (std::map< std::string, std::vector< std::string > > lumped_map) override
	Method for summarizing which species have been lumped into which others.
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) override
	Method for summarizing the reactions that each species is involved in.
void	clear ()
	clears the state of the writer to begin a new file
std::ostringstream &	summaryString ()

Protected Attributes
std::ostringstream	_summary_str
	the stream that is used to construct the summary

Member Function Documentation

addLumpedSummary()

void prism::DefaultSpeciesSummaryWriter::addLumpedSummary ( std::map< std::string, std::vector< std::string > > lumped_map )

overridevirtual

Method for summarizing which species have been lumped into which others.

Implements prism::SpeciesSummaryWriterBase.

addMiscSummary()

void prism::DefaultSpeciesSummaryWriter::addMiscSummary ( const std::vector< std::shared_ptr< Species > > & species )

overridevirtual

Method for adding any random summaries to the top of the summary file.

Implements prism::SpeciesSummaryWriterBase.

addSpeciesSummary()

void prism::DefaultSpeciesSummaryWriter::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 )

overridevirtual

Method for summarizing the reactions that each species is involved in.

Implements prism::SpeciesSummaryWriterBase.

---

The documentation for this class was generated from the following files:

• /home/runner/work/prism/prism/include/prism/DefaultSpeciesSummaryWriter.h
• /home/runner/work/prism/prism/src/DefaultSpeciesSummaryWriter.C