Cantera
2.2.1

Phase information and Phase calculations for vcs. More...
#include <vcs_VolPhase.h>
Public Member Functions  
vcs_VolPhase (VCS_SOLVE *owningSolverObject=0)  
vcs_VolPhase (const vcs_VolPhase &b)  
vcs_VolPhase &  operator= (const vcs_VolPhase &b) 
void  resize (const size_t phaseNum, const size_t numSpecies, const size_t numElem, const char *const phaseName, const double molesInert=0.0) 
The resize() function fills in all of the initial information if it is not given in the constructor. More...  
void  elemResize (const size_t numElemConstraints) 
double  AC_calc_one (size_t kspec) const 
Evaluate activity coefficients and return the kspec coefficient. More...  
void  setMoleFractionsState (const double molNum, const double *const moleFracVec, const int vcsStateStatus) 
Set the moles and/or mole fractions within the phase. More...  
void  setMolesFromVCS (const int stateCalc, const double *molesSpeciesVCS=0) 
Set the moles within the phase. More...  
void  setMolesFromVCSCheck (const int vcsStateStatus, const double *molesSpeciesVCS, const double *const TPhMoles) 
Set the moles within the phase. More...  
void  updateFromVCS_MoleNumbers (const int stateCalc) 
Update the moles within the phase, if necessary. More...  
void  sendToVCS_ActCoeff (const int stateCalc, double *const AC) 
Fill in an activity coefficients vector within a VCS_SOLVE object. More...  
void  setElectricPotential (const double phi) 
set the electric potential of the phase More...  
double  electricPotential () const 
Returns the electric field of the phase. More...  
double  GStar_calc_one (size_t kspec) const 
Gibbs free energy calculation for standard state of one species. More...  
double  G0_calc_one (size_t kspec) const 
Gibbs free energy calculation at a temperature for the reference state of a species, return a value for one species. More...  
double  VolStar_calc_one (size_t kspec) const 
Molar volume calculation for standard state of one species. More...  
double  sendToVCS_VolPM (double *const VolPM) const 
Fill in the partial molar volume vector for VCS. More...  
void  sendToVCS_GStar (double *const gstar) const 
Fill in the partial molar volume vector for VCS. More...  
void  setState_TP (const double temperature_Kelvin, const double pressure_PA) 
Sets the temperature and pressure in this object and underlying ThermoPhase objects. More...  
void  setState_T (const double temperature_Kelvin) 
Sets the temperature in this object and underlying ThermoPhase objects. More...  
void  sendToVCS_LnActCoeffJac (Array2D &LnACJac_VCS) 
void  setPtrThermoPhase (ThermoPhase *tp_ptr) 
Set the pointer for Cantera's ThermoPhase parameter. More...  
const ThermoPhase *  ptrThermoPhase () const 
Return a const ThermoPhase pointer corresponding to this phase. More...  
double  totalMoles () const 
Return the total moles in the phase. More...  
double  molefraction (size_t kspec) const 
Returns the mole fraction of the kspec species. More...  
void  setTotalMoles (const double totalMols) 
Sets the total moles in the phase. More...  
void  setMolesOutOfDate (int stateCalc=1) 
Sets the mole flag within the object to out of date. More...  
void  setMolesCurrent (int vcsStateStatus) 
Sets the mole flag within the object to be current. More...  
const std::vector< double > &  moleFractions () const 
Return a const reference to the mole fractions stored in the object. More...  
double  moleFraction (size_t klocal) const 
void  setCreationMoleNumbers (const double *const n_k, const std::vector< size_t > &creationGlobalRxnNumbers) 
Sets the creationMoleNum's within the phase object. More...  
const std::vector< double > &  creationMoleNumbers (std::vector< size_t > &creationGlobalRxnNumbers) const 
Return a const reference to the creationMoleNumbers stored in the object. More...  
bool  isIdealSoln () const 
Returns whether the phase is an ideal solution phase. More...  
bool  usingCanteraCalls () const 
Returns whether the object is using cantera calls. More...  
size_t  phiVarIndex () const 
Return the index of the species that represents the the voltage of the phase. More...  
void  setPhiVarIndex (size_t phiVarIndex) 
vcs_SpeciesProperties *  speciesProperty (const size_t kindex) 
Retrieve the kth Species structure for the species belonging to this phase. More...  
int  exists () const 
int indicating whether the phase exists or not More...  
void  setExistence (const int existence) 
Set the existence flag in the object. More...  
size_t  spGlobalIndexVCS (const size_t spIndex) const 
Return the Global VCS index of the kth species in the phase. More...  
void  setSpGlobalIndexVCS (const size_t spIndex, const size_t spGlobalIndex) 
set the Global VCS index of the kth species in the phase More...  
void  setTotalMolesInert (const double tMolesInert) 
Sets the total moles of inert in the phase. More...  
double  totalMolesInert () const 
returns the value of the total kmol of inert in the phase More...  
size_t  elemGlobalIndex (const size_t e) const 
Returns the global index of the local element index for the phase. More...  
void  setElemGlobalIndex (const size_t eLocal, const size_t eGlobal) 
sets a local phase element to a global index value More...  
size_t  nElemConstraints () const 
Returns the number of element constraints. More...  
std::string  elementName (const size_t e) const 
Name of the element constraint with index e . More...  
int  elementType (const size_t e) const 
Type of the element constraint with index e . More...  
void  setElementType (const size_t e, const int eType) 
Set the element Type of the element constraint with index e . More...  
size_t  transferElementsFM (const ThermoPhase *const tPhase) 
Transfer all of the element information from the ThermoPhase object to the vcs_VolPhase object. More...  
const Array2D &  getFormulaMatrix () const 
Get a constant form of the Species Formula Matrix. More...  
int  speciesUnknownType (const size_t k) const 
Returns the type of the species unknown. More...  
int  elementActive (const size_t e) const 
size_t  nSpecies () const 
Return the number of species in the phase. More...  
Public Attributes  
size_t  VP_ID_ 
Original ID of the phase in the problem. More...  
bool  m_singleSpecies 
If true, this phase consists of a single species. More...  
bool  m_gasPhase 
If true, this phase is a gasphase like phase. More...  
int  m_eqnState 
Type of the equation of state. More...  
size_t  ChargeNeutralityElement 
This is the element number for the charge neutrality condition of the phase. More...  
int  p_VCS_UnitsFormat 
Units for the chemical potential data, pressure data, volume, and species amounts. More...  
int  p_activityConvention 
Convention for the activity formulation. More...  
std::string  PhaseName 
String name for the phase. More...  
Private Member Functions  
void  setMoleFractions (const double *const xmol) 
Set the mole fractions from a conventional mole fraction vector. More...  
void  _updateActCoeff () const 
Evaluate the activity coefficients at the current conditions. More...  
void  _updateGStar () const 
Gibbs free energy calculation for standard states. More...  
void  _updateG0 () const 
Gibbs free energy calculation at a temperature for the reference state of each species. More...  
void  _updateVolStar () const 
Molar volume calculation for standard states. More...  
double  _updateVolPM () const 
Calculate the partial molar volumes of all species and return the total volume. More...  
void  _updateLnActCoeffJac () 
Evaluation of Activity Coefficient Jacobians. More...  
void  _updateMoleFractionDependencies () 
Updates the mole fraction dependencies. More...  
Private Attributes  
VCS_SOLVE *  m_owningSolverObject 
Backtrack value of VCS_SOLVE *. More...  
size_t  m_numElemConstraints 
Number of element constraints within the problem. More...  
std::vector< std::string >  m_elementNames 
vector of strings containing the element constraint names More...  
std::vector< int >  m_elementActive 
boolean indicating whether an element constraint is active for the current problem More...  
std::vector< int >  m_elementType 
Type of the element constraint. More...  
Array2D  m_formulaMatrix 
Formula Matrix for the phase. More...  
std::vector< int >  m_speciesUnknownType 
Type of the species unknown. More...  
std::vector< size_t >  m_elemGlobalIndex 
Index of the element number in the global list of elements stored in VCS_PROB or VCS_SOLVE. More...  
size_t  m_numSpecies 
Number of species in the phase. More...  
double  m_totalMolesInert 
Total moles of inert in the phase. More...  
bool  m_isIdealSoln 
Boolean indicating whether the phase is an ideal solution and therefore its molarbased activity coefficients are uniformly equal to one. More...  
int  m_existence 
Current state of existence: More...  
int  m_MFStartIndex 
std::vector< size_t >  IndSpecies 
Index into the species vectors. More...  
std::vector < vcs_SpeciesProperties * >  ListSpeciesPtr 
Vector of Species structures for the species belonging to this phase. More...  
bool  m_useCanteraCalls 
If this is true, then calculations are actually performed within Cantera. More...  
ThermoPhase *  TP_ptr 
If we are using Cantera, this is the pointer to the ThermoPhase object. More...  
double  v_totalMoles 
Total mols in the phase. units are kmol. More...  
std::vector< double >  Xmol_ 
Vector of the current mole fractions for species in the phase. More...  
std::vector< double >  creationMoleNumbers_ 
Vector of current creationMoleNumbers_. More...  
std::vector< size_t >  creationGlobalRxnNumbers_ 
Vector of creation global reaction numbers for the phase stability problem. More...  
size_t  m_phiVarIndex 
If the potential is a solution variable in VCS, it acts as a species. More...  
double  m_totalVol 
Total Volume of the phase. Units are m**3. More...  
std::vector< double >  SS0ChemicalPotential 
Vector of calculated SS0 chemical potentials for the current Temperature. More...  
std::vector< double >  StarChemicalPotential 
Vector of calculated Star chemical potentials for the current Temperature and pressure. More...  
std::vector< double >  StarMolarVol 
Vector of the Star molar Volumes of the species. units m3 / kmol. More...  
std::vector< double >  PartialMolarVol 
Vector of the Partial molar Volumes of the species. units m3 / kmol. More...  
std::vector< double >  ActCoeff 
Vector of calculated activity coefficients for the current state. More...  
Array2D  np_dLnActCoeffdMolNumber 
Vector of the derivatives of the ln activity coefficient wrt to the current mole number multiplied by the current phase moles. More...  
int  m_vcsStateStatus 
Status. More...  
double  m_phi 
Value of the potential for the phase (Volts) More...  
bool  m_UpToDate 
Boolean indicating whether the object has an uptodate mole number vector and potential with respect to the current vcs state calc status. More...  
bool  m_UpToDate_AC 
Boolean indicating whether activity coefficients are up to date. More...  
bool  m_UpToDate_VolStar 
Boolean indicating whether Star volumes are up to date. More...  
bool  m_UpToDate_VolPM 
Boolean indicating whether partial molar volumes are up to date. More...  
bool  m_UpToDate_GStar 
Boolean indicating whether GStar is up to date. More...  
bool  m_UpToDate_G0 
Boolean indicating whether G0 is up to date. More...  
double  Temp_ 
Current value of the temperature for this object, and underlying objects. More...  
double  Pres_ 
Current value of the pressure for this object, and underlying objects. More...  
Phase information and Phase calculations for vcs.
Each phase in a vcs calculation has a vcs_VolPhase object associated with it. This object helps to coordinate property evaluations for species within the phase. Usually these evaluations must be carried out on a per phase basis. However, vcs frequently needs per species quantities. Therefore, we need an interface layer between vcs and Cantera's ThermoPhase.
The species stay in the same ordering within this structure. The vcs algorithm will change the ordering of species in the global species list. However, the indexing of species in this list stays the same. This structure contains structures that point to the species belonging to this phase in the global vcs species list.
This object is considered not to own the underlying Cantera ThermoPhase object for the phase.
This object contains an idea of the temperature and pressure. It checks to see if if the temperature and pressure has changed before calling underlying property evaluation routines.
The object contains values for the electric potential of a phase. It coordinates the evaluation of properties wrt when the electric potential of a phase has changed.
The object knows about the mole fractions of the phase. It controls the values of mole fractions, and coordinates the property evaluation wrt to changes in the mole fractions. It also will keep track of the likely values of mole fractions in multicomponent phases even when the phase doesn't actually exist within the thermo program.
The object knows about the total moles of a phase. It checks to see if the phase currently exists or not, and modifies its behavior accordingly.
Activity coefficients and volume calculations are lagged. They are only called when they are needed (and when the state has changed so that they need to be recalculated).
Definition at line 86 of file vcs_VolPhase.h.
void resize  (  const size_t  phaseNum, 
const size_t  numSpecies,  
const size_t  numElem,  
const char *const  phaseName,  
const double  molesInert = 0.0 

) 
The resize() function fills in all of the initial information if it is not given in the constructor.
phaseNum  index of the phase in the vcs problem 
numSpecies  Number of species in the phase 
phaseName  String name for the phase 
molesInert  kmoles of inert in the phase (defaults to zero) 
Definition at line 193 of file vcs_VolPhase.cpp.
References AssertThrowMsg, Cantera::npos, VCS_SPECIES_TYPE_MOLNUM, and VCS_STATECALC_OLD.
Referenced by Cantera::vcs_Cantera_to_vprob().
double AC_calc_one  (  size_t  kspec  )  const 
Evaluate activity coefficients and return the kspec coefficient.
We carry out a calculation whenever m_UpToDate_AC is false. Specifically whenever a phase goes zero, we do not carry out calculations on it.
kspec  species number 
Definition at line 314 of file vcs_VolPhase.cpp.
Referenced by VCS_SPECIES_THERMO::eval_ac().
void setMoleFractionsState  (  const double  molNum, 
const double *const  moleFracVec,  
const int  vcsStateStatus  
) 
Set the moles and/or mole fractions within the phase.
molNum  total moles in the phase 
moleFracVec  Vector of input mole fractions 
vcsStateStatus  Status flag for this update 
Definition at line 419 of file vcs_VolPhase.cpp.
References Cantera::fp2str(), VCS_PHASE_EXIST_NO, VCS_PHASE_EXIST_YES, VCS_PHASE_EXIST_ZEROEDPHASE, and VCS_STATECALC_TMP.
Referenced by VCS_SOLVE::vcs_phaseStabilityTest(), and VCS_SOLVE::vcs_prob_update().
void setMolesFromVCS  (  const int  stateCalc, 
const double *  molesSpeciesVCS = 0 

) 
Set the moles within the phase.
This function takes as input the mole numbers in vcs format, and then updates this object with their values. This is essentially a gather routine.
molesSpeciesVCS  Array of mole numbers. Note, the indices for species in this array may not be contiguous. IndSpecies[] is needed to gather the species into the local contiguous vector format. 
Definition at line 471 of file vcs_VolPhase.cpp.
References AssertThrowMsg, Cantera::npos, VCS_DATA_PTR, VCS_PHASE_EXIST_ALWAYS, VCS_PHASE_EXIST_NO, VCS_PHASE_EXIST_YES, VCS_SPECIES_TYPE_INTERFACIALVOLTAGE, VCS_STATECALC_NEW, and VCS_STATECALC_OLD.
Referenced by VCS_SOLVE::vcs_CalcLnActCoeffJac(), Cantera::vcs_Cantera_to_vprob(), Cantera::vcs_Cantera_update_vprob(), VCS_SOLVE::vcs_chemPotPhase(), and VCS_SOLVE::vcs_VolTotal().
void setMolesFromVCSCheck  (  const int  vcsStateStatus, 
const double *  molesSpeciesVCS,  
const double *const  TPhMoles  
) 
Set the moles within the phase.
This function takes as input the mole numbers in vcs format, and then updates this object with their values. This is essentially a gather routine.
Additionally it checks to see that the total moles value in TPhMoles[iplace] is equal to the internally computed value. If this isn't the case, an error exit is carried out.
vcsStateStatus  State calc value either VCS_STATECALC_OLD or VCS_STATECALC_NEW . With any other value nothing is done. 
molesSpeciesVCS  array of mole numbers. Note, the indices for species in this array may not be contiguous. IndSpecies[] is needed to gather the species into the local contiguous vector format. 
TPhMoles  VCS's array containing the number of moles in each phase. 
Definition at line 558 of file vcs_VolPhase.cpp.
References Cantera::fp2str(), and Cantera::vcs_doubleEqual().
Referenced by VCS_SOLVE::vcs_delete_species(), VCS_SOLVE::vcs_reinsert_deleted(), and VCS_SOLVE::vcs_updateVP().
void updateFromVCS_MoleNumbers  (  const int  stateCalc  ) 
Update the moles within the phase, if necessary.
This function takes as input the stateCalc value, which determines where within VCS_SOLVE to fetch the mole numbers. It then updates this object with their values. This is essentially a gather routine.
stateCalc  State calc value either VCS_STATECALC_OLD or VCS_STATECALC_NEW. With any other value nothing is done. 
Definition at line 578 of file vcs_VolPhase.cpp.
References VCS_STATECALC_NEW, and VCS_STATECALC_OLD.
Referenced by VCS_SOLVE::vcs_dfe().
void sendToVCS_ActCoeff  (  const int  stateCalc, 
double *const  AC  
) 
Fill in an activity coefficients vector within a VCS_SOLVE object.
This routine will calculate the activity coefficients for the current phase, and fill in the corresponding entries in the VCS activity coefficients vector.
AC  vector of activity coefficients for all of the species in all of the phases in a VCS problem. Only the entries for the current phase are filled in. 
Definition at line 589 of file vcs_VolPhase.cpp.
Referenced by VCS_SOLVE::vcs_add_all_deleted(), VCS_SOLVE::vcs_chemPotPhase(), VCS_SOLVE::vcs_dfe(), and VCS_SOLVE::vcs_phaseStabilityTest().
void setElectricPotential  (  const double  phi  ) 
set the electric potential of the phase
phi  electric potential (volts) 
Definition at line 625 of file vcs_VolPhase.cpp.
References Cantera::warn_deprecated().
Referenced by Cantera::vcs_Cantera_to_vprob(), Cantera::vcs_Cantera_update_vprob(), VCS_SOLVE::vcs_prob_specify(), and VCS_SOLVE::vcs_prob_update().
double electricPotential  (  )  const 
Returns the electric field of the phase.
Units are potential
Definition at line 641 of file vcs_VolPhase.cpp.
Referenced by VCS_SOLVE::vcs_chemPotPhase(), VCS_SOLVE::vcs_dfe(), VCS_SOLVE::vcs_printSpeciesChemPot(), VCS_SOLVE::vcs_prob_specify(), and VCS_SOLVE::vcs_prob_update().
double GStar_calc_one  (  size_t  kspec  )  const 
Gibbs free energy calculation for standard state of one species.
Calculate the Gibbs free energies for the standard state of the kth species. The results are held internally within the object.
kspec  Species number (within the phase) 
Definition at line 368 of file vcs_VolPhase.cpp.
Referenced by VCS_SPECIES_THERMO::GStar_R_calc(), and VCS_PROB::prob_report().
double G0_calc_one  (  size_t  kspec  )  const 
Gibbs free energy calculation at a temperature for the reference state of a species, return a value for one species.
kspec  species index 
Definition at line 341 of file vcs_VolPhase.cpp.
Referenced by VCS_SPECIES_THERMO::G0_R_calc(), VCS_PROB::prob_report(), and Cantera::vcs_Cantera_to_vprob().
double VolStar_calc_one  (  size_t  kspec  )  const 
Molar volume calculation for standard state of one species.
Calculate the molar volume for the standard states. The results are held internally within the object.
kspec  Species number (within the phase) 
Definition at line 691 of file vcs_VolPhase.cpp.
Referenced by VCS_SPECIES_THERMO::VolStar_calc().
double sendToVCS_VolPM  (  double *const  VolPM  )  const 
Fill in the partial molar volume vector for VCS.
This routine will calculate the partial molar volumes for the current phase (if needed), and fill in the corresponding entries in the VCS partial molar volumes vector.
VolPM  vector of partial molar volumes for all of the species in all of the phases in a VCS problem. Only the entries for the current phase are filled in. 
Definition at line 602 of file vcs_VolPhase.cpp.
Referenced by VCS_SOLVE::vcs_VolTotal().
void sendToVCS_GStar  (  double *const  gstar  )  const 
Fill in the partial molar volume vector for VCS.
This routine will calculate the partial molar volumes for the current phase (if needed), and fill in the corresponding entries in the VCS partial molar volumes vector.
VolPM  vector of partial molar volumes for all of the species in all of the phases in a VCS problem. Only the entries for the current phase are filled in. 
Definition at line 614 of file vcs_VolPhase.cpp.
Referenced by VCS_SOLVE::vcs_evalSS_TP().
void setState_TP  (  const double  temperature_Kelvin, 
const double  pressure_PA  
) 
Sets the temperature and pressure in this object and underlying ThermoPhase objects.
temperature_Kelvin  (Kelvin) 
pressure_PA  Pressure (MKS units  Pascal) 
Definition at line 646 of file vcs_VolPhase.cpp.
References Cantera::warn_deprecated().
Referenced by VCS_SPECIES_THERMO::GStar_R_calc(), VCS_PROB::prob_report(), Cantera::vcs_Cantera_to_vprob(), Cantera::vcs_Cantera_update_vprob(), VCS_SOLVE::vcs_evalSS_TP(), VCS_SOLVE::vcs_VolTotal(), and VCS_SPECIES_THERMO::VolStar_calc().
void setState_T  (  const double  temperature_Kelvin  ) 
Sets the temperature in this object and underlying ThermoPhase objects.
temperature_Kelvin  (Kelvin) 
Definition at line 669 of file vcs_VolPhase.cpp.
Referenced by VCS_SPECIES_THERMO::G0_R_calc().
void setPtrThermoPhase  (  ThermoPhase *  tp_ptr  ) 
Set the pointer for Cantera's ThermoPhase parameter.
When we first initialize the ThermoPhase object, we read the state of the ThermoPhase into vcs_VolPhase object.
tp_ptr  Pointer to the ThermoPhase object corresponding to this phase. 
Definition at line 834 of file vcs_VolPhase.cpp.
References Cantera::cEdge, Cantera::cIdealGas, Cantera::cIdealSolidSolnPhase, Cantera::cMetal, Cantera::cSurf, plogf, Phase::temperature(), VCS_DATA_PTR, and Cantera::warn_deprecated().
Referenced by Cantera::vcs_Cantera_to_vprob().
const ThermoPhase * ptrThermoPhase  (  )  const 
Return a const ThermoPhase pointer corresponding to this phase.
Definition at line 888 of file vcs_VolPhase.cpp.
double totalMoles  (  )  const 
Return the total moles in the phase.
Units > depends on VCS_UnitsFormat variable. Cantera > J/kmol
Definition at line 893 of file vcs_VolPhase.cpp.
Referenced by VCS_PROB::prob_report(), vcs_MultiPhaseEquil::reportCSV(), Cantera::vcs_Cantera_to_vprob(), Cantera::vcs_Cantera_update_vprob(), VCS_SOLVE::vcs_prob_update(), and VCS_SOLVE::vcs_report().
double molefraction  (  size_t  kspec  )  const 
Returns the mole fraction of the kspec species.
kspec  Index of the species in the phase 
Definition at line 898 of file vcs_VolPhase.cpp.
Referenced by VCS_SOLVE::vcs_prob_update().
void setTotalMoles  (  const double  totalMols  ) 
Sets the total moles in the phase.
We don't have to flag the internal state as changing here because we have just changed the total moles.
totalMols  Total moles in the phase (kmol) 
Definition at line 918 of file vcs_VolPhase.cpp.
References AssertThrowMsg, Cantera::fp2str(), VCS_PHASE_EXIST_ALWAYS, VCS_PHASE_EXIST_NO, and VCS_PHASE_EXIST_YES.
Referenced by Cantera::vcs_Cantera_to_vprob(), VCS_SOLVE::vcs_delete_multiphase(), VCS_SOLVE::vcs_prob_update(), and VCS_SOLVE::vcs_tmoles().
void setMolesOutOfDate  (  int  stateCalc = 1  ) 
Sets the mole flag within the object to out of date.
This will trigger the object to go get the current mole numbers when it needs it.
Definition at line 940 of file vcs_VolPhase.cpp.
void setMolesCurrent  (  int  vcsStateStatus  ) 
Sets the mole flag within the object to be current.
Definition at line 948 of file vcs_VolPhase.cpp.

