Skip to content

Commit 1bfbfe0

Browse files
Merge pull request #1102 from CombustionToolbox/develop
Update: documentation
2 parents a06cb0b + 17ffff2 commit 1bfbfe0

14 files changed

Lines changed: 47 additions & 43 deletions

File tree

+combustiontoolbox/+shockturbulence/@ShockTurbulenceModel/ShockTurbulenceModel.m

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
classdef (Abstract) ShockTurbulenceModel < handle
2-
% The :mat:class:`ShockTurbulenceModel` abstract class defines the interface
2+
% The :mat:func:`ShockTurbulenceModel` abstract class defines the interface
33
% for modeling turbulence amplification across a shock wave interacting with
44
% weak turbulence using linear interaction analysis. It serves as the base class
55
% for specific shock–turbulence interaction models.

+combustiontoolbox/+shockturbulence/@ShockTurbulenceModelAcoustic/ShockTurbulenceModelAcoustic.m

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
classdef ShockTurbulenceModelAcoustic < combustiontoolbox.shockturbulence.ShockTurbulenceModel
2-
% The :mat:class:`ShockTurbulenceModelAcoustic` class characterizes
2+
% The :mat:func:`ShockTurbulenceModelAcoustic` class characterizes
33
% turbulence amplification across a shock wave interacting with weak turbulence
44
% comprised of acoustic disturbances using linear theory.
55
%

+combustiontoolbox/+shockturbulence/@ShockTurbulenceModelCompressible/ShockTurbulenceModelCompressible.m

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
classdef ShockTurbulenceModelCompressible < combustiontoolbox.shockturbulence.ShockTurbulenceModel
2-
% The :mat:class:`ShockTurbulenceModelCompressible` class characterizes
2+
% The :mat:func:`ShockTurbulenceModelCompressible` class characterizes
33
% turbulence amplification across a shock wave interacting with weak turbulence
44
% comprised of vortical-entropic and acoustic disturbances using linear theory.
55
%

+combustiontoolbox/+shockturbulence/@ShockTurbulenceModelVortical/ShockTurbulenceModelVortical.m

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
classdef ShockTurbulenceModelVortical < combustiontoolbox.shockturbulence.ShockTurbulenceModel
2-
% The :mat:class:`ShockTurbulenceModelVortical` class characterizes
2+
% The :mat:func:`ShockTurbulenceModelVortical` class characterizes
33
% turbulence amplification across a shock wave interacting with weak turbulence
44
% comprised of vortical disturbances using linear theory.
55
%

+combustiontoolbox/+shockturbulence/@ShockTurbulenceModelVorticalEntropic/ShockTurbulenceModelVorticalEntropic.m

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
classdef ShockTurbulenceModelVorticalEntropic < combustiontoolbox.shockturbulence.ShockTurbulenceModel
2-
% The :mat:class:`ShockTurbulenceModelVorticalEntropic` class characterizes
2+
% The :mat:func:`ShockTurbulenceModelVorticalEntropic` class characterizes
33
% turbulence amplification across a shock wave interacting with weak turbulence
44
% comprised of vortical-entropic disturbances using linear theory.
55
%

+combustiontoolbox/+shockturbulence/@ShockTurbulenceSolver/ShockTurbulenceSolver.m

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
classdef ShockTurbulenceSolver < handle
2-
% The :mat:class:`ShockTurbulenceSolver` class characterizes turbulence
2+
% The :mat:func:`ShockTurbulenceSolver` class characterizes turbulence
33
% amplification across a shock wave interacting with weak turbulence using
44
% linear interaction analysis.
55
%

