From 698c51cf27cb582e05b8677b787d9d68e0c91d5f Mon Sep 17 00:00:00 2001 From: Ray Speth Date: Tue, 4 Jan 2022 22:17:21 -0500 Subject: [PATCH] [Doc] Note XML deprecation with all XML examples --- include/cantera/thermo/DebyeHuckel.h | 11 +++++++++++ include/cantera/thermo/HMWSoln.h | 17 +++++++++++++++++ include/cantera/thermo/IdealGasPhase.h | 2 ++ include/cantera/thermo/IdealMolalSoln.h | 2 ++ include/cantera/thermo/LatticePhase.h | 2 ++ include/cantera/thermo/PDSS_SSVol.h | 2 ++ include/cantera/thermo/StoichSubstance.h | 2 ++ include/cantera/thermo/SurfPhase.h | 2 ++ include/cantera/thermo/WaterSSTP.h | 2 ++ 9 files changed, 42 insertions(+) diff --git a/include/cantera/thermo/DebyeHuckel.h b/include/cantera/thermo/DebyeHuckel.h index 642695b052..c194fca888 100644 --- a/include/cantera/thermo/DebyeHuckel.h +++ b/include/cantera/thermo/DebyeHuckel.h @@ -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 * * NaCl(aq):-1.0 @@ -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 * * H2L(L):solvent @@ -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 * * @@ -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 * * @@ -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 diff --git a/include/cantera/thermo/HMWSoln.h b/include/cantera/thermo/HMWSoln.h index fd7576c55c..55a10c7739 100644 --- a/include/cantera/thermo/HMWSoln.h +++ b/include/cantera/thermo/HMWSoln.h @@ -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 * * q0, q1, q2, q3, q4 @@ -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 * * 0.036 @@ -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 * * -0.05 @@ -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 * * 0.05 @@ -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 * * @@ -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 * * @@ -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 diff --git a/include/cantera/thermo/IdealGasPhase.h b/include/cantera/thermo/IdealGasPhase.h index 6d5cd377dc..7a588eb19d 100644 --- a/include/cantera/thermo/IdealGasPhase.h +++ b/include/cantera/thermo/IdealGasPhase.h @@ -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. * diff --git a/include/cantera/thermo/IdealMolalSoln.h b/include/cantera/thermo/IdealMolalSoln.h index 4405b7118e..864987e671 100644 --- a/include/cantera/thermo/IdealMolalSoln.h +++ b/include/cantera/thermo/IdealMolalSoln.h @@ -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* + * * * * H2O(l) diff --git a/include/cantera/thermo/LatticePhase.h b/include/cantera/thermo/LatticePhase.h index 051bc931b8..d5885d2041 100644 --- a/include/cantera/thermo/LatticePhase.h +++ b/include/cantera/thermo/LatticePhase.h @@ -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. * diff --git a/include/cantera/thermo/PDSS_SSVol.h b/include/cantera/thermo/PDSS_SSVol.h index 2c6985651f..8ec3fc9d75 100644 --- a/include/cantera/thermo/PDSS_SSVol.h +++ b/include/cantera/thermo/PDSS_SSVol.h @@ -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. * diff --git a/include/cantera/thermo/StoichSubstance.h b/include/cantera/thermo/StoichSubstance.h index 8754df022d..be9dc3ebf5 100644 --- a/include/cantera/thermo/StoichSubstance.h +++ b/include/cantera/thermo/StoichSubstance.h @@ -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 diff --git a/include/cantera/thermo/SurfPhase.h b/include/cantera/thermo/SurfPhase.h index a4f853db78..769ada023f 100644 --- a/include/cantera/thermo/SurfPhase.h +++ b/include/cantera/thermo/SurfPhase.h @@ -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. * diff --git a/include/cantera/thermo/WaterSSTP.h b/include/cantera/thermo/WaterSSTP.h index 924cc949d2..02fa4c12f7 100644 --- a/include/cantera/thermo/WaterSSTP.h +++ b/include/cantera/thermo/WaterSSTP.h @@ -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. *