private 
Set the mole fractions from a conventional mole fraction vector.
xmol  Value of the mole fractions for the species in the phase. These are contiguous. 
Definition at line 376 of file vcs_VolPhase.cpp.
References VCS_STATECALC_TMP.
const std::vector< double > & moleFractions  (  )  const 
Return a const reference to the mole fractions stored in the object.
Definition at line 409 of file vcs_VolPhase.cpp.
Referenced by VCS_SOLVE::vcs_prob_update().
void setCreationMoleNumbers  (  const double *const  n_k, 
const std::vector< size_t > &  creationGlobalRxnNumbers  
) 
Sets the creationMoleNum's within the phase object.
F_k  Pointer to a vector of n_k's 
Definition at line 903 of file vcs_VolPhase.cpp.
Referenced by VCS_SOLVE::vcs_phaseStabilityTest().
const std::vector< double > & creationMoleNumbers  (  std::vector< size_t > &  creationGlobalRxnNumbers  )  const 
Return a const reference to the creationMoleNumbers stored in the object.
Definition at line 912 of file vcs_VolPhase.cpp.
Referenced by VCS_SOLVE::vcs_phaseStabilityTest(), and VCS_SOLVE::vcs_popPhaseRxnStepSizes().
bool isIdealSoln  (  )  const 
Returns whether the phase is an ideal solution phase.
Definition at line 988 of file vcs_VolPhase.cpp.
Referenced by VCS_SOLVE::vcs_CalcLnActCoeffJac().
bool usingCanteraCalls  (  )  const 
Returns whether the object is using cantera calls.
Definition at line 993 of file vcs_VolPhase.cpp.
Referenced by Cantera::vcs_Cantera_to_vprob().
size_t phiVarIndex  (  )  const 
Return the index of the species that represents the the voltage of the phase.
Definition at line 998 of file vcs_VolPhase.cpp.
Referenced by Cantera::vcs_Cantera_update_vprob(), and VCS_SOLVE::vcs_prob_update().
vcs_SpeciesProperties * speciesProperty  (  const size_t  kindex  ) 
Retrieve the kth Species structure for the species belonging to this phase.
The index into this vector is the species index within the phase.
kindex  kth species index. 
Definition at line 1014 of file vcs_VolPhase.cpp.
Referenced by Cantera::vcs_Cantera_to_vprob(), VCS_SOLVE::vcs_prep_oneTime(), and VCS_SOLVE::vcs_prob_specifyFully().
int exists  (  )  const 
int indicating whether the phase exists or not
returns the m_existence int for the phase
Definition at line 1019 of file vcs_VolPhase.cpp.
Referenced by VCS_SOLVE::recheck_deleted_phase(), VCS_SOLVE::vcs_delete_species(), VCS_SOLVE::vcs_phasePopDeterminePossibleList(), VCS_SOLVE::vcs_popPhaseID(), VCS_SOLVE::vcs_popPhasePossible(), VCS_SOLVE::vcs_popPhaseRxnStepSizes(), VCS_SOLVE::vcs_reinsert_deleted(), VCS_SOLVE::vcs_RxnStepSizes(), and VCS_SOLVE::vcs_species_type().
void setExistence  (  const int  existence  ) 
Set the existence flag in the object.
Note the total moles of the phase must have been set appropriately before calling this routine.
existence  Phase existence flag 
Definition at line 1024 of file vcs_VolPhase.cpp.
References VCS_PHASE_EXIST_NO, and VCS_PHASE_EXIST_ZEROEDPHASE.
Referenced by Cantera::vcs_Cantera_update_vprob(), VCS_SOLVE::vcs_prob_specify(), VCS_SOLVE::vcs_reinsert_deleted(), and VCS_SOLVE::vcs_SSPhase().
size_t spGlobalIndexVCS  (  const size_t  spIndex  )  const 
Return the Global VCS index of the kth species in the phase.
spIndex  local species index (0 to the number of species in the phase) 
Definition at line 1054 of file vcs_VolPhase.cpp.
Referenced by VCS_PROB::prob_report(), VCS_SOLVE::recheck_deleted_phase(), Cantera::vcs_Cantera_to_vprob(), Cantera::vcs_Cantera_update_vprob(), VCS_SOLVE::vcs_chemPotPhase(), VCS_SOLVE::vcs_deltag(), VCS_SOLVE::vcs_deltag_Phase(), VCS_SOLVE::vcs_phasePopDeterminePossibleList(), VCS_SOLVE::vcs_phaseStabilityTest(), VCS_SOLVE::vcs_popPhaseID(), VCS_SOLVE::vcs_popPhasePossible(), VCS_SOLVE::vcs_popPhaseRxnStepSizes(), VCS_SOLVE::vcs_prob_specifyFully(), VCS_SOLVE::vcs_prob_update(), and VCS_SOLVE::vcs_switch_pos().
void setSpGlobalIndexVCS  (  const size_t  spIndex, 
const size_t  spGlobalIndex  
) 
set the Global VCS index of the kth species in the phase
spIndex  local species index (0 to the number of species in the phase) 
Definition at line 1059 of file vcs_VolPhase.cpp.
Referenced by VCS_PROB::addOnePhaseSpecies(), and VCS_SOLVE::vcs_switch_pos().
void setTotalMolesInert  (  const double  tMolesInert  ) 
Sets the total moles of inert in the phase.
tMolesInert  Value of the total kmols of inert species in the phase. 
Definition at line 1068 of file vcs_VolPhase.cpp.
References VCS_PHASE_EXIST_ALWAYS, VCS_PHASE_EXIST_NO, and VCS_PHASE_EXIST_YES.
Referenced by VCS_SOLVE::vcs_nondim_TP(), VCS_SOLVE::vcs_prob_specify(), VCS_SOLVE::vcs_prob_update(), and VCS_SOLVE::vcs_redim_TP().
double totalMolesInert  (  )  const 
returns the value of the total kmol of inert in the phase
Definition at line 1093 of file vcs_VolPhase.cpp.
Referenced by VCS_PROB::prob_report(), Cantera::vcs_Cantera_to_vprob(), Cantera::vcs_Cantera_update_vprob(), VCS_SOLVE::vcs_prob_specify(), VCS_SOLVE::vcs_prob_specifyFully(), and VCS_SOLVE::vcs_prob_update().
size_t elemGlobalIndex  (  const size_t  e  )  const 
Returns the global index of the local element index for the phase.
Definition at line 1098 of file vcs_VolPhase.cpp.
References AssertThrow.
Referenced by VCS_PROB::addOnePhaseSpecies(), and VCS_SOLVE::vcs_switch_elem_pos().
void setElemGlobalIndex  (  const size_t  eLocal, 
const size_t  eGlobal  
) 
sets a local phase element to a global index value
eLocal  Local phase element index 
eGlobal  Global phase element index 
Definition at line 1104 of file vcs_VolPhase.cpp.
References AssertThrow.
Referenced by VCS_PROB::addPhaseElements(), and VCS_SOLVE::vcs_switch_elem_pos().
size_t nElemConstraints  (  )  const 
Returns the number of element constraints.
Definition at line 1111 of file vcs_VolPhase.cpp.
Referenced by VCS_PROB::addOnePhaseSpecies(), VCS_PROB::addPhaseElements(), and VCS_SOLVE::vcs_switch_elem_pos().
std::string elementName  (  const size_t  e  )  const 
Name of the element constraint with index e
.
e  Element index. 
Definition at line 1116 of file vcs_VolPhase.cpp.
Referenced by VCS_PROB::addPhaseElements().
int elementType  (  const size_t  e  )  const 
Type of the element constraint with index e
.
e  Element index. 
Definition at line 1271 of file vcs_VolPhase.cpp.
Referenced by VCS_PROB::addPhaseElements().
void setElementType  (  const size_t  e, 
const int  eType  
) 
Set the element Type of the element constraint with index e
.
e  Element index 
eType  type of the element. 
Definition at line 1276 of file vcs_VolPhase.cpp.
size_t transferElementsFM  (  const ThermoPhase *const  tPhase  ) 
Transfer all of the element information from the ThermoPhase object to the vcs_VolPhase object.
Also decide whether we need a new charge neutrality element in the phase to enforce a charge neutrality constraint.
tPhase  Pointer to the ThermoPhase object 
Definition at line 1149 of file vcs_VolPhase.cpp.
References Phase::charge(), Cantera::chargeNeutralityElement(), Phase::elementName(), Phase::elementType(), Cantera::hasChargedSpecies(), Phase::id(), Phase::nAtoms(), Phase::nElements(), Cantera::npos, Phase::nSpecies(), VCS_ELEM_TYPE_CHARGENEUTRALITY, VCS_ELEM_TYPE_ELECTRONCHARGE, VCS_SPECIES_TYPE_INTERFACIALVOLTAGE, and VCS_SPECIES_TYPE_MOLNUM.
Referenced by Cantera::vcs_Cantera_to_vprob().
const Array2D & getFormulaMatrix  (  )  const 
Get a constant form of the Species Formula Matrix.
Returns a double**
pointer such that fm[e][f]
is the formula matrix entry for element e
for species k
Definition at line 1281 of file vcs_VolPhase.cpp.
Referenced by VCS_PROB::addOnePhaseSpecies().
int speciesUnknownType  (  const size_t  k  )  const 
Returns the type of the species unknown.
k  species index 
Definition at line 1286 of file vcs_VolPhase.cpp.
Referenced by Cantera::vcs_Cantera_to_vprob(), and VCS_SOLVE::vcs_prob_update().
size_t nSpecies  (  )  const 
Return the number of species in the phase.
Definition at line 1296 of file vcs_VolPhase.cpp.
Referenced by vcs_MultiPhaseEquil::equilibrate_TP(), VCS_PROB::prob_report(), VCS_SOLVE::recheck_deleted_phase(), Cantera::vcs_Cantera_to_vprob(), Cantera::vcs_Cantera_update_vprob(), VCS_SOLVE::vcs_chemPotPhase(), VCS_SOLVE::vcs_deltag(), VCS_SOLVE::vcs_phasePopDeterminePossibleList(), VCS_SOLVE::vcs_phaseStabilityTest(), VCS_SOLVE::vcs_popPhasePossible(), VCS_SOLVE::vcs_popPhaseRxnStepSizes(), VCS_SOLVE::vcs_prob_specify(), VCS_SOLVE::vcs_prob_specifyFully(), VCS_SOLVE::vcs_prob_update(), and VCS_SOLVE::vcs_solve_TP().

