Skip to content

Commit

Permalink
[Doc] Note XML deprecation with all XML examples
Browse files Browse the repository at this point in the history
  • Loading branch information
speth committed Jan 5, 2022
1 parent a3b6eb6 commit 698c51c
Show file tree
Hide file tree
Showing 9 changed files with 42 additions and 0 deletions.
11 changes: 11 additions & 0 deletions include/cantera/thermo/DebyeHuckel.h
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,8 @@ class PDSS_Water;
* input file via the `stoichIsMods` XML block, where the charge for k1 is also
* specified. An example is given below:
*
* *Note: The XML input format is deprecated and will be removed in %Cantera 3.0*
*
* @code
* <stoichIsMods>
* NaCl(aq):-1.0
Expand Down Expand Up @@ -201,6 +203,8 @@ class PDSS_Water;
* state for the species, at this time. Therefore, this information is put under
* the `activityCoefficient` XML block. An example is given below
*
* *Note: The XML input format is deprecated and will be removed in %Cantera 3.0*
*
* @code
* <electrolyteSpeciesType>
* H2L(L):solvent
Expand Down Expand Up @@ -327,6 +331,8 @@ class PDSS_Water;
* An example `activityCoefficients` XML block for this formulation is supplied
* below
*
* *Note: The XML input format is deprecated and will be removed in %Cantera 3.0*
*
* @code
* <activityCoefficients model="Beta_ij">
* <!-- A_Debye units = sqrt(kg/gmol) -->
Expand Down Expand Up @@ -407,6 +413,9 @@ class PDSS_Water;
* - B_Debye = 3.28640E9 (kg/gmol)^(1/2) / m
*
* An example of a fixed value implementation is given below.
*
* *Note: The XML input format is deprecated and will be removed in %Cantera 3.0*
*
* @code
* <activityCoefficients model="Beta_ij">
* <!-- A_Debye units = sqrt(kg/gmol) -->
Expand Down Expand Up @@ -477,6 +486,8 @@ class PDSS_Water;
*
* ## XML Example
*
* *Note: The XML input format is deprecated and will be removed in %Cantera 3.0*
*
* The phase model name for this is called StoichSubstance. It must be supplied
* as the model attribute of the thermo XML element entry. Within the phase XML
* block, the density of the phase must be specified. An example of an XML file
Expand Down
17 changes: 17 additions & 0 deletions include/cantera/thermo/HMWSoln.h
Original file line number Diff line number Diff line change
Expand Up @@ -515,6 +515,8 @@ class WaterProps;
* document. An example of the `beta0` block that fits the `COMPLEX1`
* temperature dependence given above is
*
* *Note: The XML input format is deprecated and will be removed in %Cantera 3.0*
*
* @code
* <binarySaltParameters cation="Na+" anion="OH-">
* <beta0> q0, q1, q2, q3, q4 </beta0>
Expand Down Expand Up @@ -589,6 +591,8 @@ class WaterProps;
* temperature or pressure dependence of this parameter is currently allowed. An
* example of the block is presented below.
*
* *Note: The XML input format is deprecated and will be removed in %Cantera 3.0*
*
* @code
* <thetaCation cation1="Na+" cation2="H+">
* <Theta> 0.036 </Theta>
Expand All @@ -614,6 +618,8 @@ class WaterProps;
* different information about thetaAnion (or thetaCation) in different blocks.
* It's ok to specify duplicate but consistent information in multiple blocks.
*
* *Note: The XML input format is deprecated and will be removed in %Cantera 3.0*
*
* @code
* <psiCommonCation cation="Na+" anion1="Cl-" anion2="OH-">
* <Theta> -0.05 </Theta>
Expand All @@ -633,6 +639,8 @@ class WaterProps;
* symmetrical; `species1` and `species2` may be reversed and the term will be
* the same. An example is given below.
*
* *Note: The XML input format is deprecated and will be removed in %Cantera 3.0*
*
* @code
* <lambdaNeutral species1="CO2" species2="CH4">
* <lambda> 0.05 </lambda>
Expand All @@ -646,6 +654,8 @@ class WaterProps;
* An example `activityCoefficients` XML block for this formulation is supplied
* below
*
* *Note: The XML input format is deprecated and will be removed in %Cantera 3.0*
*
* @code
* <activityCoefficients model="Pitzer" TempModel="complex1">
* <!-- Pitzer Coefficients
Expand Down Expand Up @@ -747,6 +757,9 @@ class WaterProps;
* - B_Debye = 3.28640E9 (kg/gmol)^(1/2) / m
*
* An example of a fixed value implementation is given below.
*
* *Note: The XML input format is deprecated and will be removed in %Cantera 3.0*
*
* @code
* <activityCoefficients model="Pitzer">
* <!-- A_Debye units = sqrt(kg/gmol) -->
Expand All @@ -758,6 +771,8 @@ class WaterProps;
* An example of a variable value implementation within the HMWSoln object is
* given below. The model attribute, "water", triggers the full implementation.
*
* *Note: The XML input format is deprecated and will be removed in %Cantera 3.0*
*
* @code
* <activityCoefficients model="Pitzer">
* <!-- A_Debye units = sqrt(kg/gmol) -->
Expand Down Expand Up @@ -914,6 +929,8 @@ class WaterProps;
*
* ## XML Example
*
* *Note: The XML input format is deprecated and will be removed in %Cantera 3.0*
*
* The phase model name for this is called StoichSubstance. It must be supplied
* as the model attribute of the thermo XML element entry. Within the phase XML
* block, the density of the phase must be specified. An example of an XML file
Expand Down
2 changes: 2 additions & 0 deletions include/cantera/thermo/IdealGasPhase.h
Original file line number Diff line number Diff line change
Expand Up @@ -241,6 +241,8 @@ namespace Cantera
*
* ## XML Example
*
* *Note: The XML input format is deprecated and will be removed in %Cantera 3.0*
*
* An example of an XML Element named phase setting up a IdealGasPhase
* object named silane is given below.
*
Expand Down
2 changes: 2 additions & 0 deletions include/cantera/thermo/IdealMolalSoln.h
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,8 @@ namespace Cantera
* The value and form of the activity concentration will affect reaction rate
* constants involving species in this phase.
*
* *Note: The XML input format is deprecated and will be removed in %Cantera 3.0*
*
* <thermo model="IdealMolalSoln">
* <standardConc model="solvent_volume" />
* <solvent> H2O(l) </solvent>
Expand Down
2 changes: 2 additions & 0 deletions include/cantera/thermo/LatticePhase.h
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,8 @@ namespace Cantera
*
* ## XML Example
*
* *Note: The XML input format is deprecated and will be removed in %Cantera 3.0*
*
* An example of an XML Element named phase setting up a LatticePhase object
* named "O_lattice_SiO2" is given below.
*
Expand Down
2 changes: 2 additions & 0 deletions include/cantera/thermo/PDSS_SSVol.h
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,8 @@ namespace Cantera
*
* ## XML Example
*
* *Note: The XML input format is deprecated and will be removed in %Cantera 3.0*
*
* An example of the specification of a standard state for the LiCl molten salt
* which has a temperature dependent standard state volume.
*
Expand Down
2 changes: 2 additions & 0 deletions include/cantera/thermo/StoichSubstance.h
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,8 @@ namespace Cantera
*
* ## XML Example
*
* *Note: The XML input format is deprecated and will be removed in %Cantera 3.0*
*
* The phase model name for this is called StoichSubstance. It must be supplied
* as the model attribute of the thermo XML element entry. Within the phase XML
* block, the density of the phase must be specified. An example of an XML file
Expand Down
2 changes: 2 additions & 0 deletions include/cantera/thermo/SurfPhase.h
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,8 @@ namespace Cantera
*
* ## XML Example
*
* *Note: The XML input format is deprecated and will be removed in %Cantera 3.0*
*
* An example of an XML Element named phase setting up a SurfPhase object named
* diamond_100 is given below.
*
Expand Down
2 changes: 2 additions & 0 deletions include/cantera/thermo/WaterSSTP.h
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,8 @@ class WaterProps;
*
* ## XML Example
*
* *Note: The XML input format is deprecated and will be removed in %Cantera 3.0*
*
* An example of an XML Element named phase setting up a WaterSSTP object with
* id "water" is given below.
*
Expand Down

0 comments on commit 698c51c

Please sign in to comment.