32 vector<AnyMap> speciesDefs;
35 speciesDefs.emplace_back(
species(
name)->parameters(
this));
37 root[
"species"] = std::move(speciesDefs);
47 explicit PhaseEquilGuard(
ThermoPhase& phase) : m_phase(phase)
49 m_phase.beginEquilibrate();
54 m_phase.endEquilibrate();
67 for (
size_t k = 0; k <
nSpecies(); k++) {
87 return Units(1.0, 0, -
static_cast<double>(
nDim()), 0, 0, 0, 1);
98 for (
size_t k = 0; k <
nSpecies(); k++) {
106 for (
size_t k = 0; k <
m_kk; k++) {
107 lnac[k] = std::log(lnac[k]);
115 for (
size_t k = 0; k <
m_kk; k++) {
122 vector<double> vbar(
m_kk);
126 for (
size_t k = 0; k <
m_kk; k++) {
127 ubar[k] -= pi_t * vbar[k];
174 }
catch (std::exception&) {
186 }
catch (std::exception&) {
199 }
catch (std::exception&) {
207 AnyMap state = input_state;
210 if (state.
hasKey(
"mass-fractions")) {
211 state[
"Y"] = state[
"mass-fractions"];
212 state.
erase(
"mass-fractions");
214 if (state.
hasKey(
"mole-fractions")) {
215 state[
"X"] = state[
"mole-fractions"];
216 state.
erase(
"mole-fractions");
218 if (state.
hasKey(
"temperature")) {
219 state[
"T"] = state[
"temperature"];
221 if (state.
hasKey(
"pressure")) {
222 state[
"P"] = state[
"pressure"];
224 if (state.
hasKey(
"enthalpy")) {
225 state[
"H"] = state[
"enthalpy"];
227 if (state.
hasKey(
"int-energy")) {
228 state[
"U"] = state[
"int-energy"];
230 if (state.
hasKey(
"internal-energy")) {
231 state[
"U"] = state[
"internal-energy"];
233 if (state.
hasKey(
"specific-volume")) {
234 state[
"V"] = state[
"specific-volume"];
236 if (state.
hasKey(
"entropy")) {
237 state[
"S"] = state[
"entropy"];
239 if (state.
hasKey(
"density")) {
240 state[
"D"] = state[
"density"];
242 if (state.
hasKey(
"vapor-fraction")) {
243 state[
"Q"] = state[
"vapor-fraction"];
248 if (state[
"X"].is<string>()) {
254 }
else if (state.
hasKey(
"Y")) {
255 if (state[
"Y"].is<string>()) {
263 if (state.
size() == 0) {
266 double T = state.
convert(
"T",
"K");
267 double P = state.
convert(
"P",
"Pa");
303 }
else if (state.
hasKey(
"T")) {
305 }
else if (state.
hasKey(
"P")) {
309 "'state' did not specify a recognized set of properties.\n"
310 "Keys provided were: {}", input_state.
keys_str());
323 double rtol,
bool doUV)
333 "Input specific volume is too small or negative. v = {}", v);
339 "Input pressure is too small or negative. p = {}", p);
352 }
else if (Tnew < Tmin) {
366 bool ignoreBounds =
false;
369 bool unstablePhase =
false;
372 double Tunstable = -1.0;
373 bool unstablePhaseNew =
false;
376 for (
int n = 0; n < 500; n++) {
381 unstablePhase =
true;
385 dt =
clip((Htarget - Hold)/cpd, -100.0, 100.0);
392 if ((dt > 0.0 && unstablePhase) || (dt <= 0.0 && !unstablePhase)) {
393 if (Hbot < Htarget && Tnew < (0.75 * Tbot + 0.25 * Told)) {
394 dt = 0.75 * (Tbot - Told);
397 }
else if (Htop > Htarget && Tnew > (0.75 * Ttop + 0.25 * Told)) {
398 dt = 0.75 * (Ttop - Told);
403 if (Tnew > Tmax && !ignoreBounds) {
406 if (Hmax >= Htarget) {
407 if (Htop < Htarget) {
416 if (Tnew < Tmin && !ignoreBounds) {
419 if (Hmin <= Htarget) {
420 if (Hbot > Htarget) {
433 for (
int its = 0; its < 10; its++) {
435 if (Tnew < Told / 3.0) {
437 dt = -2.0 * Told / 3.0;
448 unstablePhaseNew =
true;
451 unstablePhaseNew =
false;
454 if (unstablePhase ==
false && unstablePhaseNew ==
true) {
459 if (Hnew == Htarget) {
461 }
else if (Hnew > Htarget && (Htop < Htarget || Hnew < Htop)) {
464 }
else if (Hnew < Htarget && (Hbot > Htarget || Hnew > Hbot)) {
469 double Herr = Htarget - Hnew;
470 double acpd = std::max(fabs(cpd), 1.0E-5);
471 double denom = std::max(fabs(Htarget), acpd * Tnew);
472 double HConvErr = fabs((Herr)/denom);
473 if (HConvErr < rtol || fabs(dt/Tnew) < rtol) {
481 string ErrString =
"No convergence in 500 iterations\n";
483 ErrString += fmt::format(
484 "\tTarget Internal Energy = {}\n"
485 "\tCurrent Specific Volume = {}\n"
486 "\tStarting Temperature = {}\n"
487 "\tCurrent Temperature = {}\n"
488 "\tCurrent Internal Energy = {}\n"
489 "\tCurrent Delta T = {}\n",
490 Htarget, v, Tinit, Tnew, Hnew, dt);
492 ErrString += fmt::format(
493 "\tTarget Enthalpy = {}\n"
494 "\tCurrent Pressure = {}\n"
495 "\tStarting Temperature = {}\n"
496 "\tCurrent Temperature = {}\n"
497 "\tCurrent Enthalpy = {}\n"
498 "\tCurrent Delta T = {}\n",
499 Htarget, p, Tinit, Tnew, Hnew, dt);
502 ErrString += fmt::format(
503 "\t - The phase became unstable (Cp < 0) T_unstable_last = {}\n",
507 throw CanteraError(
"ThermoPhase::setState_HPorUV (UV)", ErrString);
509 throw CanteraError(
"ThermoPhase::setState_HPorUV (HP)", ErrString);
519 }
catch (std::exception&) {
532 }
catch (std::exception&) {
539 double rtol,
bool doSV)
547 "Input specific volume is too small or negative. v = {}", v);
553 "Input pressure is too small or negative. p = {}", p);
566 }
else if (Tnew < Tmin) {
580 bool ignoreBounds =
false;
583 bool unstablePhase =
false;
584 double Tunstable = -1.0;
585 bool unstablePhaseNew =
false;
588 for (
int n = 0; n < 500; n++) {
593 unstablePhase =
true;
597 dt =
clip((Starget - Sold)*Told/cpd, -100.0, 100.0);
601 if ((dt > 0.0 && unstablePhase) || (dt <= 0.0 && !unstablePhase)) {
602 if (Sbot < Starget && Tnew < Tbot) {
603 dt = 0.75 * (Tbot - Told);
606 }
else if (Stop > Starget && Tnew > Ttop) {
607 dt = 0.75 * (Ttop - Told);
612 if (Tnew > Tmax && !ignoreBounds) {
615 if (Smax >= Starget) {
616 if (Stop < Starget) {
624 }
else if (Tnew < Tmin && !ignoreBounds) {
627 if (Smin <= Starget) {
628 if (Sbot > Starget) {
641 for (
int its = 0; its < 10; its++) {
647 unstablePhaseNew =
true;
650 unstablePhaseNew =
false;
653 if (unstablePhase ==
false && unstablePhaseNew ==
true) {
658 if (Snew == Starget) {
660 }
else if (Snew > Starget && (Stop < Starget || Snew < Stop)) {
663 }
else if (Snew < Starget && (Sbot > Starget || Snew > Sbot)) {
668 double Serr = Starget - Snew;
669 double acpd = std::max(fabs(cpd), 1.0E-5);
670 double denom = std::max(fabs(Starget), acpd * Tnew);
671 double SConvErr = fabs((Serr * Tnew)/denom);
672 if (SConvErr < rtol || fabs(dt/Tnew) < rtol) {
680 string ErrString =
"No convergence in 500 iterations\n";
682 ErrString += fmt::format(
683 "\tTarget Entropy = {}\n"
684 "\tCurrent Specific Volume = {}\n"
685 "\tStarting Temperature = {}\n"
686 "\tCurrent Temperature = {}\n"
687 "\tCurrent Entropy = {}\n"
688 "\tCurrent Delta T = {}\n",
689 Starget, v, Tinit, Tnew, Snew, dt);
691 ErrString += fmt::format(
692 "\tTarget Entropy = {}\n"
693 "\tCurrent Pressure = {}\n"
694 "\tStarting Temperature = {}\n"
695 "\tCurrent Temperature = {}\n"
696 "\tCurrent Entropy = {}\n"
697 "\tCurrent Delta T = {}\n",
698 Starget, p, Tinit, Tnew, Snew, dt);
701 ErrString += fmt::format(
"\t - The phase became unstable (Cp < 0) T_unstable_last = {}\n",
705 throw CanteraError(
"ThermoPhase::setState_SPorSV (SV)", ErrString);
707 throw CanteraError(
"ThermoPhase::setState_SPorSV (SP)", ErrString);
721 for (
size_t k = 0; k !=
m_kk; ++k) {
725 o2req += x *
nAtoms(k, iC);
728 o2req += x *
nAtoms(k, iS);
731 o2req += x * 0.25 *
nAtoms(k, iH);
736 "No composition specified");
747 for (
size_t k = 0; k !=
m_kk; ++k) {
753 "No composition specified");
755 return 0.5 * o2pres / sum;
771 parseCompString(fuelComp.find(
":") != string::npos ? fuelComp : fuelComp+
":1.0"),
772 parseCompString(oxComp.find(
":") != string::npos ? oxComp : oxComp+
":1.0"),
777 span<const double> oxComp,
780 vector<double> fuel, ox;
781 if (basis == ThermoBasis::molar) {
793 if (o2_required_fuel < 0.0 || o2_required_ox > 0.0) {
795 "Fuel composition contains too much oxygen or "
796 "oxidizer contains not enough oxygen. "
797 "Fuel and oxidizer composition mixed up?");
800 if (o2_required_ox == 0.0) {
801 return std::numeric_limits<double>::infinity();
804 return o2_required_fuel / (-o2_required_ox);
812 "Equivalence ratio phi must be >= 0");
817 vector<double> fuel, ox;
818 if (basis == ThermoBasis::molar) {
828 double sum_f = std::accumulate(fuelComp.begin(), fuelComp.end(), 0.0);
829 double sum_o = std::accumulate(oxComp.begin(), oxComp.end(), 0.0);
831 vector<double> y(
m_kk);
832 for (
size_t k = 0; k !=
m_kk; ++k) {
833 y[k] = phi * fuelComp[k]/sum_f + AFR_st * oxComp[k]/sum_o;
844 parseCompString(fuelComp.find(
":") != string::npos ? fuelComp : fuelComp+
":1.0"),
845 parseCompString(oxComp.find(
":") != string::npos ? oxComp : oxComp+
":1.0"),
863 if (o2_present == 0.0) {
864 return std::numeric_limits<double>::infinity();
867 return o2_required / o2_present;
883 parseCompString(fuelComp.find(
":") != string::npos ? fuelComp : fuelComp+
":1.0"),
884 parseCompString(oxComp.find(
":") != string::npos ? oxComp : oxComp+
":1.0"),
889 span<const double> oxComp,
ThermoBasis basis)
const
898 return std::numeric_limits<double>::infinity();
901 vector<double> fuel, ox;
902 if (basis == ThermoBasis::molar) {
913 return std::max(Z / (1.0 - Z) * AFR_st, 0.0);
928 parseCompString(fuelComp.find(
":") != string::npos ? fuelComp : fuelComp+
":1.0"),
929 parseCompString(oxComp.find(
":") != string::npos ? oxComp : oxComp+
":1.0"),
938 if (mixFrac < 0.0 || mixFrac > 1.0) {
940 "Mixture fraction must be between 0 and 1");
943 vector<double> fuel, ox;
944 if (basis == ThermoBasis::molar) {
953 double sum_yf = std::accumulate(fuelComp.begin(), fuelComp.end(), 0.0);
954 double sum_yo = std::accumulate(oxComp.begin(), oxComp.end(), 0.0);
956 if (sum_yf == 0.0 || sum_yo == 0.0) {
958 "No fuel and/or oxidizer composition specified");
963 vector<double> y(
m_kk);
965 for (
size_t k = 0; k !=
m_kk; ++k) {
966 y[k] = mixFrac * fuelComp[k]/sum_yf + (1.0-mixFrac) * oxComp[k]/sum_yo;
976 const string& element)
const
987 parseCompString(fuelComp.find(
":") != string::npos ? fuelComp : fuelComp+
":1.0"),
988 parseCompString(oxComp.find(
":") != string::npos ? oxComp : oxComp+
":1.0"),
993 span<const double> oxComp,
998 vector<double> fuel, ox;
999 if (basis == ThermoBasis::molar) {
1008 if (element ==
"Bilger")
1015 if (o2_required_fuel < 0.0 || o2_required_ox > 0.0) {
1017 "Fuel composition contains too much oxygen or "
1018 "oxidizer contains not enough oxygen. "
1019 "Fuel and oxidizer composition mixed up?");
1022 double denominator = o2_required_fuel - o2_required_ox;
1024 if (denominator == 0.0) {
1026 "Fuel and oxidizer have the same composition");
1029 double Z = (o2_required_mix - o2_required_ox) / denominator;
1031 return std::min(std::max(Z, 0.0), 1.0);
1034 double sum_yf = std::accumulate(fuelComp.begin(), fuelComp.end(), 0.0);
1035 double sum_yo = std::accumulate(oxComp.begin(), oxComp.end(), 0.0);
1037 if (sum_yf == 0.0 || sum_yo == 0.0) {
1039 "No fuel and/or oxidizer composition specified");
1042 auto elementalFraction = [
this](
size_t m, span<const double> y) {
1044 for (
size_t k = 0; k !=
m_kk; ++k) {
1051 double Z_m_fuel = elementalFraction(m, fuelComp)/sum_yf;
1052 double Z_m_ox = elementalFraction(m, oxComp)/sum_yo;
1055 if (Z_m_fuel == Z_m_ox) {
1057 "Fuel and oxidizer have the same composition for element {}",
1060 double Z = (Z_m_mix - Z_m_ox) / (Z_m_fuel - Z_m_ox);
1061 return std::min(std::max(Z, 0.0), 1.0);
1078 if (inputFile.empty()) {
1082 size_t dot = inputFile.find_last_of(
".");
1085 extension = inputFile.substr(
dot+1);
1087 if (extension ==
"xml" || extension ==
"cti") {
1089 "The CTI and XML formats are no longer supported.");
1093 auto& phase =
root[
"phases"].getMapWhere(
"name",
id);
1102 "Missing species thermo data");
1114 "Temperature ({}), pressure ({}) and vapor fraction ({}) "
1115 "are inconsistent, above the critical temperature.",
1121 if (std::abs(Psat / P - 1) < 1e-6) {
1123 }
else if ((Q == 0 && P >= Psat) || (Q == 1 && P <= Psat)) {
1127 "Temperature ({}), pressure ({}) and vapor fraction ({}) "
1128 "are inconsistent.\nPsat at this T: {}\n"
1129 "Consider specifying the state using two fully independent "
1130 "properties (for example, temperature and density)",
1137 if (!spec->thermo) {
1139 "Species {} has no thermo data", spec->name);
1143 spec->thermo->validate(spec->name);
1151 if (!spec->thermo) {
1153 "Species {} has no thermo data", spec->name);
1158 "New species '{}' does not match existing species '{}' at index {}",
1161 spec->thermo->validate(spec->name);
1182 phaseNode[
"name"] =
name();
1185 for (
size_t i = 0; i <
nElements(); i++) {
1193 if (stateVars.count(
"T")) {
1197 if (stateVars.count(
"D")) {
1198 state[
"density"].setQuantity(
density(),
"kg/m^3");
1199 }
else if (stateVars.count(
"P")) {
1200 state[
"P"].setQuantity(
pressure(),
"Pa");
1203 if (stateVars.count(
"Y")) {
1204 map<string, double> Y;
1205 for (
size_t k = 0; k <
m_kk; k++) {
1213 }
else if (stateVars.count(
"X")) {
1214 map<string, double> X;
1215 for (
size_t k = 0; k <
m_kk; k++) {
1225 phaseNode[
"state"] = std::move(state);
1229 phaseNode[
"__type__"] =
"Phase";
1249 double rtol,
int max_steps,
int max_iter,
1250 int estimate_equil,
int log_level)
1252 if (solver ==
"auto" || solver ==
"element_potential") {
1253 vector<double> initial_state(
stateSize());
1255 debuglog(
"Trying ChemEquil solver\n", log_level);
1257 PhaseEquilGuard guard(*
this);
1261 int ret = E.
equilibrate(*
this, XY.c_str(), log_level-1);
1264 "ChemEquil solver failed. Return code: {}", ret);
1266 debuglog(
"ChemEquil solver succeeded\n", log_level);
1268 }
catch (std::exception& err) {
1269 debuglog(
"ChemEquil solver failed.\n", log_level);
1272 if (solver ==
"auto") {
1279 if (solver ==
"auto" || solver ==
"vcs" || solver ==
"gibbs") {
1285 M.
equilibrate(XY, solver, rtol, max_steps, max_iter,
1286 estimate_equil, log_level);
1290 if (solver !=
"auto") {
1292 "Invalid solver specified: '{}'", solver);
1299 for (
size_t m = 0; m <
m_kk; m++) {
1300 for (
size_t k = 0; k <
m_kk; k++) {
1301 dlnActCoeffdlnN[ld * k + m] = 0.0;
1307void ThermoPhase::getdlnActCoeffdlnN_numderiv(
const size_t ld,
1308 span<double> dlnActCoeffdlnN)
1311 dlnActCoeffdlnN.size(), ld*
m_kk);
1312 double deltaMoles_j = 0.0;
1316 vector<double> ActCoeff_Base(
m_kk);
1318 vector<double> Xmol_Base(
m_kk);
1322 vector<double> ActCoeff(
m_kk);
1323 vector<double> Xmol(
m_kk);
1324 double v_totalMoles = 1.0;
1325 double TMoles_base = v_totalMoles;
1328 for (
size_t j = 0; j <
m_kk; j++) {
1334 double moles_j_base = v_totalMoles * Xmol_Base[j];
1335 deltaMoles_j = 1.0E-7 * moles_j_base + v_totalMoles * 1.0E-13 + 1.0E-150;
1339 v_totalMoles = TMoles_base + deltaMoles_j;
1340 for (
size_t k = 0; k <
m_kk; k++) {
1341 Xmol[k] = Xmol_Base[k] * TMoles_base / v_totalMoles;
1343 Xmol[j] = (moles_j_base + deltaMoles_j) / v_totalMoles;
1351 span<double> lnActCoeffCol = dlnActCoeffdlnN.subspan(ld * j,
m_kk);
1352 for (
size_t k = 0; k <
m_kk; k++) {
1353 lnActCoeffCol[k] = (2*moles_j_base + deltaMoles_j) *(ActCoeff[k] - ActCoeff_Base[k]) /
1354 ((ActCoeff[k] + ActCoeff_Base[k]) * deltaMoles_j);
1357 v_totalMoles = TMoles_base;
1366 if (
type() ==
"none") {
1368 "Not implemented for thermo model 'none'");
1371 fmt::memory_buffer b;
1373 int name_width = 18;
1375 string blank_leader = fmt::format(
"{:{}}",
"", name_width);
1377 string string_property = fmt::format(
"{{:>{}}} {{}}\n", name_width);
1379 string one_property = fmt::format(
"{{:>{}}} {{:<.5g}} {{}}\n", name_width);
1381 constexpr auto two_prop_header =
"{} {:^15} {:^15}\n";
1382 string kg_kmol_header = fmt::format(
1383 two_prop_header, blank_leader,
"1 kg",
"1 kmol"
1385 string Y_X_header = fmt::format(
1386 two_prop_header, blank_leader,
"mass frac. Y",
"mole frac. X"
1388 string two_prop_sep = fmt::format(
1389 "{} {:-^15} {:-^15}\n", blank_leader,
"",
""
1391 string two_property = fmt::format(
1392 "{{:>{}}} {{:15.5g}} {{:15.5g}} {{}}\n", name_width
1395 string three_prop_header = fmt::format(
1396 "{} {:^15} {:^15} {:^15}\n", blank_leader,
"mass frac. Y",
1397 "mole frac. X",
"chem. pot. / RT"
1399 string three_prop_sep = fmt::format(
1400 "{} {:-^15} {:-^15} {:-^15}\n", blank_leader,
"",
"",
""
1402 string three_property = fmt::format(
1403 "{{:>{}}} {{:15.5g}} {{:15.5g}} {{:15.5g}}\n", name_width
1408 fmt_append(b,
"\n {}:\n",
name());
1410 fmt_append(b,
"\n");
1411 fmt_append(b, one_property,
"temperature",
temperature(),
"K");
1412 fmt_append(b, one_property,
"pressure",
pressure(),
"Pa");
1413 fmt_append(b, one_property,
"density",
density(),
"kg/m^3");
1414 fmt_append(b, one_property,
1419 fmt_append(b, one_property,
"potential", phi,
"V");
1422 fmt_append(b, string_property,
"phase of matter",
phaseOfMatter());
1425 fmt_append(b,
"\n");
1426 fmt_append(b, kg_kmol_header);
1427 fmt_append(b, two_prop_sep);
1428 fmt_append(b, two_property,
1430 fmt_append(b, two_property,
1432 fmt_append(b, two_property,
1434 fmt_append(b, two_property,
1436 fmt_append(b, two_property,
1439 fmt_append(b, two_property,
1442 fmt_append(b, string_property,
1443 "heat capacity c_v",
"<not implemented>");
1447 vector<double> x(
m_kk);
1448 vector<double> y(
m_kk);
1449 vector<double> mu(
m_kk);
1454 double xMinor = 0.0;
1455 double yMinor = 0.0;
1456 fmt_append(b,
"\n");
1458 fmt_append(b, three_prop_header);
1459 fmt_append(b, three_prop_sep);
1460 for (
size_t k = 0; k <
m_kk; k++) {
1461 if (abs(x[k]) >= threshold) {
1463 fmt_append(b, three_property,
1466 fmt_append(b, two_property,
speciesName(k), y[k], x[k],
"");
1475 fmt_append(b, Y_X_header);
1476 fmt_append(b, two_prop_sep);
1477 for (
size_t k = 0; k <
m_kk; k++) {
1478 if (abs(x[k]) >= threshold) {
1479 fmt_append(b, two_property,
speciesName(k), y[k], x[k],
"");
1488 string minor = fmt::format(
"[{:+5d} minor]", nMinor);
1489 fmt_append(b, two_property, minor, yMinor, xMinor,
"");
1492 return to_string(b) + err.
what();
1494 return to_string(b);
Headers for the MultiPhase object that is used to set up multiphase equilibrium problems (see Chemica...
Pure Virtual Base class for individual species reference state thermodynamic managers and text for th...
Declaration for class Cantera::Species.
Headers for the factory class that can create known ThermoPhase objects (see Thermodynamic Properties...
Header file for class ThermoPhase, the base class for phases with thermodynamic properties,...
A map of string keys to values whose type can vary at runtime.
size_t size() const
Returns the number of elements in this map.
bool hasKey(const string &key) const
Returns true if the map contains an item named key.
void applyUnits()
Use the supplied UnitSystem to set the default units, and recursively process overrides from nodes na...
double convert(const string &key, const string &units) const
Convert the item stored by the given key to the units specified in units.
void setFlowStyle(bool flow=true)
Use "flow" style when outputting this AnyMap to YAML.
void erase(const string &key)
Erase the value held by key.
static AnyMap fromYamlFile(const string &name, const string &parent_name="")
Create an AnyMap from a YAML file.
void update(const AnyMap &other, bool keepExisting=true)
Add items from other to this AnyMap.
static bool addOrderingRules(const string &objectType, const vector< vector< string > > &specs)
Add global rules for setting the order of elements when outputting AnyMap objects to YAML.
string keys_str() const
Return a string listing the keys in this AnyMap, for use in error messages, for example.
Base class for exceptions thrown by Cantera classes.
const char * what() const override
Get a description of the error.
Class ChemEquil implements a chemical equilibrium solver for single-phase solutions.
int equilibrate(ThermoPhase &s, const char *XY, int loglevel=0)
Equilibrate a phase, holding the elemental composition fixed at the initial value found within the Th...
EquilOpt options
Options controlling how the calculation is carried out.
double relTolerance
Relative tolerance.
int maxIterations
Maximum number of iterations.
string canonicalize(const string &name)
Get the canonical name registered for a type.
A class for multiphase mixtures.
void init()
Process phases and build atomic composition array.
void addPhase(shared_ptr< ThermoPhase > p, double moles)
Add a phase to the mixture.
A species thermodynamic property manager for a phase.
bool ready(size_t nSpecies)
Check if data for all species (0 through nSpecies-1) has been installed.
virtual void install_STIT(size_t index, shared_ptr< SpeciesThermoInterpType > stit)
Install a new species thermodynamic property parameterization for one species.
virtual void modifySpecies(size_t index, shared_ptr< SpeciesThermoInterpType > spec)
Modify the species thermodynamic property parameterization for a species.
virtual void resetHf298(const size_t k)
Restore the original heat of formation of one or more species.
An error indicating that an unimplemented function has been called.
void getMoleFractions(span< double > x) const
Get the species mole fraction vector.
void getMassFractions(span< double > y) const
Get the species mass fractions.
double massFraction(size_t k) const
Return the mass fraction of a single species.
virtual bool addSpecies(shared_ptr< Species > spec)
Add a Species to this Phase.
void assertCompressible(const string &setter) const
Ensure that phase is compressible.
size_t nSpecies() const
Returns the number of species in the phase.
virtual map< string, size_t > nativeState() const
Return a map of properties defining the native state of a substance.
size_t m_kk
Number of species in the phase.
virtual void modifySpecies(size_t k, shared_ptr< Species > spec)
Modify the thermodynamic data associated with a species.
size_t nDim() const
Returns the number of spatial dimensions (1, 2, or 3)
span< const double > molecularWeights() const
Return a const reference to the internal vector of molecular weights.
void setState_TD(double t, double rho)
Set the internally stored temperature (K) and density (kg/m^3)
double temperature() const
Temperature (K).
virtual void setPressure(double p)
Set the internally stored pressure (Pa) at constant temperature and composition.
double meanMolecularWeight() const
The mean molecular weight. Units: (kg/kmol)
virtual void restorePartialState(span< const double > state)
Set the internal thermodynamic state of the phase, excluding composition.
span< const double > massFractions() const
Return a view of the mass fraction array.
void setMassFractionsByName(const Composition &yMap)
Set the species mass fractions by name.
string speciesName(size_t k) const
Name of the species with index k.
void moleFractionsToMassFractions(span< const double > X, span< double > Y) const
Converts a mixture composition from mass fractions to mole fractions.
virtual void setDensity(const double density_)
Set the internally stored density (kg/m^3) of the phase.
virtual size_t stateSize() const
Return size of vector defining internal state of the phase.
vector< double > getCompositionFromMap(const Composition &comp) const
Converts a Composition to a vector with entries for each species Species that are not specified are s...
void setMoleFractionsByName(const Composition &xMap)
Set the species mole fractions by name.
double moleFraction(size_t k) const
Return the mole fraction of a single species.
const vector< string > & elementNames() const
Return a read-only reference to the vector of element names.
virtual double density() const
Density (kg/m^3).
double nAtoms(size_t k, size_t m) const
Number of atoms of element m in species k.
virtual void setTemperature(double temp)
Set the internally stored temperature of the phase (K).
size_t nElements() const
Number of elements.
virtual void setMoleFractions(span< const double > x)
Set the mole fractions to the specified values.
const vector< string > & speciesNames() const
Return a const reference to the vector of species names.
size_t elementIndex(const string &name, bool raise=true) const
Return the index of element named 'name'.
virtual void setMassFractions(span< const double > y)
Set the mass fractions to the specified values and normalize them.
double molecularWeight(size_t k) const
Molecular weight of species k.
shared_ptr< Species > species(const string &name) const
Return the Species object for the named species.
virtual void invalidateCache()
Invalidate any cached values which are normally updated only when a change in state is detected.
virtual void setMassFractions_NoNorm(span< const double > y)
Set the mass fractions to the specified values without normalizing.
virtual size_t partialStateSize() const
Get the size of the partial state vector of the phase.
virtual void savePartialState(span< double > state) const
Save the current thermodynamic state of the phase, excluding composition.
virtual void restoreState(span< const double > state)
Restore the state of the phase from a previously saved state vector.
virtual double pressure() const
Return the thermodynamic pressure (Pa).
string elementName(size_t m) const
Name of the element with index m.
double charge(size_t k) const
Dimensionless electrical charge of a single molecule of species k The charge is normalized by the the...
string name() const
Return the name of the phase.
virtual void saveState(span< double > state) const
Write to array 'state' the current internal state.
static ThermoFactory * factory()
Static function that creates a static instance of the factory.
Base class for a phase with thermodynamic properties.
int m_ssConvention
Contains the standard state convention.
virtual double critTemperature() const
Critical temperature (K).
virtual void setState_HP(double h, double p, double tol=1e-9)
Set the internally stored specific enthalpy (J/kg) and pressure (Pa) of the phase.
virtual void getPartialMolarVolumes(span< double > vbar) const
Return an array of partial molar volumes for the species in the mixture.
double electricPotential() const
Returns the electric potential of this phase (V).
virtual void setState_UV(double u, double v, double tol=1e-9)
Set the specific internal energy (J/kg) and specific volume (m^3/kg).
virtual double cp_mole() const
Molar heat capacity at constant pressure and composition [J/kmol/K].
double equivalenceRatio() const
Compute the equivalence ratio for the current mixture from available oxygen and required oxygen.
virtual void setParameters(const AnyMap &phaseNode, const AnyMap &rootNode=AnyMap())
Set equation of state parameters from an AnyMap phase description.
virtual void getParameters(AnyMap &phaseNode) const
Store the parameters of a ThermoPhase object such that an identical one could be reconstructed using ...
virtual double enthalpy_mole() const
Molar enthalpy. Units: J/kmol.
virtual void setState_TP(double t, double p)
Set the temperature (K) and pressure (Pa)
virtual double standardConcentration(size_t k=0) const
Return the standard concentration for the kth species.
virtual void setState_TV(double t, double v, double tol=1e-9)
Set the temperature (K) and specific volume (m^3/kg).
virtual double logStandardConc(size_t k=0) const
Natural logarithm of the standard concentration of the kth species.
virtual void setState_PV(double p, double v, double tol=1e-9)
Set the pressure (Pa) and specific volume (m^3/kg).
virtual void setState(const AnyMap &state)
Set the state using an AnyMap containing any combination of properties supported by the thermodynamic...
virtual double minTemp(size_t k=npos) const
Minimum temperature for which the thermodynamic data for the species or phase are valid.
void setState_SPorSV(double s, double p, double tol=1e-9, bool doSV=false)
Carry out work in SP and SV calculations.
double RT() const
Return the Gas Constant multiplied by the current temperature.
double o2Required(span< const double > y) const
Helper function for computing the amount of oxygen required for complete oxidation.
virtual double critPressure() const
Critical pressure (Pa).
double m_tlast
last value of the temperature processed by reference state
virtual void setState_ST(double s, double t, double tol=1e-9)
Set the specific entropy (J/kg/K) and temperature (K).
virtual void getActivities(span< double > a) const
Get the array of non-dimensional activities at the current solution temperature, pressure,...
virtual void getdlnActCoeffdlnN(const size_t ld, span< double > dlnActCoeffdlnN)
Get the array of derivatives of the log activity coefficients with respect to the log of the species ...
void setState_HPorUV(double h, double p, double tol=1e-9, bool doUV=false)
Carry out work in HP and UV calculations.
double gibbs_mass() const
Specific Gibbs function. Units: J/kg.
string type() const override
String indicating the thermodynamic model implemented.
AnyMap parameters(bool withInput=true) const
Returns the parameters of a ThermoPhase object such that an identical one could be reconstructed usin...
virtual string report(bool show_thermo=true, double threshold=-1e-14) const
returns a summary of the state of the phase as a string
virtual void getActivityConcentrations(span< double > c) const
This method returns an array of generalized concentrations.
virtual double maxTemp(size_t k=npos) const
Maximum temperature for which the thermodynamic data for the species are valid.
double o2Present(span< const double > y) const
Helper function for computing the amount of oxygen available in the current mixture.
virtual void setState_TPY(double t, double p, span< const double > y)
Set the internally stored temperature (K), pressure (Pa), and mass fractions of the phase.
virtual void setState_TPX(double t, double p, span< const double > x)
Set the temperature (K), pressure (Pa), and mole fractions.
virtual string phaseOfMatter() const
String indicating the mechanical phase of the matter in this Phase.
virtual void setState_Tsat(double t, double x)
Set the state to a saturated system at a particular temperature.
virtual double entropy_mole() const
Molar entropy. Units: J/kmol/K.
double cv_mass() const
Specific heat at constant volume and composition [J/kg/K].
virtual void getLnActivityCoefficients(span< double > lnac) const
Get the array of non-dimensional molar-based ln activity coefficients at the current solution tempera...
virtual int activityConvention() const
This method returns the convention used in specification of the activities, of which there are curren...
virtual void initThermo()
Initialize the ThermoPhase object after all species have been set up.
double entropy_mass() const
Specific entropy. Units: J/kg/K.
void getElectrochemPotentials(span< double > mu) const
Get the species electrochemical potentials.
virtual MultiSpeciesThermo & speciesThermo(int k=-1)
Return a changeable reference to the calculation manager for species reference-state thermodynamic pr...
virtual void setState_UP(double u, double p, double tol=1e-9)
Set the specific internal energy (J/kg) and pressure (Pa).
void initThermoFile(const string &inputFile, const string &id)
Initialize a ThermoPhase object using an input file.
shared_ptr< Solution > root() const
Get the Solution object containing this ThermoPhase object and linked Kinetics and Transport objects.
virtual void setState_SP(double s, double p, double tol=1e-9)
Set the specific entropy (J/kg/K) and pressure (Pa).
virtual int standardStateConvention() const
This method returns the convention used in specification of the standard state, of which there are cu...
void modifySpecies(size_t k, shared_ptr< Species > spec) override
Modify the thermodynamic data associated with a species.
virtual void setState_SH(double s, double h, double tol=1e-9)
Set the specific entropy (J/kg/K) and the specific enthalpy (J/kg)
virtual void getPartialMolarIntEnergies(span< double > ubar) const
Return an array of partial molar internal energies for the species in the mixture.
void invalidateCache() override
Invalidate any cached values which are normally updated only when a change in state is detected.
double stoichAirFuelRatio(span< const double > fuelComp, span< const double > oxComp, ThermoBasis basis=ThermoBasis::molar) const
Compute the stoichiometric air to fuel ratio (kg oxidizer / kg fuel) given fuel and oxidizer composit...
virtual double internalPressure() const
Return the internal pressure [Pa].
virtual void resetHf298(const size_t k=npos)
Restore the original heat of formation of one or more species.
double cp_mass() const
Specific heat at constant pressure and composition [J/kg/K].
virtual void setState_TH(double t, double h, double tol=1e-9)
Set the temperature (K) and the specific enthalpy (J/kg)
double intEnergy_mass() const
Specific internal energy. Units: J/kg.
virtual void getPartialMolarIntEnergies_TV(span< double > utilde) const
Return an array of partial molar internal energies at constant temperature and volume [J/kmol].
virtual Units standardConcentrationUnits() const
Returns the units of the "standard concentration" for this phase.
void setMixtureFraction(double mixFrac, span< const double > fuelComp, span< const double > oxComp, ThermoBasis basis=ThermoBasis::molar)
Set the mixture composition according to the mixture fraction = kg fuel / (kg oxidizer + kg fuel)
double mixtureFraction(span< const double > fuelComp, span< const double > oxComp, ThermoBasis basis=ThermoBasis::molar, const string &element="Bilger") const
Compute the mixture fraction = kg fuel / (kg oxidizer + kg fuel) for the current mixture given fuel a...
void setEquivalenceRatio(double phi, span< const double > fuelComp, span< const double > oxComp, ThermoBasis basis=ThermoBasis::molar)
Set the mixture composition according to the equivalence ratio.
virtual double cv_mole() const
Molar heat capacity at constant volume and composition [J/kmol/K].
MultiSpeciesThermo m_spthermo
Pointer to the calculation manager for species reference-state thermodynamic properties.
virtual double satPressure(double t)
Return the saturation pressure given the temperature.
virtual void getChemPotentials(span< double > mu) const
Get the species chemical potentials. Units: J/kmol.
bool addSpecies(shared_ptr< Species > spec) override
Add a Species to this Phase.
AnyMap m_input
Data supplied via setParameters.
virtual double intEnergy_mole() const
Molar internal energy. Units: J/kmol.
virtual void setState_DP(double rho, double p)
Set the density (kg/m**3) and pressure (Pa) at constant composition.
void setState_TPQ(double T, double P, double Q)
Set the temperature, pressure, and vapor fraction (quality).
virtual void setState_VH(double v, double h, double tol=1e-9)
Set the specific volume (m^3/kg) and the specific enthalpy (J/kg)
virtual double gibbs_mole() const
Molar Gibbs function. Units: J/kmol.
virtual void setState_SV(double s, double v, double tol=1e-9)
Set the specific entropy (J/kg/K) and specific volume (m^3/kg).
const AnyMap & input() const
Access input data associated with the phase description.
virtual void setState_Psat(double p, double x)
Set the state to a saturated system at a particular pressure.
void setState_conditional_TP(double t, double p, bool set_p)
Helper function used by setState_HPorUV and setState_SPorSV.
virtual void getActivityCoefficients(span< double > ac) const
Get the array of non-dimensional molar-based activity coefficients at the current solution temperatur...
shared_ptr< ThermoPhase > clone() const
Create a new ThermoPhase object using the same species definitions, thermodynamic parameters,...
double enthalpy_mass() const
Specific enthalpy. Units: J/kg.
A representation of the units associated with a dimensional quantity.
Composition parseCompString(const string &ss, const vector< string > &names)
Parse a composition string into a map consisting of individual key:composition pairs.
void equilibrate(const string &XY, const string &solver="auto", double rtol=1e-9, int max_steps=50000, int max_iter=100, int estimate_equil=0, int log_level=0)
Equilibrate a ThermoPhase object.
void debuglog(const string &msg, int loglevel)
Write a message to the log only if loglevel > 0.
double dot(InputIter x_begin, InputIter x_end, InputIter2 y_begin)
Function that calculates a templated inner product.
T clip(const T &value, const T &lower, const T &upper)
Clip value such that lower <= value <= upper.
const double Faraday
Faraday constant [C/kmol].
const double OneAtm
One atmosphere [Pa].
shared_ptr< ThermoPhase > newThermo(const AnyMap &phaseNode, const AnyMap &rootNode)
Create a new ThermoPhase object and initialize it.
void setupPhase(ThermoPhase &thermo, const AnyMap &phaseNode, const AnyMap &rootNode)
Initialize a ThermoPhase object.
Namespace for the Cantera kernel.
const size_t npos
index returned by functions to indicate "no position"
const int cAC_CONVENTION_MOLAR
Standard state uses the molar convention.
const double SmallNumber
smallest number to compare to zero.
ThermoBasis
Differentiate between mole fractions and mass fractions for input mixture composition.
map< string, double > Composition
Map from string names to doubles.
void checkArraySize(const char *procedure, size_t available, size_t required)
Wrapper for throwing ArraySizeError.
Contains declarations for string manipulation functions within Cantera.