OGS
CreateOutput.cpp
Go to the documentation of this file.
1 
11 #include "CreateOutput.h"
12 
13 #include <algorithm>
14 #include <numeric>
15 
16 #include "AqueousSolution.h"
17 #include "ChemicalSystem.h"
18 #include "KineticReactant.h"
19 #include "UserPunch.h"
20 
21 namespace ChemistryLib
22 {
23 namespace PhreeqcIOData
24 {
25 std::unique_ptr<Output> createOutput(
26  ChemicalSystem const& chemical_system,
27  std::unique_ptr<UserPunch> const& user_punch,
28  bool const use_high_precision,
29  std::string const& project_file_name)
30 {
31  auto const& components = chemical_system.aqueous_solution->components;
32  auto const& equilibrium_reactants = chemical_system.equilibrium_reactants;
33  auto const& kinetic_reactants = chemical_system.kinetic_reactants;
34  // Mark which phreeqc output items will be held.
35  std::vector<OutputItem> accepted_items{{"pH", ItemType::pH},
36  {"pe", ItemType::pe}};
37 
38  auto accepted_item = [](auto const& item)
39  { return OutputItem(item.name, item.item_type); };
40  std::transform(components.begin(), components.end(),
41  std::back_inserter(accepted_items), accepted_item);
42  std::transform(equilibrium_reactants.begin(), equilibrium_reactants.end(),
43  std::back_inserter(accepted_items), accepted_item);
44  for (auto const& kinetic_reactant : kinetic_reactants)
45  {
46  if (kinetic_reactant.fix_amount)
47  {
48  continue;
49  }
50  accepted_items.emplace_back(kinetic_reactant.name,
51  kinetic_reactant.item_type);
52  }
53 
54  if (user_punch)
55  {
56  auto const& secondary_variables = user_punch->secondary_variables;
57  accepted_items.reserve(accepted_items.size() +
58  secondary_variables.size());
59  std::transform(secondary_variables.begin(), secondary_variables.end(),
60  std::back_inserter(accepted_items), accepted_item);
61  }
62 
63  // Record ids of which phreeqc output items will be dropped.
64  BasicOutputSetups basic_output_setups(project_file_name,
65  use_high_precision);
66  auto const num_dropped_basic_items =
67  basic_output_setups.getNumberOfDroppedItems();
68  std::vector<int> dropped_item_ids(num_dropped_basic_items);
69  std::iota(dropped_item_ids.begin(), dropped_item_ids.end(), 0);
70 
71  auto const num_dvalue_equilibrium_reactants = equilibrium_reactants.size();
72  auto const num_dvalue_kinetic_reactants = kinetic_reactants.size();
73  int const num_dvalue_items =
74  num_dvalue_equilibrium_reactants + num_dvalue_kinetic_reactants;
75 
76  auto const num_basic_items =
77  basic_output_setups.getNumberOfItemsInDisplay();
78  auto const num_components = components.size();
79  auto dvalue_item_id = num_basic_items + num_components + 1;
80  for (int i = 0; i < num_dvalue_items; ++i)
81  {
82  dropped_item_ids.push_back(dvalue_item_id);
83  dvalue_item_id += 2;
84  }
85 
86  return std::make_unique<Output>(std::move(basic_output_setups),
87  std::move(accepted_items),
88  std::move(dropped_item_ids));
89 }
90 } // namespace PhreeqcIOData
91 } // namespace ChemistryLib
std::unique_ptr< Output > createOutput(ChemicalSystem const &chemical_system, std::unique_ptr< UserPunch > const &user_punch, bool const use_high_precision, std::string const &project_file_name)
std::unique_ptr< AqueousSolution > aqueous_solution
std::vector< KineticReactant > kinetic_reactants
std::vector< EquilibriumReactant > equilibrium_reactants