private 
Evaluate the activity coefficients at the current conditions.
We carry out a calculation whenever m_UpToDate_AC is false. Specifically whenever a phase goes zero, we do not carry out calculations on it.
Definition at line 299 of file vcs_VolPhase.cpp.
References VCS_DATA_PTR, and Cantera::warn_deprecated().

private 
Gibbs free energy calculation for standard states.
Calculate the Gibbs free energies for the standard states The results are held internally within the object.
Definition at line 349 of file vcs_VolPhase.cpp.
References VCS_SPECIES_THERMO::GStar_R_calc(), VCS_DATA_PTR, Cantera::vcsUtil_gasConstant(), and Cantera::warn_deprecated().

private 
Gibbs free energy calculation at a temperature for the reference state of each species.
Definition at line 322 of file vcs_VolPhase.cpp.
References VCS_SPECIES_THERMO::G0_R_calc(), VCS_DATA_PTR, Cantera::vcsUtil_gasConstant(), and Cantera::warn_deprecated().

private 
Molar volume calculation for standard states.
Calculate the molar volume for the standard states. The results are held internally within the object. Units are in m**3/kmol.
Definition at line 674 of file vcs_VolPhase.cpp.
References VCS_DATA_PTR, VCS_SPECIES_THERMO::VolStar_calc(), and Cantera::warn_deprecated().

