cantera/interfaces/matlab/toolbox/importPhase.m
EmilAtz 1e08d7499c Deprecation of MatLab importPhase function
Addition of comments in importPhase to warn for function deprecation.
2016-12-21 15:39:54 -05:00

22 lines
570 B
Matlab

function s = importPhase(file, name)
% IMPORTPHASE Import a phase from a CTI file
% s = importPhase(file, name)
% Deprecated. To be removed after Cantera 2.3.
% See :ref:`sec-phases`.
%
% See also: :mat:func:`Solution`
%
% :param file:
% CTI file containing phase definition
% :param name:
% Name of the phase
% :return:
% Instance of class :mat:func:`Solution`
%
warning('This function is deprecated and will be removed after Cantera 2.3. Use Solution instead');
if nargin == 1
s = Solution(file);
elseif nargin == 2
s = Solution(file, name);
end