updates in input parameter structures

BattMoTeam · Mar 15, 2022 · f7f2375 · f7f2375
1 parent b0db3a3
commit f7f2375
Show file tree

Hide file tree

Showing 6 changed files with 24 additions and 30 deletions.
diff --git a/Battery/BatteryInputParams.m b/Battery/BatteryInputParams.m
@@ -17,7 +17,7 @@
         ThermalModel      % instance of :class:`ThermalModelInputParams <Electrochemistry.ThermalModelInputParams>`
         Control           % instance of :class:`ControlModelInputParams <Electrochemistry.ControlModelInputParams>`    
 
-        %% Coupling terms (describe the topological structure of the coupling)
+        %% Coupling terms (describe the topological structure of the coupling between the components)
         couplingTerms
 
     end

diff --git a/Electrochemistry/ElectrolyteInputParams.m b/Electrochemistry/ElectrolyteInputParams.m
@@ -4,24 +4,25 @@
 %    
     properties
 
-        name
+        name % Given name (for convinience)
 
-        sp
-        compnames
+        compnames % Names of the components in the electrolyte
+        sp % Structure given properties of each component
 
+        %
+        % Input parameter for the separator (:class:`SeparatorInputParams
+        % <Electrochemistry.SeparatorInputParams>`)
+        %
         Separator
 
-        conductivityFactor
+        thermalConductivity % Intrinsic Thermal conductivity of the electrolyte
+        heatCapacity        % Intrinsic Heat capacity of the electrolyte
 
-        thermalConductivity
-        heatCapacity
 
-        electrolyteType
+        updateConductivityFunc              % Function handler to compute conductivity
+        updateDiffusionCoefficientFunc      % Function handler to compute diffusion coefficient
 
-        updateConductivityFunc
-        updateDiffusionCoefficientFunc
-
-        density % [kg m^-3] (Note : only of the liquid part, the density of the separator is given there)
+        density % Density [kg m^-3] (Note : only of the liquid part, the density of the separator is given there)
 
     end
 

diff --git a/Electrochemistry/InterfaceInputParams.m b/Electrochemistry/InterfaceInputParams.m
@@ -11,8 +11,8 @@
         theta0   % Lithiation value at 0% SOC [-]
         theta100 % Lithiation value at 100% SOC [-]
 
-        cmax
-        k0                      % [m^2.5 mol^-0.5 s^-1]
+        cmax                    % Maximum concentration [mol m^-3]
+        k0                      % Reference rate constant  [m^2.5 mol^-0.5 s^-1]
         Eak                     % Activation energy [J mol^-1]
         volumetricSurfaceArea   % Volumetric surface area [m2 m^-3]
         volumeFraction          % Volume fraction of the active material

diff --git a/Electrochemistry/Separator.m b/Electrochemistry/Separator.m
@@ -2,18 +2,15 @@
 
     properties
 
-        % Physicochemical properties
-        porosity       % Porosity,         [-]
-        rp             % Pore radius,      [m]
-        Gurley         % Gurley number,    [s]
-        volumeFraction % Volume fraction,  [-]
+        porosity            % Porosity [-]
+        volumeFraction      % Volume fraction [-]
 
         thermalConductivity % intrinsic thermal conductivity value
-        heatCapacity % intrinsic heat capacity value
+        heatCapacity        % intrinsic heat capacity value
 
         EffectiveThermalConductivity
         EffectiveHeatCapacity
-        density % [kg m^-3]        
+        density             % Density [kg m^-3]        
     end
 
     methods
@@ -28,8 +25,6 @@
 
             fdnames = {'G'                  , ...
                        'porosity'           , ...
-                       'rp'                 , ...
-                       'Gurley'             , ...
                        'thermalConductivity', ...
                        'heatCapacity'       , ...
                        'density'};

diff --git a/Electrochemistry/SeparatorInputParams.m b/Electrochemistry/SeparatorInputParams.m
@@ -4,14 +4,12 @@
 %    
     properties
 
-        porosity
-        rp
-        Gurley
+        porosity            % Porosity [-]
 
-        thermalConductivity
-        heatCapacity
+        thermalConductivity % Intrinsic Thermal conductivity of the electrolyte
+        heatCapacity        % Intrinsic Heat capacity of the electrolyte
 
-        density % [kg m^-3]
+        density             % Density [kg m^-3]
     end
 
     methods

diff --git a/Electrochemistry/SolidDiffusionModelInputParams.m b/Electrochemistry/SolidDiffusionModelInputParams.m
@@ -6,7 +6,7 @@
         D0                      % Diffusion reference constant[ m^2 s^-1]
         rp                      % Particle radius [m]
         volumetricSurfaceArea   % Volumetric surface area [m2 m^-3]
-        N                       % Discretization step for the diffusion model [-]
+        N                       % Number of discretization intervals in the diffusion model [-]
         np                      % Number of computational grid cells (typically set by parent model :class:`ActiveMaterial <Electrochemistry.ActiveMaterial>`)
         useSimplifiedDiffusionModel % Flag : true if we use simplified diffusion model