private 
Calculate the partial molar volumes of all species and return the total volume.
Calculates these quantities internally and then stores them
Definition at line 699 of file vcs_VolPhase.cpp.
References VCS_DATA_PTR, VCS_SPECIES_THERMO::VolStar_calc(), and Cantera::warn_deprecated().

private 
Evaluation of Activity Coefficient Jacobians.
This is the derivative of the ln of the activity coefficient with respect to mole number of jth species. (temp, pressure, and other mole numbers held constant)
We employ a finite difference derivative approach here. Because we have to change the mole numbers, this is not a const function, even though the paradigm would say that it should be.
Definition at line 735 of file vcs_VolPhase.cpp.
References VCS_DATA_PTR.

private 
Updates the mole fraction dependencies.
Whenever the mole fractions change, this routine should be called.
Definition at line 393 of file vcs_VolPhase.cpp.
References Cantera::warn_deprecated().

private 
Backtrack value of VCS_SOLVE *.
Note the default for this is 0. That's a valid value too, since VCS_PROB also uses vcs_VolPhase objects.
Definition at line 573 of file vcs_VolPhase.h.
size_t VP_ID_ 
Original ID of the phase in the problem.
If a nonideal phase splits into two due to a miscibility gap, these numbers will stay the same after the split.
Definition at line 581 of file vcs_VolPhase.h.
Referenced by VCS_PROB::prob_report(), Cantera::vcs_Cantera_to_vprob(), Cantera::vcs_Cantera_update_vprob(), and VCS_SOLVE::vcs_prob_specify().
bool m_singleSpecies 
If true, this phase consists of a single species.
Definition at line 584 of file vcs_VolPhase.h.
Referenced by VCS_PROB::prob_report(), VCS_SOLVE::recheck_deleted_phase(), VCS_SOLVE::vcs_add_all_deleted(), VCS_SOLVE::vcs_CalcLnActCoeffJac(), Cantera::vcs_Cantera_to_vprob(), Cantera::vcs_Cantera_update_vprob(), VCS_SOLVE::vcs_deltag(), VCS_SOLVE::vcs_deltag_Phase(), VCS_SOLVE::vcs_dfe(), VCS_SOLVE::vcs_popPhaseID(), VCS_SOLVE::vcs_popPhaseRxnStepSizes(), VCS_SOLVE::vcs_prob_specify(), VCS_SOLVE::vcs_RxnStepSizes(), and VCS_SOLVE::vcs_SSPhase().
bool m_gasPhase 
If true, this phase is a gasphase like phase.
A RTlog(p/1atm) term is added onto the chemical potential for inert species if this is true.
Definition at line 591 of file vcs_VolPhase.h.
Referenced by VCS_PROB::prob_report(), Cantera::vcs_Cantera_to_vprob(), Cantera::vcs_Cantera_update_vprob(), VCS_SOLVE::vcs_GibbsPhase(), VCS_SOLVE::vcs_prob_specify(), and VCS_SOLVE::vcs_Total_Gibbs().
int m_eqnState 
Type of the equation of state.
The known types are listed at the top of this file.
Definition at line 597 of file vcs_VolPhase.h.
Referenced by VCS_PROB::prob_report(), Cantera::vcs_Cantera_to_vprob(), Cantera::vcs_Cantera_update_vprob(), and VCS_SOLVE::vcs_prob_specify().
size_t ChargeNeutralityElement 
This is the element number for the charge neutrality condition of the phase.
If it has one. If it does not have a charge neutrality constraint, then this value is equal to 1
Definition at line 605 of file vcs_VolPhase.h.
int p_VCS_UnitsFormat 
Units for the chemical potential data, pressure data, volume, and species amounts.
All internally stored quantities will have these units. Also, printed quantities will display in these units. Input quantities are expected in these units.
Chem_Pot  Pres  vol  moles  

