Update: comments of all the functions #381

Databases/Functions/FullName2name.m

@@ -1,20 +1,28 @@
-function name = FullName2name(Species)
-
-name = Species;
-if isempty(name)
-    return
+function name = FullName2name(species)
+    % Get full name of the given species
+    %
+    % Args: 
+    %     species (str): Chemical species
+    %
+    % Return:
+    %     name (str): Full name of the given species
+
+    name = species;
+    if isempty(name)
+        return
+    end
+    if name(end)=='+'
+        name=[name(1:end-1) 'plus'];
+    elseif name(end)=='-'
+        name=[name(1:end-1) 'minus'];
+    end
+    ind=regexp(name,'[()]');
+    name(ind)='b';
+    ind=regexp(name,'[.,+-]');
+    name(ind)='_';
+    if regexp(name(1),'[0-9]')
+        name=['num_' name];
+    end
+    ind=regexp(name,'\x27');
+    name(ind)='_';
 end
-if name(end)=='+'
-    name=[name(1:end-1) 'plus'];
-elseif name(end)=='-'
-    name=[name(1:end-1) 'minus'];
-end
-ind=regexp(name,'[()]');
-name(ind)='b';
-ind=regexp(name,'[.,+-]');
-name(ind)='_';
-if regexp(name(1),'[0-9]')
-    name=['num_' name];
-end
-ind=regexp(name,'\x27');
-name(ind)='_';

Databases/Functions/compute_interval_NASA.m

@@ -1,6 +1,16 @@
 function tInterval = compute_interval_NASA(species, T, DB, tRange, ctTInt)
     % Compute interval NASA polynomials
-
+    %
+    %   Args:
+    %     species (str) : Chemical species
+    %     T (float): Temperature [K]
+    %     DB (struct) : Database with custom thermodynamic polynomials functions generated from NASAs 9 polynomials fits
+    %     tRange (cell): Ranges of temperatures [K]
+    %     ctTInt (float): Number of intervals of temperatures
+    %
+    % Returns:
+    %     tInterval (float): Index of the interval of temperatures
+
     tInterval = [];
     if DB.(species).ctTInt > 0
         for j = 1:ctTInt

Databases/Functions/detect_location_of_phase_specifier.m

@@ -1,24 +1,30 @@
-function n_open_parenthesis = detect_location_of_phase_specifier(Species) 
+function index_open_parenthesis = detect_location_of_phase_specifier(species) 
+    % Detect the location of the opening pharenthesis of the phase identifier (if any) 
+    %
+    % Args:
+    %     species (str): Chemical species
+    %
+    % Returns:
+    %     n_open_parenthesis (float): Index of the location of the open parenthesis
 
-% Detect the location of the opening pharentesis of the phase identifier (if any) 
-
-if ~isempty(find(Species(:)=='(', 1))                              % If the species name includes parenthesis
-    n_open_parenthesis = find(Species(:)=='(');                 % then detect the location of the open parenthesis
-    n_close_parenthesis = find(Species(:)==')');                %  and detect the location of the closing parenthesis
-    if n_close_parenthesis(end) == length(Species(:))           % If there is a closing parenthesis at the end of the species name, then it must be the closing parenthesis of the phase specifier
-        n_open_parenthesis = n_open_parenthesis(end);           % then the phase specifier begins with the last parenthesys
-    else                                                        % Some other times, the phase specifier is located before a short alphabetic name (e.g., 'C8H18(L),isooct') which is always preceeded by a comma 
-        n_comma = find(Species(:)==',');                        % Detect the location of the comma (if any)
-        if ~isempty(n_comma)                                    % If there is a comma (e.g., 'C8H18(L),isooct') then the last parenthesis may be the phase specifier as well, even though it is not located at the end of the species name
-            if (n_comma-n_close_parenthesis(end)) == 1          % however, this is only true if the last parenthesis is just followed by the comma
-                n_open_parenthesis = n_open_parenthesis(end);   % then the phase specifier begins also with the last parenthesys
+    if ~isempty(find(species(:)=='(', 1))                                 % If the species name includes parenthesis
+        index_open_parenthesis = find(species(:)=='(');                   % then detect the location of the open parenthesis
+        index_close_parenthesis = find(species(:)==')');                  % and detect the location of the closing parenthesis
+        if index_close_parenthesis(end) == length(species(:))             % If there is a closing parenthesis at the end of the species name, then it must be the closing parenthesis of the phase specifier
+            index_open_parenthesis = index_open_parenthesis(end);         % then the phase specifier begins with the last parenthesys
+        else                                                              % Some other times, the phase specifier is located before a short alphabetic name (e.g., 'C8H18(L),isooct') which is always preceeded by a comma 
+            index_comma = find(species(:)==',');                          % detect the location of the comma (if any)
+            if ~isempty(index_comma)                                      % If there is a comma (e.g., 'C8H18(L),isooct') then the last parenthesis may be the phase specifier as well, even though it is not located at the end of the species name
+                if (index_comma-index_close_parenthesis(end)) == 1        % However, this is only true if the last parenthesis is just followed by the comma
+                    index_open_parenthesis = index_open_parenthesis(end); % then the phase specifier begins also with the last parenthesys
+                else
+                    index_open_parenthesis = length(species)+1;           % Valid for species names w/o phase specifiers
+                end
             else
-                n_open_parenthesis = length(Species)+1;         % valid for species names w/o phase specifiers
+                index_open_parenthesis = length(species)+1;               % Valid for species names w/o phase specifiers
             end
-        else
-            n_open_parenthesis = length(Species)+1;             % valid for species names w/o phase specifiers
         end
+    else
+        index_open_parenthesis = length(species)+1;                       % Valid for species names w/o phase specifiers
     end
-else
-    n_open_parenthesis = length(Species)+1;                     % valid for species names w/o phase specifiers
 end

Databases/Functions/generate_DB.m

@@ -6,7 +6,7 @@
     %     DB_master (struct): Database with the thermodynamic data of the chemical species
     %
     % Returns:
-    %     DB: Database with custom thermodynamic polynomials functions generated from NASAs 9 polynomials fits
+    %     DB (struct): Database with custom thermodynamic polynomials functions generated from NASAs 9 polynomials fits
 
     if ~exist('DB', 'var')
         if exist('DB.mat', 'file')