Changeset 3022 for issm/trunk/src/m/classes/public/bamg.m

Timestamp:

02/11/10 15:28:10 (16 years ago)

Author:

Mathieu Morlighem

Message:

Added some doc and some checks

File:

• issm/trunk/src/m/classes/public/bamg.m (modified) (2 diffs)

issm/trunk/src/m/classes/public/bamg.m

@@ -2 +2 @@
 %BAMG - mesh generation
 %
-%   Usage:
-%      md=bamg(md,varargin);
+%   Available options (for more details see ISSM website http://issm.jpl.nasa.gov/):
+%
+%   - domain : followed by an ARGUS file that prescribes the domain outline (rifts and holes)
+%   - hmin   : minimum edge length (default is 10^-100)
+%   - hmax   : maximum esge length (default is 10^100)
+%   - hVertices : imposed edge length for each vertex (geometry or mesh)
+%
+%   - anisomax    : maximum ration between the smallest and largest edges (default is 10^30)
+%   - coef        : coefficient applied to the metric (2-> twice as many elements, default is 1)
+%   - cutoff      : scalar used to compute the metric when metric type 2 or 3 are applied
+%   - err         : error used to generate the metric from a field
+%   - errg        : geometrical error (default is 0.1)
+%   - field       : field of the model that will be used to compute the metric
+%                   to apply several fields, use one column per field
+%   - gradation   : maximum ration between two adjacent edges
+%   - Hessiantype : 0 -> use double P2 projection (default)
+%                   1 -> use Green formula
+%   - KeepVertices: try to keep initial vertices when adaptation is done on an existing mesh (default 1)
+%   - MaximalAngleOfCorner: maximal angle of corners in degree (default is 10)
+%   - maxnbv      : maximum number of vertices used to allocate memory (default is 10^6)
+%   - maxsubdiv   : maximum subdivision of exisiting elements (default is 10)
+%   - metric      : matrix (numberofgrids x 3) used as a metric
+%   - Metrictype  : 1 -> absolute error          c/(err coeff^2) * Abs(H)        (default)
+%                   2 -> relative error          c/(err coeff^2) * Abs(H)/max(s,cutoff*max(s))
+%                   3 -> rescaled absolute error c/(err coeff^2) * Abs(H)/(smax-smin)
+%   - nbjacoby    : correction used by Hessiantype=1 (default is 1)
+%   - NbSmooth    : number of metric smoothing procedure (default is 3)
+%   - omega       : relaxation parameter of the smoothing procedure (default is 1.8)
+%   - power       : power applied to the metric (default is 1)
+%   - renumber    : 0 -> no renumbering
+%                   1 -> renumber by distance to lower left corner (default)
+%                   2 -> random renumbering
+%   - splitcorner : split triangles whuch have 3 vertices on the outline (default is 1)
+%   - verbose     : level of verbosity (default is 1)
+%
+%   Examples:
+%      md=bamg(md,'domain','DomainOutline.exp','hmax',3000);
+%      md=bamg(md,'field',[md.vel_obs md.thickness],'hmax',20000,'hmin',1000);
+%      md=bamg(md,'metric',A,'hmin',1000,'hmax',20000,'gradation',3,'anisomax',1);
 
 %process options
@@ -104 +141 @@
 
 % Bamg Options {{{1
+bamg_options.anisomax=getfieldvalue(options,'anisomax',10^30);
+bamg_options.coef=getfieldvalue(options,'coef',1);
+bamg_options.cutoff=getfieldvalue(options,'cutoff',10^-5);
 bamg_options.err=getfieldvalue(options,'err',0.01);
 bamg_options.errg=getfieldvalue(options,'errg',0.1);
-bamg_options.coef=getfieldvalue(options,'coef',1);
+bamg_options.field=getfieldvalue(options,'field',[]);
+bamg_options.gradation=getfieldvalue(options,'gradation',1.5);
+bamg_options.Hessiantype=getfieldvalue(options,'Hessiantype',0);
+bamg_options.hmin=getfieldvalue(options,'hmin',10^-100);
+bamg_options.hmax=getfieldvalue(options,'hmax',10^100);
+bamg_options.KeepVertices=getfieldvalue(options,'KeepVertices',1);
+bamg_options.MaximalAngleOfCorner=getfieldvalue(options,'MaximalAngleOfCorner',10);
+bamg_options.maxnbv=getfieldvalue(options,'maxnbv',10^6);
 bamg_options.maxsubdiv=getfieldvalue(options,'maxsubdiv',10);
-bamg_options.power=getfieldvalue(options,'power',1);
+bamg_options.metric=getfieldvalue(options,'metric',[]);
+bamg_options.Metrictype=getfieldvalue(options,'Metrictype',0);
 bamg_options.nbjacobi=getfieldvalue(options,'nbjacobi',1);
-bamg_options.Hessiantype=getfieldvalue(options,'Hessiantype',0);
-bamg_options.Metrictype=getfieldvalue(options,'Metrictype',0);
-bamg_options.KeepVertices=getfieldvalue(options,'KeepVertices',1);
 bamg_options.NbSmooth=getfieldvalue(options,'NbSmooth',3);
 bamg_options.omega=getfieldvalue(options,'omega',1.8);
-bamg_options.maxnbv=getfieldvalue(options,'maxnbv',10^6);
-bamg_options.MaximalAngleOfCorner=getfieldvalue(options,'MaximalAngleOfCorner',10);
-bamg_options.hmin=getfieldvalue(options,'hmin',10^-100);
-bamg_options.hmax=getfieldvalue(options,'hmax',10^100);
-bamg_options.anisomax=getfieldvalue(options,'anisomax',10^30);
-bamg_options.gradation=getfieldvalue(options,'gradation',1.5);
-bamg_options.cutoff=getfieldvalue(options,'cutoff',10^-5);
+bamg_options.power=getfieldvalue(options,'power',1);
+bamg_options.renumber=getfieldvalue(options,'renumber',1);
+bamg_options.splitcorners=getfieldvalue(options,'splitcorners',1);
 bamg_options.verbose=getfieldvalue(options,'verbose',1);
-bamg_options.splitcorners=getfieldvalue(options,'splitcorners',1);
-bamg_options.metric=getfieldvalue(options,'metric',[]);
-bamg_options.field=getfieldvalue(options,'field',[]);
 %}}}