1  VCS_UNITS_KCALMOL  kcal/gmol  Pa  m**3  kmol 
0  VCS_UNITS_UNITLESS  MU / RT > no units  Pa  m**3  kmol 
1  VCS_UNITS_KJMOL  kJ / gmol  Pa  m**3  kmol 
2  VCS_UNITS_KELVIN  KELVIN > MU / R  Pa  m**3  kmol 
3  VCS_UNITS_MKS  Joules / Kmol (Cantera)  Pa  m**3  kmol 
see vcs_defs.h for more information.
Currently, this value should be the same as the owning VCS_PROB or VCS_SOLVE object. There is no code for handling anything else atm.
(This variable is needed for the vcsc code, where it is not equal to VCS_UNITS_MKS).
Definition at line 630 of file vcs_VolPhase.h.
Referenced by Cantera::vcs_Cantera_to_vprob().
int p_activityConvention 
Convention for the activity formulation.
Definition at line 638 of file vcs_VolPhase.h.
Referenced by Cantera::vcs_Cantera_to_vprob(), and VCS_SOLVE::vcs_prob_specifyFully().

private 
Number of element constraints within the problem.
This is usually equal to the number of elements.
Definition at line 645 of file vcs_VolPhase.h.

private 
vector of strings containing the element constraint names
Length = nElemConstraints
Definition at line 651 of file vcs_VolPhase.h.

