Zerod connector nodes

include/cantera/clib/ctreactor.h

@@ -19,12 +19,12 @@ extern "C" {
 
     CANTERA_CAPI int reactor_new(const char* type, int n, const char* name);
     CANTERA_CAPI int reactor_del(int i);
+    CANTERA_CAPI int reactor_type(int i, int len, char* nbuf);
     CANTERA_CAPI int reactor_name(int i, int len, char* nbuf);
     CANTERA_CAPI int reactor_setName(int i, const char* name);
     CANTERA_CAPI int reactor_setInitialVolume(int i, double v);
     CANTERA_CAPI int reactor_setChemistry(int i, int cflag);
     CANTERA_CAPI int reactor_setEnergy(int i, int eflag);
-    CANTERA_CAPI int reactor_setSolution(int i, int n);
     CANTERA_CAPI double reactor_mass(int i);
     CANTERA_CAPI double reactor_volume(int i);
     CANTERA_CAPI double reactor_density(int i);
@@ -51,11 +51,12 @@ extern "C" {
     CANTERA_CAPI double reactornet_atol(int i);
     CANTERA_CAPI double reactornet_sensitivity(int i, const char* v, int p, int r);
 
-    CANTERA_CAPI int flowdev_new(const char* type, const char* name);
-    CANTERA_CAPI int flowdev_del(int i);
-    CANTERA_CAPI int flowdev_name(int i, int len, char* nbuf);
-    CANTERA_CAPI int flowdev_setName(int i, const char* name);
-    CANTERA_CAPI int flowdev_install(int i, int n, int m);
+    CANTERA_CAPI int connector_new(const char* type, int r0, int r1, const char* name);
+    CANTERA_CAPI int connector_del(int i);
+    CANTERA_CAPI int connector_type(int i, int len, char* nbuf);
+    CANTERA_CAPI int connector_name(int i, int len, char* nbuf);
+    CANTERA_CAPI int connector_setName(int i, const char* name);
+
     CANTERA_CAPI int flowdev_setPrimary(int i, int n);
     CANTERA_CAPI double flowdev_massFlowRate(int i);
     CANTERA_CAPI int flowdev_setMassFlowCoeff(int i, double v);
@@ -64,11 +65,6 @@ extern "C" {
     CANTERA_CAPI int flowdev_setPressureFunction(int i, int n);
     CANTERA_CAPI int flowdev_setTimeFunction(int i, int n);
 
-    CANTERA_CAPI int wall_new(const char* type, const char* name);
-    CANTERA_CAPI int wall_del(int i);
-    CANTERA_CAPI int wall_name(int i, int len, char* nbuf);
-    CANTERA_CAPI int wall_setName(int i, const char* name);
-    CANTERA_CAPI int wall_install(int i, int n, int m);
     CANTERA_CAPI double wall_expansionRate(int i);
     CANTERA_CAPI double wall_heatRate(int i);
     CANTERA_CAPI double wall_area(int i);
@@ -79,7 +75,6 @@ extern "C" {
     CANTERA_CAPI int wall_setExpansionRateCoeff(int i, double k);
     CANTERA_CAPI int wall_setVelocity(int i, int n);
     CANTERA_CAPI int wall_setEmissivity(int i, double epsilon);
-    CANTERA_CAPI int wall_ready(int i);
 
     CANTERA_CAPI int reactorsurface_new(const char* name);
     CANTERA_CAPI int reactorsurface_del(int i);

include/cantera/zeroD/ConnectorFactory.h

@@ -0,0 +1,80 @@
+//! @file ConnectorFactory.h
+
+// This file is part of Cantera. See License.txt in the top-level directory or
+// at https://cantera.org/license.txt for license and copyright information.
+
+#ifndef CONNECTOR_FACTORY_H
+#define CONNECTOR_FACTORY_H
+
+#include "cantera/base/FactoryBase.h"
+#include "cantera/zeroD/ConnectorNode.h"
+
+namespace Cantera
+{
+
+class FlowDevice;
+class WallBase;
+
+//! Factory class to create ConnectorNode objects.
+//!
+//! This class is mainly used via the newConnectorNode() function, for example:
+//!
+//! ```cpp
+//!     shared_ptr<ConnectorNode> valve = newConnectorNode("Valve", r0, r1, "my_valve");
+//! ```
+//!
+//! where `r0` and `r1` are reactor objects.
+class ConnectorFactory :
+    public Factory<ConnectorNode,
+                   shared_ptr<ReactorBase>, shared_ptr<ReactorBase>, const string&>
+{
+public:
+    static ConnectorFactory* factory();
+
+    void deleteFactory() override;
+
+private:
+    static ConnectorFactory* s_factory;
+    static std::mutex connector_mutex;
+    ConnectorFactory();
+};
+
+//! @defgroup connectorGroup Connectors
+//! %ConnectorNode objects connect zero-dimensional reactors.
+//! ConnectorNode objects should be instantiated via the newConnectorNode() function,
+//! for example:
+//!
+//! ```cpp
+//!     shared_ptr<ConnectorNode> valve = newConnectorNode("Valve", r0, r1, "my_valve");
+//! ```
+//!
+//! where `r0` and `r1` are reactor objects.
+//!
+//! @since New in %Cantera 3.2.
+//!
+//! @ingroup zerodGroup
+//! @{
+
+//! Create a %ConnectorNode object of the specified type
+//! @param model  String specifying reactor type.
+//! @param r0  First reactor.
+//! @param r1  Second reactor.
+//! @param name  Name of the connector.
+//! @since New in %Cantera 3.2.
+shared_ptr<ConnectorNode> newConnectorNode(const string& model,
+                                           shared_ptr<ReactorBase> r0,
+                                           shared_ptr<ReactorBase> r1,
+                                           const string& name="(none)");
+
+//! Create a FlowDevice object of the specified type
+//! @since Starting in %Cantera 3.1, this method returns a `shared_ptr<FlowDevice>`
+shared_ptr<FlowDevice> newFlowDevice(const string& model, const string& name="(none)");
+
+//! Create a WallBase object of the specified type
+//! @since Starting in %Cantera 3.1, this method returns a `shared_ptr<WallBase>`
+shared_ptr<WallBase> newWall(const string& model, const string& name="(none)");
+
+//! @}
+}
+
+#endif

include/cantera/zeroD/ConnectorNode.h

@@ -0,0 +1,72 @@
+//! @file ConnectorNode.h
+
+// This file is part of Cantera. See License.txt in the top-level directory or
+// at https://cantera.org/license.txt for license and copyright information.
+
+#ifndef CT_CONNECTOR_H
+#define CT_CONNECTOR_H
+
+#include "cantera/base/ct_defs.h"
+#include "cantera/base/global.h"
+
+namespace Cantera
+{
+class ReactorBase;
+
+/**
+ * Base class for walls and flow devices connecting reactors.
+ * In a reactor network, walls and flow devices (valves, pressure regulators, etc.)
+ * form edges of a directed graph that connect reactors that form nodes.
+ *
+ * @since New in %Cantera 3.1.
+ *
+ * @ingroup connectorGroup
+ */
+class ConnectorNode
+{
+public:
+    //! Transitional constructor.
+    //! @todo  Implement deprecation warning.
+    ConnectorNode(const string& name="(none)") : m_name(name) {}
+
+    //! Instantiate a ConnectorNode object with associated ReactorBase objects.
+    //! @param r0  First reactor.
+    //! @param r1  Second reactor.
+    //! @param name  Name of the connector.
+    ConnectorNode(shared_ptr<ReactorBase> r0, shared_ptr<ReactorBase> r1,
+                  const string& name="(none)") : m_nodes({r0, r1}), m_name(name) {}
+
+    virtual ~ConnectorNode() = default;
+    ConnectorNode(const ConnectorNode&) = delete;
+    ConnectorNode& operator=(const ConnectorNode&) = delete;
+
+    //! String indicating the connector implemented. Usually
+    //! corresponds to the name of the derived class.
+    virtual string type() const {
+        return "ConnectorNode";
+    }
+
+    //! Retrieve connector name.
+    string name() const {
+        return m_name;
+    }
+
+    //! Set connector name.
+    void setName(const string& name) {
+        m_name = name;
+    }
+
+    //! Set the default name of a connector. Returns `false` if it was previously set.
+    void setDefaultName(map<string, int>& counts);
+
+protected:
+    //! Pair of reactors forming end points of the connector.
+    pair<shared_ptr<ReactorBase>, shared_ptr<ReactorBase>> m_nodes;
+
+    string m_name;  //!< ConnectorNode name.
+    bool m_defaultNameSet = false;  //!< `true` if default name has been previously set.
+};
+
+}
+
+#endif

include/cantera/zeroD/FlowDevice.h

@@ -9,6 +9,7 @@
 #include "cantera/base/ct_defs.h"
 #include "cantera/base/global.h"
 #include "cantera/base/ctexceptions.h"
+#include "ConnectorNode.h"
 
 namespace Cantera
 {
@@ -18,36 +19,19 @@
 /**
  * Base class for 'flow devices' (valves, pressure regulators, etc.)
  * connecting reactors.
- * @ingroup flowDeviceGroup
+ * @ingroup connectorGroup
  */
-class FlowDevice
+class FlowDevice : public ConnectorNode
 {
 public:
-    FlowDevice(const string& name="(none)") : m_name(name) {}
+    FlowDevice(shared_ptr<ReactorBase> r0, shared_ptr<ReactorBase> r1,
+               const string& name="(none)");
+    using ConnectorNode::ConnectorNode;  // inherit constructors
 
-    virtual ~FlowDevice() = default;
-    FlowDevice(const FlowDevice&) = delete;
-    FlowDevice& operator=(const FlowDevice&) = delete;
-
-    //! String indicating the flow device implemented. Usually
-    //! corresponds to the name of the derived class.
-    virtual string type() const {
+    string type() const override {
         return "FlowDevice";
     }
 
-    //! Retrieve flow device name.
-    string name() const {
-        return m_name;
-    }
-
-    //! Set flow device name.
-    void setName(const string& name) {
-        m_name = name;
-    }
-
-    //! Set the default name of a flow device. Returns `false` if it was previously set.
-    bool setDefaultName(map<string, int>& counts);
-
     //! Mass flow rate (kg/s).
     double massFlowRate() {
         if (m_mdot == Undef) {
@@ -73,6 +57,8 @@
     /*!
      * @param in Upstream reactor.
      * @param out Downstream reactor.
+     * @deprecated To be removed after Cantera 3.2. Reactors should be provided to
+     *      constructor instead.
      */
     bool install(ReactorBase& in, ReactorBase& out);
 
@@ -133,9 +119,6 @@
     }
 
 protected:
-    string m_name;  //!< Flow device name.
-    bool m_defaultNameSet = false;  //!< `true` if default name has been previously set.
-
     double m_mdot = Undef;
 
     //! Function set by setPressureFunction; used by updateMassFlowRate

include/cantera/zeroD/FlowDeviceFactory.h

@@ -6,48 +6,9 @@
 #ifndef FLOWDEVICE_FACTORY_H
 #define FLOWDEVICE_FACTORY_H
 
-#include "cantera/base/FactoryBase.h"
-#include "cantera/zeroD/FlowDevice.h"
+#pragma message("warning: FlowDeviceFactory.h is deprecated and will be removed " \
+                "after Cantera 3.2. Use ConnectorFactory.h instead.")
 
-namespace Cantera
-{
-
-//! Factory class to create FlowDevice objects.
-//!
-//! This class is mainly used via the newFlowDevice() function, for example:
-//!
-//! ```cpp
-//!     shared_ptr<FlowDevice> mfc = newFlowDevice("MassFlowController");
-//! ```
-class FlowDeviceFactory : public Factory<FlowDevice, const string&>
-{
-public:
-    static FlowDeviceFactory* factory();
-
-    void deleteFactory() override;
-
-private:
-    static FlowDeviceFactory* s_factory;
-    static std::mutex flowDevice_mutex;
-    FlowDeviceFactory();
-};
-
-//! @defgroup flowDeviceGroup Flow Devices
-//! Flow device objects connect zero-dimensional reactors.
-//! FlowDevice objects should be instantiated via the newFlowDevice function, for
-//! example:
-//!
-//! ```cpp
-//!     shared_ptr<FlowDevice> mfc = newFlowDevice("MassFlowController", "my_mfc");
-//! ```
-//! @ingroup zerodGroup
-//! @{
-
-//! Create a FlowDevice object of the specified type
-//! @since Starting in %Cantera 3.1, this method returns a `shared_ptr<FlowDevice>`
-shared_ptr<FlowDevice> newFlowDevice(const string& model, const string& name="(none)");
-
-//! @}
-}
+#include "ConnectorFactory.h"
 
 #endif

include/cantera/zeroD/ReactorBase.h

@@ -80,6 +80,8 @@ class ReactorBase
     //! Set the Solution specifying the ReactorBase content.
     //! @param sol  Solution object to be set.
     //! @since New in %Cantera 3.1.
+    //! @deprecated  To be removed after %Cantera 3.2. Superseded by instantiation of
+    //!              ReactorBase with Solution object.
     void setSolution(shared_ptr<Solution> sol);
 
     //! @name Methods to set up a simulation

include/cantera/zeroD/ReactorSurface.h

@@ -16,7 +16,6 @@ class SurfPhase;
 
 //! A surface where reactions can occur that is in contact with the bulk fluid of a
 //! Reactor.
-//! @ingroup wallGroup
 class ReactorSurface
 {
 public: