2528df0f75
These changes make it unnecessary to copy header files around during the build process, which tends to confuse IDEs and debuggers. The headers which comprise Cantera's external C++ interface are now in the 'include' directory. All of the samples and demos are now in the 'samples' subdirectory.
70 lines
2.8 KiB
Matlab
70 lines
2.8 KiB
Matlab
function r = equilibrate(self, XY, err, maxsteps, maxiter, ...
|
|
loglevel)
|
|
%
|
|
% EQUILIBRATE - Set the mixture to a state of chemical equilibrium.
|
|
%
|
|
% This method uses a version of the VCS algorithm to find the
|
|
% composition that minimizes the total Gibbs free energy of the
|
|
% mixture, subject to element conservation constraints. For a
|
|
% description of the theory, see Smith and Missen, "Chemical
|
|
% Reaction Equilibrium." The VCS algorithm is implemented in
|
|
% Cantera kernel class MultiPhaseEquil.
|
|
%
|
|
% The VCS algorithm solves for the equilibrium composition for
|
|
% specified temperature and pressure. If any other property pair
|
|
% other than "TP" is specified, then an outer iteration loop is
|
|
% used to adjust T and/or P so that the specified property
|
|
% values are obtained.
|
|
%
|
|
% XY - Two-letter string specifying the two properties to hold
|
|
% fixed. Currently, 'TP', 'HP', and 'SP' are
|
|
% implemented. Default: 'TP'.
|
|
%
|
|
% err - Error tolerance. Iteration will continue until (Delta
|
|
% mu)/RT is less than this value for each reaction. Default:
|
|
% 1.0e-9. Note that this default is very conservative, and good
|
|
% equilibrium solutions may be obtained with larger error
|
|
% tolerances.
|
|
%
|
|
% maxsteps - Maximum number of steps to take while solving the
|
|
% equilibrium problem for specified T and P. Default: 1000.
|
|
%
|
|
% maxiter - Maximum number of temperature and/or pressure
|
|
% iterations. This is only relevant if a property pair other
|
|
% than (T,P) is specified. Default: 200.
|
|
%
|
|
% loglevel - Controls the amount of diagnostic output. If
|
|
% loglevel = 0, no diagnostic output is written. For values > 0,
|
|
% more detailed information is written to the log file as
|
|
% loglevel increases. The default is loglevel = 0.
|
|
%
|
|
% The logfile is written in HTML format, and may be viewed with
|
|
% any web browser. The default log file name is
|
|
% "equilibrium_log.html", but if this file exists, the log
|
|
% information will be written to "equilibrium_log{n}.html",
|
|
% where {n} is an integer chosen so that the log file does not
|
|
% already exist. Therefore, if 'equilibrate' is called multiple
|
|
% times, multiple log files will be written, with names
|
|
% "equilibrate_log.html", "equilibrate_log1.html",
|
|
% "equilibrate_log2.html", and so on. Existing log files will
|
|
% not be overwritten.
|
|
%
|
|
% >> equilibrate(mix, 'TP')
|
|
% >> equilibrate('TP', 1.0e-6, 500)
|
|
%
|
|
if nargin < 6
|
|
loglevel = 0;
|
|
end
|
|
if nargin < 5
|
|
maxiter = 200;
|
|
end
|
|
if nargin < 4
|
|
maxsteps = 1000;
|
|
end
|
|
if nargin < 3
|
|
err = 1.0e-9;
|
|
end
|
|
if nargin < 2
|
|
XY = 'TP';
|
|
end
|
|
r = mixturemethods(31, mix_hndl(self), XY, err, maxsteps, maxiter, loglevel);
|