21 MultiPhase::MultiPhase() :
35 for (
size_t n = 0; n < mix.
nPhases(); n++) {
43 for (
size_t n = 0; n < phases.size(); n++) {
53 "phases cannot be added after init() has been called.");
57 throw CanteraError(
"MultiPhase::addPhase",
"Phase '{}'' is not "
58 "compatible with MultiPhase equilibrium solver", p->
name());
75 for (
size_t m = 0; m < p->
nElements(); m++) {
87 if (ename ==
"E" || ename ==
"e") {
129 for (
size_t m = 0; m <
m_nel; m++) {
132 for (
size_t ip = 0; ip <
nPhases(); ip++) {
136 for (
size_t kp = 0; kp < nsp; kp++) {
137 if (mlocal !=
npos) {
192 doublereal sum = 0.0;
193 for (
size_t i = 0; i <
nPhases(); i++) {
194 double phasesum = 0.0;
195 size_t nsp =
m_phase[i]->nSpecies();
196 for (
size_t ik = 0; ik < nsp; ik++) {
207 doublereal sum = 0.0;
208 for (
size_t i = 0; i <
nPhases(); i++) {
232 doublereal phasesum = 0.0;
233 size_t nsp =
m_phase[p]->nSpecies();
234 for (
size_t ik = 0; ik < nsp; ik++) {
245 for (
size_t i = 0; i <
nPhases(); i++) {
246 m_phase[i]->getChemPotentials(mu + loc);
252 doublereal* mu,
bool standard)
const
257 for (
size_t i = 0; i <
nPhases(); i++) {
260 m_phase[i]->getChemPotentials(mu + loc);
262 m_phase[i]->getStandardChemPotentials(mu + loc);
282 doublereal sum = 0.0;
284 for (
size_t i = 0; i <
nPhases(); i++) {
294 doublereal sum = 0.0;
296 for (
size_t i = 0; i <
nPhases(); i++) {
306 doublereal sum = 0.0;
308 for (
size_t i = 0; i <
nPhases(); i++) {
318 doublereal sum = 0.0;
320 for (
size_t i = 0; i <
nPhases(); i++) {
330 doublereal sum = 0.0;
332 for (
size_t i = 0; i <
nPhases(); i++) {
348 for (
size_t k = 0; k < p->
nSpecies(); k++) {
357 for (
size_t k = 0; k < kk; k++) {
374 doublereal* dtmp = molNum;
375 for (
size_t ip = 0; ip <
nPhases(); ip++) {
376 doublereal phasemoles =
m_moles[ip];
379 for (
size_t ik = 0; ik < nsp; ik++) {
380 *(dtmp++) *= phasemoles;
392 for (
size_t ip = 0; ip <
nPhases(); ip++) {
395 double phasemoles = 0.0;
396 for (
size_t ik = 0; ik < nsp; ik++) {
402 if (phasemoles > 0.0) {
419 tmpMoles[indexS] += addedMoles;
420 tmpMoles[indexS] = std::max(tmpMoles[indexS], 0.0);
445 for (
size_t eGlobal = 0; eGlobal <
m_nel; eGlobal++) {
454 for (
size_t eGlobal = 0; eGlobal <
m_nel; eGlobal++) {
457 for (
size_t ip = 0; ip <
nPhases(); ip++) {
460 doublereal phasemoles =
m_moles[ip];
461 for (
size_t ik = 0; ik < nspPhase; ik++) {
462 size_t kGlobal = loc + ik;
464 for (
size_t eGlobal = 0; eGlobal <
m_nel; eGlobal++) {
475 for (
size_t i = 0; i <
nPhases(); i++) {
476 double vol = 1.0/
m_phase[i]->molarDensity();
483 int maxsteps,
int maxiter,
487 doublereal dta = 0.0;
495 return e.equilibrate(XY, err, maxsteps, loglevel);
496 }
else if (XY == HP) {
499 double Thigh = 2.0*
m_Tmax;
501 for (
int n = 0; n < maxiter; n++) {
509 e.equilibrate(TP, err, maxsteps, loglevel);
529 double cpb = (Hhigh - Hlow)/(Thigh - Tlow);
530 dt = (h0 - hnow)/cpb;
532 double dtmax = 0.5*fabs(Thigh - Tlow);
537 double tnew = sqrt(Tlow*Thigh);
541 double herr = fabs((h0 - hnow)/h0);
546 double tnew =
m_temp + dt;
562 double tnew = 0.5*(
m_temp + Thigh);
563 if (fabs(tnew -
m_temp) < 1.0) {
570 throw CanteraError(
"MultiPhase::equilibrate_MultiPhaseEquil",
571 "No convergence for T");
572 }
else if (XY == SP) {
575 double Thigh = 1.0e6;
576 for (
int n = 0; n < maxiter; n++) {
580 e.equilibrate(TP, err, maxsteps, loglevel);
583 Tlow = std::max(Tlow,
m_temp);
585 Thigh = std::min(Thigh,
m_temp);
587 double dt = (s0 - snow)*
m_temp/
cp();
588 double dtmax = 0.5*fabs(Thigh - Tlow);
589 dtmax = (dtmax > 500.0 ? 500.0 : dtmax);
597 double tnew =
m_temp + dt;
609 double tnew = 0.5*(
m_temp + Thigh);
614 throw CanteraError(
"MultiPhase::equilibrate_MultiPhaseEquil",
615 "No convergence for T");
616 }
else if (XY == TV) {
619 for (
int n = 0; n < maxiter; n++) {
624 e.equilibrate(TP, err, maxsteps, loglevel);
626 double verr = fabs((v0 - vnow)/v0);
633 double dVdP = (
volume() - vnow)/(0.01*pnow);
637 throw CanteraError(
"MultiPhase::equilibrate_MultiPhaseEquil",
644 double rtol,
int max_steps,
int max_iter,
645 int estimate_equil,
int log_level)
651 double initial_T =
m_temp;
654 if (solver ==
"auto" || solver ==
"vcs") {
656 debuglog(
"Trying VCS equilibrium solver\n", log_level);
658 int ret = eqsolve.
equilibrate(ixy, estimate_equil, log_level-1,
662 "VCS solver failed. Return code: {}", ret);
664 debuglog(
"VCS solver succeeded\n", log_level);
666 }
catch (std::exception& err) {
667 debuglog(
"VCS solver failed.\n", log_level);
674 if (solver ==
"auto") {
681 if (solver ==
"auto" || solver ==
"gibbs") {
683 debuglog(
"Trying MultiPhaseEquil (Gibbs) equilibrium solver\n",
687 debuglog(
"MultiPhaseEquil solver succeeded\n", log_level);
689 }
catch (std::exception& err) {
690 debuglog(
"MultiPhaseEquil solver failed.\n", log_level);
701 if (solver !=
"auto") {
703 "Invalid solver specified: '" + solver +
"'");
719 throw IndexError(
"MultiPhase::checkElementIndex",
"elements", m,
m_nel-1);
737 for (
size_t e = 0; e <
m_nel; e++) {
748 throw IndexError(
"MultiPhase::checkSpeciesIndex",
"species", k,
m_nsp-1);
782 for (
int iph = 0; iph < (int)
nPhases(); iph++) {
783 if (
m_phase[iph]->
id() == pName) {
818 for (
size_t ip = 0; ip <
nPhases(); ip++) {
829 for (
size_t p = 0; p <
nPhases(); p++) {
Headers for the MultiPhase object that is used to set up multiphase equilibrium problems (see Equilfu...
Base class for exceptions thrown by Cantera classes.
void resize(size_t n, size_t m, doublereal v=0.0)
Resize the matrix.
An array index is out of range.
A class for multiphase mixtures.
void init()
Process phases and build atomic composition array.
void getMoleFractions(doublereal *const x) const
Returns the global Species mole fractions.
void setState_TPMoles(const doublereal T, const doublereal Pres, const doublereal *Moles)
Set the state of the underlying ThermoPhase objects in one call.
void checkPhaseIndex(size_t m) const
Check that the specified phase index is in range Throws an exception if m is greater than nPhases()
size_t speciesIndex(size_t k, size_t p) const
Return the global index of the species belonging to phase number p with local index k within the phas...
bool solutionSpecies(size_t kGlob) const
Return true is species kGlob is a species in a multicomponent solution phase.
doublereal m_press
Current value of the pressure (Pa)
void setMoles(const doublereal *n)
Sets all of the global species mole numbers.
DenseMatrix m_atoms
Global Stoichiometric Coefficient array.
void getMoles(doublereal *molNum) const
Get the mole numbers of all species in the multiphase object.
void checkSpeciesIndex(size_t k) const
Check that the specified species index is in range.
size_t m_nel
Number of distinct elements in all of the phases.
vector_fp m_moleFractions
Locally stored vector of mole fractions of all species comprising the MultiPhase object.
doublereal minTemp() const
Minimum temperature for which all solution phases have valid thermo data.
double equilibrate_MultiPhaseEquil(int XY, doublereal err, int maxsteps, int maxiter, int loglevel)
Set the mixture to a state of chemical equilibrium using the MultiPhaseEquil solver.
void calcElemAbundances() const
Calculate the element abundance vector.
size_t nSpecies() const
Number of species, summed over all phases.
doublereal gibbs() const
The Gibbs function of the mixture [J].
doublereal cp() const
Heat capacity at constant pressure [J/K].
doublereal pressure() const
Pressure [Pa].
doublereal enthalpy() const
The enthalpy of the mixture [J].
std::map< std::string, size_t > m_enamemap
Returns the global element index, given the element string name.
doublereal speciesMoles(size_t kGlob) const
Returns the moles of global species k. units = kmol.
void addSpeciesMoles(const int indexS, const doublereal addedMoles)
Adds moles of a certain species to the mixture.
doublereal m_temp
Current value of the temperature (kelvin)
doublereal IntEnergy() const
The internal energy of the mixture [J].
void checkPhaseArraySize(size_t mm) const
Check that an array size is at least nPhases() Throws an exception if mm is less than nPhases().
vector_fp m_elemAbundances
Vector of element abundances.
std::vector< size_t > m_spstart
Vector of ints containing of first species index in the global list of species for each phase.
doublereal m_Tmax
Minimum temperature for which thermo parameterizations are valid.
doublereal m_Tmin
Minimum temperature for which thermo parameterizations are valid.
vector_fp m_moles
Vector of the number of moles in each phase.
size_t nPhases() const
Number of phases.
size_t m_eloc
Global ID of the element corresponding to the electronic charge.
doublereal moleFraction(const size_t kGlob) const
Returns the mole fraction of global species k.
doublereal phaseMoles(const size_t n) const
Return the number of moles in phase n.
std::vector< size_t > m_spphase
Mapping between the global species number and the phase ID.
std::vector< std::string > m_snames
Vector of species names in the problem.
std::string speciesName(const size_t kGlob) const
Name of species with global index kGlob.
vector_int m_atomicNumber
Atomic number of each global element.
size_t elementIndex(const std::string &name) const
Returns the index of the element with name name.
bool tempOK(size_t p) const
Return true if the phase p has valid thermo data for the current temperature.
std::string elementName(size_t m) const
Returns the name of the global element m.
doublereal nAtoms(const size_t kGlob, const size_t mGlob) const
Returns the Number of atoms of global element mGlob in global species kGlob.
void checkElementArraySize(size_t mm) const
Check that an array size is at least nElements().
size_t speciesPhaseIndex(const size_t kGlob) const
Returns the phase index of the Kth "global" species.
void addPhases(std::vector< ThermoPhase * > &phases, const vector_fp &phaseMoles)
Add a vector of phases to the mixture.
std::vector< std::string > m_enames
String names of the global elements.
void setPressure(doublereal P)
Set the pressure [Pa].
doublereal elementMoles(size_t m) const
Total moles of global element m, summed over all phases.
void setPhaseMoleFractions(const size_t n, const doublereal *const x)
Set the Mole fractions of the nth phase.
doublereal charge() const
Total charge summed over all phases (Coulombs).
std::string phaseName(const size_t iph) const
Returns the name of the n'th phase.
void getValidChemPotentials(doublereal not_mu, doublereal *mu, bool standard=false) const
Returns a vector of Valid chemical potentials.
void setState_TP(const doublereal T, const doublereal Pres)
Set the state of the underlying ThermoPhase objects in one call.
doublereal entropy() const
The entropy of the mixture [J/K].
void setMolesByName(const compositionMap &xMap)
Set the number of moles of species in the mixture.
size_t m_nsp
Number of distinct species in all of the phases.
void uploadMoleFractionsFromPhases()
Update the locally-stored composition within this object to match the current compositions of the pha...
bool m_init
True if the init() routine has been called, and the MultiPhase frozen.
doublereal volume() const
The total mixture volume [m^3].
void updatePhases() const
Set the states of the phase objects to the locally-stored state within this MultiPhase object.
void setPhaseMoles(const size_t n, const doublereal moles)
Set the number of moles of phase with index n.
void checkSpeciesArraySize(size_t kk) const
Check that an array size is at least nSpecies().
void getElemAbundances(doublereal *elemAbundances) const
Retrieves a vector of element abundances.
std::vector< bool > m_temp_OK
Vector of bools indicating whether temperatures are ok for phases.
int phaseIndex(const std::string &pName) const
Returns the index, given the phase name.
std::vector< ThermoPhase * > m_phase
Vector of the ThermoPhase pointers.
void addPhase(ThermoPhase *p, doublereal moles)
Add a phase to the mixture.
void getChemPotentials(doublereal *mu) const
Returns a vector of Chemical potentials.
void checkElementIndex(size_t m) const
Check that the specified element index is in range.
doublereal phaseCharge(size_t p) const
Charge (Coulombs) of phase with index p.
thermo_t & phase(size_t n)
Return a reference to phase n.
void setTemperature(const doublereal T)
Set the temperature [K].
std::string name() const
Return the name of the phase.
size_t nSpecies() const
Returns the number of species in the phase.
int atomicNumber(size_t m) const
Atomic number of element m.
std::string id() const
Return the string id for the phase.
size_t elementIndex(const std::string &name) const
Return the index of element named 'name'.
std::string speciesName(size_t k) const
Name of the species with index k.
void getMoleFractions(double *const x) const
Get the species mole fraction vector.
doublereal nAtoms(size_t k, size_t m) const
Number of atoms of element m in species k.
doublereal temperature() const
Temperature (K).
size_t nElements() const
Number of elements.
virtual double pressure() const
Return the thermodynamic pressure (Pa).
std::string elementName(size_t m) const
Name of the element with index m.
Base class for a phase with thermodynamic properties.
virtual void setState_TPX(doublereal t, doublereal p, const doublereal *x)
Set the temperature (K), pressure (Pa), and mole fractions.
virtual doublereal maxTemp(size_t k=npos) const
Maximum temperature for which the thermodynamic data for the species are valid.
virtual doublereal minTemp(size_t k=npos) const
Minimum temperature for which the thermodynamic data for the species or phase are valid.
Cantera's Interface to the Multiphase chemical equilibrium solver.
int equilibrate(int XY, int estimateEquil=0, int printLvl=0, doublereal err=1.0e-6, int maxsteps=VCS_MAXSTEPS, int loglevel=-99)
Equilibrate the solution using the current element abundances stored in the MultiPhase object.
virtual bool compatibleWithMultiPhase() const
Indicates whether this phase type can be used with class MultiPhase for equilibrium calculations.
void equilibrate(const std::string &XY, const std::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 MultiPhase object.
const size_t npos
index returned by functions to indicate "no position"
const double Faraday
Faraday constant [C/kmol].
const double Undef
Fairly random number to be used to initialize variables against to see if they are subsequently defin...
std::vector< double > vector_fp
Turn on the use of stl vectors for the basic array type within cantera Vector of doubles.
const double OneBar
One bar [Pa].
std::map< std::string, double > compositionMap
Map connecting a string name with a double.
Namespace for the Cantera kernel.
const U & getValue(const std::map< T, U > &m, const T &key, const U &default_val)
Const accessor for a value in a std::map.
int _equilflag(const char *xy)
map property strings to integers
compositionMap parseCompString(const std::string &ss, const std::vector< std::string > &names)
Parse a composition string into a map consisting of individual key:composition pairs.
Contains declarations for string manipulation functions within Cantera.
Interface class for the vcsnonlinear solver.