displaycontrol

PURPOSE ^

DISPLAYCONTROL - display control parameters

SYNOPSIS ^

function displaycontrol(md)

DESCRIPTION ^

DISPLAYCONTROL - display control parameters

   To avoid clobbering display.m with every field from model md, 
   we create this routine that displays control parameters from model md, 
   only if requested.

   Usage:
      displaycontrol(md)

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SOURCE CODE ^

0001 function displaycontrol(md)
0002 %DISPLAYCONTROL - display control parameters
0003 %
0004 %   To avoid clobbering display.m with every field from model md,
0005 %   we create this routine that displays control parameters from model md,
0006 %   only if requested.
0007 %
0008 %   Usage:
0009 %      displaycontrol(md)
0010 
0011 disp(sprintf('      ''%s''','control'));
0012 %control type
0013 control_string='';
0014 for i=1:length(md.control_type),
0015     parameter=md.control_type{i};
0016     %check this parameter is a field from model!
0017     if ~isfield(struct(md),parameter),
0018         error('displaysolutionparameters error message: one of the control type parameters does not exist!');
0019     end
0020     control_string=[control_string parameter ' and '];
0021 end
0022 control_string=control_string(1:length(control_string)-5);
0023 disp(sprintf('         control_type: %s %s',control_string,'(list of parameters where inverse control is carried out; ex: {''drag''}, or {''drag'',''B''})'));
0024 disp(sprintf('         fit: (%i)      (''absolute: 0'', ''relative: 1'', or ''logarithmic: 2''. default is ''absolute: 0'', for each optimization steps)',length(md.fit)));
0025 disp(sprintf('         meanvel: %g      (velocity scaling factor when evaluating relative or logarithmic misfit)',md.meanvel));
0026 disp(sprintf('         epsvel: %g      ( for relative fit, avoids misfit becoming infinity, for logarithmic fit, threshold for velocity)',md.epsvel));
0027 disp(sprintf('         nsteps: %i      (number of optimization searches)',md.nsteps));
0028 disp(sprintf('         optscal: (%i %i)      (scaling factor on gradient direction during optimization, for each optimization step)',size(md.optscal,1),size(md.optscal,2)));
0029 disp(sprintf('         mincontrolconstraint: %g      (minimum contraint for the controlled parameters)',md.mincontrolconstraint));
0030 disp(sprintf('         maxcontrolconstraint: %g      (maximum contraint for the controlled parameters)',md.maxcontrolconstraint));
0031 disp(sprintf('         maxiter: (%i)      (maximum iterations during each optimization step)',length(md.maxiter)));
0032 disp(sprintf('         tolx: %f      (minimum tolerance which will stop one optimization search)',md.tolx));
0033 disp(sprintf('         plot: %i      (visualization of the results of each iteration yes -> 1 no -> 0. Default is 1)',md.plot));

Generated on Sun 29-Mar-2009 20:22:55 by m2html © 2003