Addressed reviewer comments including subclass definitions and docstr…

…ings.

interfaces/matlab_experimental/1D/AxisymmetricFlow.m

@@ -1,20 +1,31 @@
-function m = AxisymmetricFlow(gas, id)
+classdef AxisymmetricFlow < Domain1D
     % Create an axisymmetric flow domain.
+    %
     % m = AxisymmetricFlow(gas, id)
     %
     % :param gas:
-    %     Instance of class :mat:func:`Solution`
+    %     Instance of class :mat:class:`Solution`
     % :param id:
     %     String, ID of the flow
     % :return:
-    %     Domain1D instance representing an axisymmetric flow.
+    %     Instance of class :mat:class:`AxisymmetricFlow`.
     %
-    m = Domain1D('StagnationFlow', gas);
 
-    if nargin == 1
-        m.setID('flow');
-    else
-        m.setID(id);
+    methods
+
+        % Constructor
+        function m = AxisymmetricFlow(gas, id)
+
+            m = m@Domain1D('StagnationFlow', gas);
+
+            if nargin == 1
+                m.setID('flow');
+            else
+                m.setID(id);
+            end
+
+        end
+
     end
 
 end

interfaces/matlab_experimental/1D/CounterFlowDiffusionFlame.m

@@ -4,23 +4,23 @@
     %
     % :param left:
     %     Object representing the left inlet, which must be
-    %     created using function :mat:func:`Inlet`.
+    %     created using function :mat:class:`Inlet`.
     % :param flow:
     %     Object representing the flow, created with
-    %     function :mat:func:`AxisymmetricFlow`.
+    %     function :mat:class:`AxisymmetricFlow`.
     % :param right:
     %     Object representing the right inlet, which must be
-    %     created using function :mat:func:`Inlet`.
+    %     created using function :mat:class:`Inlet`.
     % :param tp_f:
     %     Object representing the fuel inlet gas, instance of class
-    %     :mat:func:`Solution`, and an ideal gas.
+    %     :mat:class:`Solution`, and an ideal gas.
     % :param tp_o:
     %     Object representing the oxidizer inlet gas, instance of class
-    %     :mat:func:`Solution`, and an ideal gas.
+    %     :mat:class:`Solution`, and an ideal gas.
     % :param oxidizer:
     %     String representing the oxidizer species. Most commonly O2.
     % :return:
-    %     Instance of :mat:func:`Sim1D` object representing the left
+    %     Instance of :mat:class:`Sim1D` object representing the left
     %     inlet, flow, and right inlet.
     %
 

interfaces/matlab_experimental/1D/Domain1D.m

@@ -15,8 +15,8 @@
     %    `OutletRes`
     %
     % :param b:
-    %     Instance of class :mat:func:`Solution` (for ``a == 1``)
-    %     or :mat:func:`Interface` (for ``a == 6``). Not used for
+    %     Instance of class :mat:class:`Solution` (for ``a == 1``)
+    %     or :mat:class:`Interface` (for ``a == 6``). Not used for
     %     all other valid values of ``a``.
     %
 
@@ -41,7 +41,7 @@
         % i = d.domainIndex
         %
         % :param d:
-        %     Instance of class :mat:func:`Domain1D`
+        %     Instance of class :mat:class:`Domain1D`
         % :return:
         %     Integer flag denoting the location of the domain,
         %     beginning with 1 at the left.
@@ -52,7 +52,7 @@
         % i = d.domainType
         %
         % :param d:
-        %     Instance of class :mat:func:`Domain1D`
+        %     Instance of class :mat:class:`Domain1D`
         % :return:
         %     Integer flag denoting the domain type.
         domainType
@@ -62,7 +62,7 @@
         % a = d.isFlow
         %
         % :param d:
-        %     Instance of class :mat:func:`Domain1D`
+        %     Instance of class :mat:class:`Domain1D`
         % :return:
         %     1 if the domain is a flow domain, and 0 otherwise.
         isFlow
@@ -72,7 +72,7 @@
         % a = d.isInlet
         %
         % :param d:
-        %     Instance of class :mat:func:`Domain1D`
+        %     Instance of class :mat:class:`Domain1D`
         % :return:
         %     1 if the domain is an inlet, and 0 otherwise.
         isInlet
