research/cantera
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

[Matlab] Deprecate npflame_init in favor of CounterFlowDiffusionFlame

Browse source
This commit is contained in:
Ray Speth 2017-06-09 18:53:39 -04:00
parent 43bd96b5ba
commit c092484f4d
1 changed files with 6 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
interfaces/matlab/toolbox/1D/npflame_init.m
View file

@ -1,6 +1,10 @@
function flame = npflame_init(gas, left, flow, right, fuel, oxidizer, nuox)
% NPFLAME_INIT Create a non-premixed flame stack.
% flame = npflame_init(gas, left, flow, right, fuel, oxidizer, nuox)
%
% This function is deprecated in favor of :mat:func:`CounterFlowDiffusionFlame`
% and will be removed after Cantera 2.4.
%
% :param gas:
% Object representing the gas, instance of class
% :mat:func:`Solution`, and an ideal gas. This object will be used
@ -29,6 +33,8 @@ function flame = npflame_init(gas, left, flow, right, fuel, oxidizer, nuox)
% inlet, flow, and right inlet.
%
warning('This function is deprecated and will be removed after Cantera 2.4. Use CounterFlowDiffusionFlame instead');
% Check input parameters
if nargin ~= 7
error('npflame_init expects seven input arguments.');