Deprecate StFlow::evalResidual

doc/sphinx/reference/onedim/governing-equations.md

@@ -7,7 +7,7 @@ solution to reduce the three-dimensional governing equations to a single dimensi
 ## Axisymmetric Stagnation Flow
 
 The governing equations for a steady axisymmetric stagnation flow follow those derived
-in Section 7.2 of {cite:t}`kee2017` and are implemented by class {ct}`StFlow`.
+in Section 7.2 of {cite:t}`kee2017` and are implemented by class {ct}`Flow1D`.
 
 *Continuity*:
 
@@ -99,7 +99,7 @@ $$
 where $D_{ki}$ is the multicomponent diffusion coefficient and $D_k^T$ is the Soret
 diffusion coefficient. Inclusion of the Soret calculation must be explicitly enabled
 when setting up the simulation, on top of specifying a multicomponent transport model,
-for example by using the {ct}`StFlow::enableSoret` method (C++) or setting the
+for example by using the {ct}`Flow1D::enableSoret` method (C++) or setting the
 {py:attr}`~cantera.FlameBase.soret_enabled` property (Python).
 
 ## Boundary Conditions
@@ -295,4 +295,4 @@ $$
 
 $$
 \dot{m}_\t{in,right} = - \rho(z_{\t{in,right}}) U_o(z_{\t{in,right}})
-$$
+$$

include/cantera/clib/ctonedim.h

@@ -59,6 +59,16 @@ extern "C" {
 
     CANTERA_CAPI int inlet_setSpreadRate(int i, double v);
 
+    CANTERA_CAPI int flow1D_new(int iph, int ikin, int itr, int itype);
+    CANTERA_CAPI int flow1D_setTransport(int i, int itr);
+    CANTERA_CAPI int flow1D_enableSoret(int i, int iSoret);
+    CANTERA_CAPI int flow1D_setPressure(int i, double p);
+    CANTERA_CAPI double flow1D_pressure(int i);
+    CANTERA_CAPI int flow1D_setFixedTempProfile(int i, size_t n, const double* pos,
+            size_t m, const double* temp);
+    CANTERA_CAPI int flow1D_solveEnergyEqn(int i, int flag);
+
+    //! @todo: Remove all functions with `stflow` prefix after Cantera 3.1
     CANTERA_CAPI int stflow_new(int iph, int ikin, int itr, int itype);
     CANTERA_CAPI int stflow_setTransport(int i, int itr);
     CANTERA_CAPI int stflow_enableSoret(int i, int iSoret);

include/cantera/oneD/Boundary1D.h

@@ -13,7 +13,7 @@
 #include "Domain1D.h"
 #include "cantera/thermo/SurfPhase.h"
 #include "cantera/kinetics/InterfaceKinetics.h"
-#include "StFlow.h"
+#include "Flow1D.h"
 
 namespace Cantera
 {
@@ -109,8 +109,8 @@ class Boundary1D : public Domain1D
 protected:
     void _init(size_t n);
 
-    StFlow* m_flow_left = nullptr;
-    StFlow* m_flow_right = nullptr;
+    Flow1D* m_flow_left = nullptr;
+    Flow1D* m_flow_right = nullptr;
     size_t m_ilr = 0;
     size_t m_left_nv = 0;
     size_t m_right_nv = 0;
@@ -176,7 +176,7 @@ class Inlet1D : public Boundary1D
     size_t m_nsp = 0;
     vector<double> m_yin;
     string m_xstr;
-    StFlow* m_flow = nullptr;
+    Flow1D* m_flow = nullptr;
 };
 
 /**
@@ -293,7 +293,7 @@ class OutletRes1D : public Boundary1D
     size_t m_nsp = 0;
     vector<double> m_yres;
     string m_xstr;
-    StFlow* m_flow = nullptr;
+    Flow1D* m_flow = nullptr;
 };
 
 /**