runBenchs.m

Go to the documentation of this file.

function runBenchs(varargin)
% function runBenchs(varargin)
%   Run benchs for Mass (#benchMassP1), MassW (#benchMassWP1)
%   Stiff (#benchStiffP1) and StiffElas (#benchStiffElasP1) matrices.
%   For each assembly matrices, we compare cputimes of corresponding functions 
%   for version 'base', 'OptV0', 'OptV1' and 'OptV2'.
%
% Optional parameters:
%   - 'save' : true for saving each bench in latex files. (default false)
%   - 'directory' : name of the directory for saving `\LaTeX{}` files.
%   - 'name' : base name of `\LaTeX{}` files.
%   - 'LN' : List of N parameters for #SquareMesh function.
%
% Example:
%  @verbatim
%     runBenchs('save',true,'name','benchMatlabR2012b','LN',20:20:160)@endverbatim
% 
% Results under Matlab R2012b:
%   Here are the results on our reference machine .
%   - functions <b>MassAssemblingP1</b>
%    ``\mbox{\input{\INPUTLATEXDIR/benchMatlabR2012b_MassP1.tex}} ``
%   - functions <b>MassWAssemblingP1</b>
%    ``\mbox{\input{\INPUTLATEXDIR/benchMatlabR2012b_MassWP1.tex}} ``
%   - functions <b>StiffAssemblingP1</b>
%    ``\mbox{\input{\INPUTLATEXDIR/benchMatlabR2012b_StiffP1.tex}} ``
%   - functions <b>StiffElasAssembling</b>
%    ``\mbox{\input{\INPUTLATEXDIR/benchMatlabR2012b_StiffElasP1.tex}} ``
%
% % Results under Octave 3.6.3:
%   Here are the results on our reference machine .
%   - functions <b>MassAssemblingP1</b>
%    ``\mbox{\input{\INPUTLATEXDIR/benchOctave3.6.3_MassP1.tex}} ``
%   - functions <b>MassWAssemblingP1</b>
%    ``\mbox{\input{\INPUTLATEXDIR/benchOctave3.6.3_MassWP1.tex}} ``
%   - functions <b>StiffAssemblingP1</b>
%    ``\mbox{\input{\INPUTLATEXDIR/benchOctave3.6.3_StiffP1.tex}} ``
%   - functions <b>StiffElasAssembling</b>
%    ``\mbox{\input{\INPUTLATEXDIR/benchOctave3.6.3_StiffElasP1.tex}} ``
%  
%
% See also:
%   #benchMassP1, #benchMassWP1, #benchStiffP1, #benchStiffElasP1, #InitOptFEM2D
%
% OptFEM2DP1 [V1.2b1] -    Copyright (C) 2013  CJS (LAGA)
%
%   This file is part of OptFEM2DP1.
%   OptFEM2DP1 is free software: you can redistribute it and/or modify
%   it under the terms of the GNU General Public License as published by
%   the Free Software Foundation, either version 3 of the License, or
%   (at your option) any later version.
%
%   OptFEM2DP1 is distributed in the hope that it will be useful,
%   but WITHOUT ANY WARRANTY; without even the implied warranty of
%   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
%   GNU General Public License for more details.
%
%   You should have received a copy of the GNU General Public License
%   along with this program.  If not, see <http://www.gnu.org/licenses/>.
close all

InitOptFEM2D();

p = inputParser;
  
if isOctave()
  p=p.addParamValue('save', false, @islogical );
  p=p.addParamValue('directory', 'latex' , @ischar );
  p=p.addParamValue('name', 'bench' , @ischar );
  p=p.addParamValue('LN', [20:20:100] , @isnumeric );
  p=p.parse(varargin{:});
else % Matlab
  p.addParamValue('save', false, @islogical );
  p.addParamValue('directory', 'latex' , @ischar );
  p.addParamValue('name', 'bench' , @ischar );
  p.addParamValue('LN', [20:20:100], @isnumeric );
  p.parse(varargin{:});
end
LN=p.Results.LN;
if p.Results.save
  [succes,message,messageid] = mkdir(p.Results.directory);
  if (~succes)
    error(message)
  end  
end
BenchMassP1=benchMassP1('LN',LN);
if p.Results.save
  % Build LaTeX tabular
  BenchToLatexTabular(BenchMassP1,[p.Results.directory,filesep,p.Results.name,'_MassP1.tex']);
end

BenchMassWP1=benchMassWP1('LN',LN);
if p.Results.save
  % Build LaTeX tabular
  BenchToLatexTabular(BenchMassWP1,[p.Results.directory,filesep,p.Results.name,'_MassWP1.tex']);
end

BenchStiffP1=benchStiffP1('LN',LN);
if p.Results.save
  % Build LaTeX tabular
  BenchToLatexTabular(BenchStiffP1,[p.Results.directory,filesep,p.Results.name,'_StiffP1.tex']);
end

BenchStiffElasP1=benchStiffElasP1('LN',LN);
if p.Results.save
  % Build LaTeX tabular
  BenchToLatexTabular(BenchStiffElasP1,[p.Results.directory,filesep,p.Results.name,'_StiffElasP1.tex']);
end
end

function BenchToLatexTabular(bench,LaTeXFilename)
  T=bench.T;
  Data=[bench.Ldof',T(:,1),T(:,1)./T(:,1),T(:,2),T(:,1)./T(:,2),T(:,3),T(:,1)./T(:,3),T(:,4),T(:,1)./T(:,4)];
  Header={'$n_{dof}$', 'base', 'OptV0', 'OptV1', 'OptV2'};
  DataFormat={'$%d$','\\begin{tabular}{c} %.3f (s)\\\\ \\texttt{x %.2f} \\end{tabular}', ...
                     '\\begin{tabular}{c} %.3f (s)\\\\ \\texttt{x %.2f} \\end{tabular}', ...
                     '\\begin{tabular}{c} %.3f (s)\\\\ \\texttt{x %.2f} \\end{tabular}', ...
                     '\\begin{tabular}{c} %.3f (s)\\\\ \\texttt{x %.2f} \\end{tabular}'};
  ColumnFormat= '|r||*{4}{c|}';
  RowFormat='\hline';
  RowHeaderFormat='\hline \hline';
  PrintDataInLatexTabular(Data,Header,DataFormat,ColumnFormat,RowFormat,RowHeaderFormat,LaTeXFilename)

end