+combustiontoolbox/+utils/+display/@Canvas/Canvas.m

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
classdef (Abstract) Canvas < handle
2-
% The :mat:class:`Canvas` class is an abstract base class used to manage
2+
% The :mat:func:`Canvas` class is an abstract base class used to manage
33
% figure creation and plotting layout configuration in the :mat:pkg:`+display` module.
44
%
5-
% The :mat:class:`Canvas` class standardizes figure and axis formatting,
5+
% The :mat:func:`Canvas` class standardizes figure and axis formatting,
66
% provides tiled layout management, and offers utilities for axis selection and cycling.
77
%
8-
% A :mat:class:`Canvas` subclass can be initialized as follows: ::
8+
% A :mat:func:`Canvas` subclass can be initialized as follows: ::
99
%
1010
% config = combustiontoolbox.utils.display.PlotConfig();
1111
% fig = combustiontoolbox.utils.display.PlotFigure(config);
1212
%
13-
% See also: :mat:class:`PlotConfig`, :mat:class:`PlotFigure`, :mat:class:`PlotComposition`
13+
% See also: :mat:func:`PlotConfig`, :mat:func:`PlotFigure`, :mat:func:`PlotComposition`
1414

1515
properties
1616
ax matlab.graphics.axis.Axes % Axis handle

+combustiontoolbox/+utils/+display/@PlotComposition/PlotComposition.m

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
classdef PlotComposition < combustiontoolbox.utils.display.Canvas
2-
% The :mat:class:`PlotComposition` class extends :mat:class:`Canvas` to generate
2+
% The :mat:func:`PlotComposition` class extends :mat:func:`Canvas` to generate
33
% species composition plots (e.g., molar fractions `Xi`) against an independent variable.
44
%
5-
% A :mat:class:`PlotComposition` object can be initialized as follows: ::
5+
% A :mat:func:`PlotComposition` object can be initialized as follows: ::
66
%
77
% config = combustiontoolbox.utils.display.PlotConfig();
88
% fig = combustiontoolbox.utils.display.PlotComposition(config);
99
% fig.plot(mixtureArray, 'equivalenceRatio', 'Xi');
1010
%
1111
% This creates a formatted figure with species composition plotted over the selected parameter.
1212
%
13-
% See also: :mat:class:`Canvas`, :mat:class:`PlotFigure`, :mat:class:`PlotConfig`
13+
% See also: :mat:func:`Canvas`, :mat:func:`PlotFigure`, :mat:func:`PlotConfig`
1414

1515
properties (Access = private)
1616
FLAG_PLOT_VALIDATION = false; % Flag to indicate to plot validation data

+combustiontoolbox/+utils/+display/@PlotFigure/PlotFigure.m

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
classdef PlotFigure < combustiontoolbox.utils.display.Canvas
2-
% The :mat:class:`PlotFigure` class extends :mat:class:`Canvas` to provide a unified
2+
% The :mat:func:`PlotFigure` class extends :mat:func:`Canvas` to provide a unified
33
% plotting interface for thermodynamic and transport properties (e.g., `cp`, `h`, `Xi`)
44
% against an arbitrary independent variable.
55
%
6-
% A :mat:class:`PlotFigure` object can be initialized as follows: ::
6+
% A :mat:func:`PlotFigure` object can be initialized as follows: ::
77
%
88
% config = combustiontoolbox.utils.display.PlotConfig();
99
% fig = combustiontoolbox.utils.display.PlotFigure(config);
1010
% fig.plot('equivalenceRatio', mixArray, 'T', mixArray);
1111
%
12-
% This creates a formatted plot with consistent styling using :mat:class:`PlotConfig`.
12+
% This creates a formatted plot with consistent styling using :mat:func:`PlotConfig`.
1313
%
14-
% See also: :mat:class:`Canvas`, :mat:class:`PlotComposition`, :mat:class:`PlotConfig`
14+
% See also: :mat:func:`Canvas`, :mat:func:`PlotComposition`, :mat:func:`PlotConfig`
1515

1616
properties (Access = private)
1717
colorIndex = 1; % Index for color cycling

+combustiontoolbox/+utils/@Benchmark/Benchmark.m

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
% % Generate and display the report
2727
% bench.report();
2828
%
29-
% See also: :mat:func:`combustiontoolbox.utils.timeFunction`, :mat:func:`combustiontoolbox.utils.extensions.cpuinfo`
29+
% See also: :mat:func:`timeFunction`, :mat:func:`cpuinfo`
3030

3131

3232
properties

0 commit comments

Comments
 (0)