Changed doctree and docstrings after OneDim change

interfaces/matlab_experimental/Base/Interface.m

@@ -19,8 +19,8 @@ classdef Interface < handle & ThermoPhase & Kinetics
     %     Instance of class :mat:class:`Interface`.
 
     properties (SetAccess = immutable)
-        phaseID
-        interfaceName
+        phaseID % ID of the interface.
+        interfaceName % Name of the interface.
     end
 
     properties (SetAccess = public)

interfaces/matlab_experimental/Base/Solution.m

@@ -49,8 +49,8 @@ classdef Solution < handle & ThermoPhase & Kinetics & Transport
     %     Instance of class :mat:class:`Solution`.
 
     properties (SetAccess = immutable)
-        phaseID
-        solnName
+        phaseID % ID of the solution.
+        solnName % Name of the solution.
     end
 
     methods

interfaces/matlab_experimental/OneDim/Boundary1D.m

@@ -1,10 +1,18 @@
 classdef Boundary1D < Domain1D
     % Create a Boundary domain. ::
     %
-    %     >> m = Boundary(phase, id)
+    %     >> m = Boundary(type, phase, id)
     %
+    % :param type:
+    %    String type of Boundary. Possible values are:
+    %      - `inlet`
+    %      - `outlet`
+    %      - `reacting-surface`
+    %      - `surface`
+    %      - `symmetry-plane`
+    %      - `outlet-reservoir`
     % :param phase:
-    %     Instance of class :mat:class:`Solution`.
+    %     Instance of class :mat:class:`Solution` or :mat:class:`Interface`.
     % :param id:
     %     String, ID of the flow.
     % :return:

interfaces/matlab_experimental/OneDim/Domain1D.m

@@ -1,23 +1,24 @@
 classdef Domain1D < handle
     % Domain1D Class ::
     %
-    %     >> d = Domain1D(a, b)
+    %     >> d = Domain1D(type, phase, id)
     %
-    % :param a:
+    % :param type:
     %    String type of domain. Possible values are:
-    %      - `StagnationFlow`
-    %      - `AxisymmetricFlow`
-    %      - `Inlet1D`
-    %      - `Surf1D`
-    %      - `Symm1D`
-    %      - `Outlet1D`
-    %      - `ReactingSurface`
-    %      - `OutletRes`
-    % :param b:
-    %     Instance of :mat:class:`Solution` (for ``a == 'StagnationFlow`` or
-    %     ``a = 'AxisymmetricFlow'``) or :mat:class:`Interface`
-    %     (for ``a == 'ReactingSurface'``).
-    %     Not used for all other valid values of ``a``.
+    %      - `axisymmetric-flow`
+    %      - `free-flow`
+    %      - `inlet`
+    %      - `outlet`
+    %      - `reacting-surface`
+    %      - `surface`
+    %      - `symmetry-plane`
+    %      - `outlet-reservoir`
+    % :param phase:
+    %     Instance of :mat:class:`Solution` or :mat:class:`Interface`.
+    % :param id:
+    %     String ID of the domain.
+    % :return:
+    %     Instance of class :mat:class:`Domain1D`
 
     properties (SetAccess = immutable)
 

interfaces/matlab_experimental/OneDim/Flow1D.m

@@ -1,8 +1,12 @@
 classdef Flow1D < Domain1D
     % Create a Flow domain. ::
     %
-    %     >> m = Flow1D(phase, id)
+    %     >> m = Flow1D(type, phase, id)
     %
+    % :param type:
+    %    String type of domain. Possible values are:
+    %      - `axisymmetric-flow`
+    %      - `free-flow`
     % :param phase:
     %     Instance of class :mat:class:`Solution`.
     % :param id:

interfaces/matlab_experimental/OneDim/Inlet.m

@@ -1,7 +1,7 @@
 classdef Inlet < Boundary1D
     % Create an inlet domain. ::
     %
-    %     >> m = Inlet(id)
+    %     >> m = Inlet(phase, id)
     %
     % Note that an inlet can only be a terminal domain - it must be
     % either the leftmost or rightmost domain in a stack.

interfaces/matlab_experimental/OneDim/Outlet.m

@@ -1,7 +1,7 @@
 classdef Outlet < Boundary1D
     % Create an outlet domain. ::
     %
-    %     >> m = Outlet(id)
+    %     >> m = Outlet(phase, id)
     %
     % :param phase:
     %     Instance of class :mat:class:`Solution`.

interfaces/matlab_experimental/OneDim/OutletRes.m

@@ -1,7 +1,7 @@
 classdef OutletRes < Boundary1D
     % Create an outlet reservoir domain. ::
     %
-    %     >> m = OutletRes(id)
+    %     >> m = OutletRes(phase, id)
     %
     % :param phase:
     %     Instance of class :mat:class:`Solution`.

interfaces/matlab_experimental/OneDim/ReactingSurface.m

@@ -1,7 +1,7 @@
 classdef ReactingSurface < Boundary1D
     % Create a reacting surface domain. ::
     %
-    %     >> m = Surface(surface_mech, id)
+    %     >> m = ReactingSurface(surface_mech, id)
     %
     % :param surface_mech:
     %     Instance of class :mat:class:`Interface` defining

interfaces/matlab_experimental/OneDim/Surface.m

@@ -1,7 +1,7 @@
 classdef Surface < Bondary1D
     % Create a surface domain. ::
     %
-    %     >> m = Surface(id)
+    %     >> m = Surface(phase, id)
     %
     % :param phase:
     %     Instance of class :mat:class:`Solution`.

interfaces/matlab_experimental/OneDim/SymmPlane.m

@@ -1,7 +1,7 @@
 classdef SymmPlane < Boundary1D
     % Create a symmetry plane domain. ::
     %
-    %     >> m = SymmPlane(id)
+    %     >> m = SymmPlane(phase, id)
     %
     % :param phase:
     %     Instance of class :mat:class:`Solution`.