private 
boolean indicating whether an element constraint is active for the current problem
Definition at line 655 of file vcs_VolPhase.h.

private 
Type of the element constraint.
m_elType[j] = type of the element:
Definition at line 668 of file vcs_VolPhase.h.

private 
Formula Matrix for the phase.
FormulaMatrix(kspec,j) = Formula Matrix for the species Number of elements, j, in the kspec species
Definition at line 675 of file vcs_VolPhase.h.

private 
Type of the species unknown.
SpeciesUnknownType[k] = type of species
Definition at line 685 of file vcs_VolPhase.h.

private 
Index of the element number in the global list of elements stored in VCS_PROB or VCS_SOLVE.
Definition at line 689 of file vcs_VolPhase.h.

private 
Number of species in the phase.
Definition at line 692 of file vcs_VolPhase.h.
std::string PhaseName 
String name for the phase.
Definition at line 696 of file vcs_VolPhase.h.
Referenced by VCS_PROB::prob_report(), Cantera::vcs_Cantera_to_vprob(), Cantera::vcs_Cantera_update_vprob(), VCS_SOLVE::vcs_delete_multiphase(), VCS_SOLVE::vcs_popPhaseID(), VCS_SOLVE::vcs_popPhaseRxnStepSizes(), VCS_SOLVE::vcs_prob_specify(), VCS_SOLVE::vcs_prob_specifyFully(), and VCS_SOLVE::vcs_report().

