mirror of
https://github.com/Cantera/cantera.git
synced 2026-08-19 01:14:44 -05:00
[MATLAB] Fix docstrings of classes declared abstract
This commit is contained in:
@@ -1,7 +1,8 @@
|
||||
classdef (Abstract) Boundary < ct.oneD.Domain
|
||||
% Create a Boundary domain. ::
|
||||
% Boundary Class.
|
||||
%
|
||||
% >> m = ct.oneD.Boundary(type, phase, name)
|
||||
% Base class for objects representing domain boundaries. The constructor is called
|
||||
% by derived classes and cannot be used directly.
|
||||
%
|
||||
% :param type:
|
||||
% String type of Boundary. Possible values are:
|
||||
|
||||
@@ -1,7 +1,8 @@
|
||||
classdef (Abstract) Domain < handle
|
||||
% Domain Class ::
|
||||
% Domain Class.
|
||||
%
|
||||
% >> d = ct.oneD.Domain(type, phase, id)
|
||||
% Base class for objects representing boundaries and flow domains. The constructor
|
||||
% is called by derived classes and cannot be used directly.
|
||||
%
|
||||
% :param type:
|
||||
% String type of domain. Possible values are:
|
||||
|
||||
@@ -1,7 +1,8 @@
|
||||
classdef (Abstract) Flow < ct.oneD.Domain
|
||||
% Create a Flow domain. ::
|
||||
% Flow Class.
|
||||
%
|
||||
% >> m = ct.oneD.Flow(type, phase, name)
|
||||
% Base class for objects representing flow domains. The constructor is called
|
||||
% by derived classes and cannot be used directly.
|
||||
%
|
||||
% :param type:
|
||||
% String type of domain. Possible values are:
|
||||
|
||||
@@ -1,9 +1,8 @@
|
||||
classdef (Abstract) Connector < handle
|
||||
% Connector Class ::
|
||||
% Connector Class.
|
||||
%
|
||||
% >> c = ct.zeroD.Connector(typ, r1, r2, name)
|
||||
%
|
||||
% Base class for walls and flow devices.
|
||||
% Base class for walls and flow devices. The constructor is called
|
||||
% by derived classes and cannot be used directly.
|
||||
%
|
||||
% See also: :mat:class:`ct.zeroD.FlowDevice`, :mat:class:`ct.zeroD.Wall`
|
||||
%
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
classdef (Abstract) FlowDevice < ct.zeroD.Connector
|
||||
% FlowDevice Class ::
|
||||
% FlowDevice Class.
|
||||
%
|
||||
% >> x = ct.zeroD.FlowDevice(typ, name)
|
||||
% Base class for devices that allow flow between reactors. The constructor is called
|
||||
% by derived classes and cannot be used directly.
|
||||
%
|
||||
% Base class for devices that allow flow between reactors.
|
||||
% :mat:class:`ct.zeroD.FlowDevice` objects are assumed to be adiabatic,
|
||||
% non-reactive, and have negligible internal volume, so that they are
|
||||
% internally always in steady-state even if the upstream and downstream
|
||||
|
||||
@@ -1,4 +1,8 @@
|
||||
classdef (Abstract) ReactorBase < handle
|
||||
% ReactorBase Class.
|
||||
%
|
||||
% Base class for objects representing reactors. The constructor is called
|
||||
% by derived classes and cannot be used directly.
|
||||
|
||||
properties (SetAccess = immutable)
|
||||
|
||||
|
||||
@@ -1,11 +1,9 @@
|
||||
classdef (Abstract) Kinetics < handle
|
||||
% Kinetics Class ::
|
||||
% Kinetics Class.
|
||||
%
|
||||
% >> k = ct.Kinetics(id)
|
||||
%
|
||||
% Retrieve instance of class :mat:class:`ct.Kinetics` associated with a
|
||||
% Instance of class :mat:class:`ct.Kinetics` associated with a
|
||||
% :mat:class:`ct.Solution` object. The constructor is called whenever a new
|
||||
% :mat:class:`ct.Solution` is instantiated and should not be used directly.
|
||||
% :mat:class:`ct.Solution` is instantiated and cannot be used directly.
|
||||
%
|
||||
% Class :mat:class:`ct.Kinetics` represents kinetics managers, which manage
|
||||
% reaction mechanisms. The reaction mechanism attributes are specified in a
|
||||
|
||||
@@ -1,11 +1,9 @@
|
||||
classdef (Abstract) ThermoPhase < handle
|
||||
% ThermoPhase Class ::
|
||||
% ThermoPhase Class.
|
||||
%
|
||||
% >> t = ct.ThermoPhase(id)
|
||||
%
|
||||
% Retrieve instance of class :mat:class:`ct.ThermoPhase` associated with a
|
||||
% Instance of class :mat:class:`ct.ThermoPhase` associated with a
|
||||
% :mat:class:`ct.Solution` object. The constructor is called whenever a new
|
||||
% :mat:class:`ct.Solution` is instantiated and should not be used directly.
|
||||
% :mat:class:`ct.Solution` is instantiated and cannot be used directly.
|
||||
%
|
||||
% :param id:
|
||||
% Integer ID of the solution holding the :mat:class:`ct.ThermoPhase` object.
|
||||
|
||||
@@ -1,11 +1,9 @@
|
||||
classdef (Abstract) Transport < handle
|
||||
% Transport Class ::
|
||||
% Transport Class.
|
||||
%
|
||||
% >> tr = ct.Transport(id)
|
||||
%
|
||||
% Retrieve instance of class :mat:class:`ct.Transport` associated with a
|
||||
% Instance of class :mat:class:`ct.Transport` associated with a
|
||||
% :mat:class:`ct.Solution` object. The constructor is called whenever a new
|
||||
% :mat:class:`ct.Solution` is instantiated and should not be used directly.
|
||||
% :mat:class:`ct.Solution` is instantiated and cannot be used directly.
|
||||
%
|
||||
% :param id:
|
||||
% Integer ID of the solution holding the :mat:class:`ct.Transport` object.
|
||||
|
||||
Reference in New Issue
Block a user