@@ -82,7 +82,7 @@
         % a = d.isSurface
         %
         % :param d:
-        %     Instance of class :mat:func:`Domain1D`
+        %     Instance of class :mat:class:`Domain1D`
         % :return:
         %     1 if the domain is a surface, and 0 otherwise.
         isSurface
@@ -92,7 +92,7 @@
         % mdot = d.massFlux
         %
         % :param d:
-        %     Instance of class :mat:func:`Domain1D`
+        %     Instance of class :mat:class:`Domain1D`
         % :return:
         %     The mass flux in the domain.
         massFlux
@@ -102,7 +102,7 @@
         % n = d.nComponents
         %
         % :param d:
-        %     Instance of class :mat:func:`Domain1D`
+        %     Instance of class :mat:class:`Domain1D`
         % :return:
         %     Number of variables at each grid point
         nComponents
@@ -112,7 +112,7 @@
         % n = d.nPoints
         %
         % :param d:
-        %     Instance of class :mat:func:`Domain1D`
+        %     Instance of class :mat:class:`Domain1D`
         % :return:
         %     Integer number of grid points.
         nPoints
@@ -196,7 +196,7 @@ function delete(d)
             % d.disableEnergy
             %
             % :param d:
-            %     Instance of class :mat:func:`Domain1D`
+            %     Instance of class :mat:class:`Domain1D`
             %
             disp(' ');
             disp('Disabling the energy equation...');
@@ -209,7 +209,7 @@ function delete(d)
             % d.enableEnergy
             %
             % :param d:
-            %     Instance of class :mat:func:`Domain1D`
+            %     Instance of class :mat:class:`Domain1D`
             %
             disp(' ');
             disp('Enabling the energy equation...');
@@ -222,7 +222,7 @@ function delete(d)
             % d.disableSoret
             %
             % :param d:
-            %     Instance of class :mat:func:`Domain1D`
+            %     Instance of class :mat:class:`Domain1D`
             %
             disp(' ');
             disp('Disabling the Soret effect...');
@@ -235,7 +235,7 @@ function delete(d)
             % d.enableSoret
             %
             % :param d:
-            %     Instance of class :mat:func:`Domain1D`
+            %     Instance of class :mat:class:`Domain1D`
             %
             disp(' ');
             disp('Disabling the Soret effect...');
@@ -268,7 +268,7 @@ function delete(d)
             % n = d.componentIndex(name)
             %
             % :param d:
-            %     Instance of class :mat:func:`Domain1D`
+            %     Instance of class :mat:class:`Domain1D`
             % :param name:
             %     String name of the component to look up. If a numeric value
             %     is passed, it will be returned.
@@ -300,7 +300,7 @@ function delete(d)
             % n = d.componentName(index)
             %
             % :param d:
-            %     Instance of class :mat:func:`Domain1D`
+            %     Instance of class :mat:class:`Domain1D`
             % :param index:
             %     Integer or vector of integers of component names
             %     to get.
@@ -413,7 +413,7 @@ function delete(d)
             % to which the boundary domain is attached.
             %
             % :param d:
-            %     Instance of class :mat:func:`Domain1D`
+            %     Instance of class :mat:class:`Domain1D`
             % :param k:
             %     Integer species index
             % :return:
@@ -492,7 +492,7 @@ function setCoverageEqs(d, onoff)
             % d.setBounds(component, lower, upper)
             %
             % :param d:
-            %     Instance of class :mat:func:`Domain1D`
+            %     Instance of class :mat:class:`Domain1D`
             % :param component:
             %     String, component to set the bounds on
             % :param lower:
@@ -534,7 +534,7 @@ function setFixedTempProfile(d, profile)
             % columns.
             %
             % :param d:
-            %     Instance of class :mat:func:`Domain1D`
+            %     Instance of class :mat:class:`Domain1D`
             % :param profile:
             %     n x 2 or 2 x n array of ``n`` points at which the temperature
             %     is specified.
@@ -560,7 +560,7 @@ function setID(d, id)
             % d.setID(id)
             %
             % :param d:
-            %     Instance of class :mat:func:`Domain1D`
+            %     Instance of class :mat:class:`Domain1D`
             % :param id:
             %     String ID to assign
             %
@@ -573,7 +573,7 @@ function setMassFlowRate(d, mdot)
             % d.setMassFlowRate(mdot)
             %
             % :param d:
-            %     Instance of class :mat:func:`Domain1D`
+            %     Instance of class :mat:class:`Domain1D`
             % :param mdot:
             %     Mass flow rate
             %
@@ -586,7 +586,7 @@ function setMoleFractions(d, x)
             % d.setMoleFractions(x)
             %
             % :param d:
-            %     Instance of class :mat:func:`Domain1D`
+            %     Instance of class :mat:class:`Domain1D`
             % :param x:
             %     String specifying the species and mole fractions in
             %     the format ``'SPEC:X,SPEC2:X2'``.
@@ -600,7 +600,7 @@ function setSteadyTolerances(d, component, rtol, atol)
             % d.setSteadyTolerances(component, rtol, atol)
             %
             % :param d:
-            %     Instance of class :mat:func:`Domain1D`
+            %     Instance of class :mat:class:`Domain1D`
             % :param component:
             %     String or cell array of strings of component values
             %     whose tolerances should be set. If ``'default'`` is
@@ -641,7 +641,7 @@ function setTransientTolerances(d, component, rtol, atol)
             % d.setTransientTolerances(component, rtol, atol)
             %
             % :param d:
-            %     Instance of class :mat:func:`Domain1D`
+            %     Instance of class :mat:class:`Domain1D`
             % :param component:
             %     String or cell array of strings of component values
             %     whose tolerances should be set. If ``'default'`` is
@@ -694,7 +694,7 @@ function setupGrid(d, grid)
             % d.setupGrid(grid)
             %
             % :param d:
-            %     Instance of class :mat:func:`Domain1D`
+            %     Instance of class :mat:class:`Domain1D`
             % :param grid:
             %
             callct('domain_setupGrid', d.domainID, numel(grid), grid);

interfaces/matlab_experimental/1D/FreeFlame.m

@@ -1,21 +1,31 @@
-function m = FreeFlame(gas, id)
+classdef FreeFlame < Domain1D
     % Create a freely-propagating flat flame.
+    %
     % m = FreeFlame(gas, id)
     %
     % :param gas:
-    %     Instance of class :mat:func:`Solution`
+    %     Instance of class :mat:class:`Solution`
     % :param id:
     %     String, ID of the flow
     % :return:
-    %     Domain1D instance representing a freely propagating,
-    %     adiabatic flame
+    %     Instance of class :mat:class:`FreeFlame` representing
+    %     a freely propagating, adiabatic flame.
     %
-    m = Domain1D('StagnationFlow', gas, 2);
+    methods
+
+        % Constructor
+        function m = FreeFlame(gas, id)
+
+            m = m@Domain1D('StagnationFlow', gas, 2);
+
+            if nargin == 1
+                m.setID('flame');
+            else
+                m.setID(id);
+            end
+
+        end
 
-    if nargin == 1
-        m.setID('flame');
-    else
-        m.setID(id);
     end
 
 end

interfaces/matlab_experimental/1D/Inlet.m

@@ -1,20 +1,32 @@
-function m = Inlet(id)
+classdef Inlet < Domain1D
     % Create an inlet domain.
+    %
     % m = Inlet(id)
+    %
     % Note that an inlet can only be a terminal domain - it must be
     % either the leftmost or rightmost domain in a stack.
     %
     % :param id:
     %     String name of the inlet.
     % :return:
-    %     Instance of class :mat:func:`Domain1D` representing an inlet.
+    %     Instance of class :mat:class:`Inlet`.
     %
-    m = Domain1D('Inlet1D');
 
-    if nargin == 0
-        m.setID('inlet');
-    else
-        m.setID(id);
+    methods
+
+        % Constructor
+        function m = Inlet(id)
+
+            m = m@Domain1D('Inlet1D');
+
+            if nargin == 0
+                m.setID('inlet');
+            else
+                m.setID(id);
+            end
+
+        end
+
     end
 
 end