private 
Total moles of inert in the phase.
Definition at line 700 of file vcs_VolPhase.h.

private 
Boolean indicating whether the phase is an ideal solution and therefore its molarbased activity coefficients are uniformly equal to one.
Definition at line 705 of file vcs_VolPhase.h.

private 
Current state of existence:
Definition at line 721 of file vcs_VolPhase.h.

private 
This is always equal to zero. Am anticipating the case where the phase potential is species # 0, for multiphase phases. Right now we have the phase potential equal to 0 for single species phases, where we set by hand the mole fraction of species 0 to one.
Definition at line 731 of file vcs_VolPhase.h.

private 
Index into the species vectors.
Maps the phase species number into the global species number. Note, as part of the vcs algorithm, the order of the species vector is changed during the algorithm
Definition at line 739 of file vcs_VolPhase.h.

private 
Vector of Species structures for the species belonging to this phase.
The index into this vector is the species index within the phase.
Definition at line 745 of file vcs_VolPhase.h.

private 
If this is true, then calculations are actually performed within Cantera.
Definition at line 750 of file vcs_VolPhase.h.

private 
If we are using Cantera, this is the pointer to the ThermoPhase object.
If not, this is null.
Definition at line 756 of file vcs_VolPhase.h.

private 
Total mols in the phase. units are kmol.
Definition at line 759 of file vcs_VolPhase.h.

