Detailed Description

Controls which built-in PHREEQC columns appear in the output file.

This class defines the SELECTED_OUTPUT / USER_PUNCH header for PHREEQC: which standard columns (pH, pe, solution ID, etc.) are requested, whether high precision is used, and what output file name PHREEQC writes.

The helper methods getNumberOfItemsInDisplay() and getNumberOfDroppedItems() report how many of those columns will be kept or ignored when OpenGeoSys later parses PHREEQC output.

Definition at line 28 of file ChemistryLib/PhreeqcIOData/Output.h.

#include <Output.h>

Public Member Functions
	BasicOutputSetups (std::string const &project_file_name, bool const use_high_precision_)

Static Public Member Functions
static int	getNumberOfItemsInDisplay ()
static int	getNumberOfDroppedItems ()

Public Attributes
std::string const	output_file

Private Attributes
bool const	use_high_precision

Static Private Attributes
static const bool	display_simulation_id = false
static const bool	display_state = true
static const bool	display_solution_id = true
static const bool	display_distance = false
static const bool	display_current_time = false
static const bool	display_time_step = false
static const bool	display_pH = true
static const bool	display_pe = true

Friends
std::ostream &	operator<< (std::ostream &os, BasicOutputSetups const &basic_output_setups)

Constructor & Destructor Documentation

◆ BasicOutputSetups()

ChemistryLib::PhreeqcIOData::BasicOutputSetups::BasicOutputSetups	(	std::string const &	project_file_name,
		bool const	use_high_precision_ )

explicit

Definition at line 32 of file ChemistryLib/PhreeqcIOData/Output.cpp.

    : output_file(specifyFileName(project_file_name, ".out")),
      use_high_precision(use_high_precision_)
{
}

References output_file, ChemistryLib::PhreeqcIOData::specifyFileName(), and use_high_precision.

Referenced by operator<<.

Member Function Documentation

◆ getNumberOfDroppedItems()

int ChemistryLib::PhreeqcIOData::BasicOutputSetups::getNumberOfDroppedItems ( )

inlinestatic

Definition at line 41 of file ChemistryLib/PhreeqcIOData/Output.h.

    {
        return display_simulation_id + display_state + display_solution_id +
               display_distance + display_current_time + display_time_step;
    }

References display_current_time, display_distance, display_simulation_id, display_solution_id, display_state, and display_time_step.

Referenced by ChemistryLib::PhreeqcIOData::createOutput().

◆ getNumberOfItemsInDisplay()

int ChemistryLib::PhreeqcIOData::BasicOutputSetups::getNumberOfItemsInDisplay ( )

inlinestatic

Definition at line 34 of file ChemistryLib/PhreeqcIOData/Output.h.

    {
        return display_simulation_id + display_state + display_solution_id +
               display_distance + display_current_time + display_time_step +
               display_pH + display_pe;
    }

References display_current_time, display_distance, display_pe, display_pH, display_simulation_id, display_solution_id, display_state, and display_time_step.

Referenced by ChemistryLib::PhreeqcIOData::createOutput().

◆ operator<<

std::ostream & operator<<	(	std::ostream &	os,
		BasicOutputSetups const &	basic_output_setups )

friend

Definition at line 39 of file ChemistryLib/PhreeqcIOData/Output.cpp.

{
    os << "SELECTED_OUTPUT"
       << "\n";
    os << "-file " << basic_output_setups.output_file << "\n";
    os << "-high_precision " << std::boolalpha
       << basic_output_setups.use_high_precision << "\n";
    os << "-simulation " << std::boolalpha
       << BasicOutputSetups::display_simulation_id << "\n";
    os << "-state " << std::boolalpha << BasicOutputSetups::display_state
       << "\n";
    os << "-distance " << std::boolalpha << BasicOutputSetups::display_distance
       << "\n";
    os << "-time " << std::boolalpha << BasicOutputSetups::display_current_time
       << "\n";
    os << "-step " << std::boolalpha << BasicOutputSetups::display_time_step
       << "\n";
 
    return os;
}