private 
Vector of the current mole fractions for species in the phase.
Definition at line 762 of file vcs_VolPhase.h.

private 
Vector of current creationMoleNumbers_.
These are the actual unknowns in the phase stability problem
Definition at line 768 of file vcs_VolPhase.h.

private 
Vector of creation global reaction numbers for the phase stability problem.
The phase stability problem requires a global reaction number for each species in the phase. Usually this is the krxn = kglob  M for species in the phase that are not components. For component species, the choice of the reaction is one which maximizes the chance that the phase pops into (or remains in) existence.
The index here is the local phase species index. the value of the variable is the global vcs reaction number. Note, that the global reaction number will go out of order when the species positions are swapped. So, this number has to be recalculated.
Length = number of species in phase
Definition at line 785 of file vcs_VolPhase.h.

private 
If the potential is a solution variable in VCS, it acts as a species.
This is the species index in the phase for the potential
Definition at line 789 of file vcs_VolPhase.h.

mutableprivate 
Total Volume of the phase. Units are m**3.
Definition at line 792 of file vcs_VolPhase.h.

mutableprivate 
Vector of calculated SS0 chemical potentials for the current Temperature.
Note, This is the chemical potential derived strictly from the polynomial in temperature. Pressure effects have to be added in to get to the standard state.
Units > depends on VCS_UnitsFormat variable. Cantera > J/kmol
Definition at line 803 of file vcs_VolPhase.h.

mutableprivate 
Vector of calculated Star chemical potentials for the current Temperature and pressure.
Note, This is the chemical potential at unit activity. Thus, we can call it the standard state chemical potential as well.
Units > depends on VCS_UnitsFormat variable. Cantera > J/kmol.
Definition at line 813 of file vcs_VolPhase.h.

mutableprivate 
Vector of the Star molar Volumes of the species. units m3 / kmol.
Definition at line 816 of file vcs_VolPhase.h.

mutableprivate 
Vector of the Partial molar Volumes of the species. units m3 / kmol.
Definition at line 819 of file vcs_VolPhase.h.

mutableprivate 
Vector of calculated activity coefficients for the current state.
Whether or not this vector is current is determined by the bool m_UpToDate_AC.
Definition at line 826 of file vcs_VolPhase.h.

mutableprivate 
Vector of the derivatives of the ln activity coefficient wrt to the current mole number multiplied by the current phase moles.
np_dLnActCoeffdMolNumber(k,j);
Definition at line 835 of file vcs_VolPhase.h.

private 
Status.
valid values are
Definition at line 844 of file vcs_VolPhase.h.

private 
Value of the potential for the phase (Volts)
Definition at line 847 of file vcs_VolPhase.h.

private 
Boolean indicating whether the object has an uptodate mole number vector and potential with respect to the current vcs state calc status.
Definition at line 851 of file vcs_VolPhase.h.

mutableprivate 
Boolean indicating whether activity coefficients are up to date.
Activity coefficients and volume calculations are lagged. They are only called when they are needed (and when the state has changed so that they need to be recalculated).
Definition at line 859 of file vcs_VolPhase.h.

mutableprivate 
Boolean indicating whether Star volumes are up to date.
Activity coefficients and volume calculations are lagged. They are only called when they are needed (and when the state has changed so that they need to be recalculated). Star volumes are sensitive to temperature and pressure
Definition at line 868 of file vcs_VolPhase.h.

mutableprivate 
Boolean indicating whether partial molar volumes are up to date.
Activity coefficients and volume calculations are lagged. They are only called when they are needed (and when the state has changed so that they need to be recalculated). partial molar volumes are sensitive to everything
Definition at line 877 of file vcs_VolPhase.h.

mutableprivate 
Boolean indicating whether GStar is up to date.
GStar is sensitive to the temperature and the pressure, only
Definition at line 883 of file vcs_VolPhase.h.

mutableprivate 
Boolean indicating whether G0 is up to date.
G0 is sensitive to the temperature and the pressure, only
Definition at line 889 of file vcs_VolPhase.h.

private 
Current value of the temperature for this object, and underlying objects.
Definition at line 892 of file vcs_VolPhase.h.

private 
Current value of the pressure for this object, and underlying objects.
Definition at line 895 of file vcs_VolPhase.h.