annotate inst/ufl.m @ 226:043120f071de

Correct help message for ufl
author Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
date Fri, 23 May 2014 11:41:17 +0200
parents 72af6354bf02
children 8db0b8583615
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
220
9adf76893ce4 Added ufl.m
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents:
diff changeset
1 ## Copyright (C) 2014 Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
9adf76893ce4 Added ufl.m
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents:
diff changeset
2 ##
9adf76893ce4 Added ufl.m
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents:
diff changeset
3 ## This program is free software; you can redistribute it and/or modify it under
9adf76893ce4 Added ufl.m
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents:
diff changeset
4 ## the terms of the GNU General Public License as published by the Free Software
9adf76893ce4 Added ufl.m
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents:
diff changeset
5 ## Foundation; either version 3 of the License, or (at your option) any later
9adf76893ce4 Added ufl.m
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents:
diff changeset
6 ## version.
9adf76893ce4 Added ufl.m
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents:
diff changeset
7 ##
9adf76893ce4 Added ufl.m
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents:
diff changeset
8 ## This program is distributed in the hope that it will be useful, but WITHOUT
9adf76893ce4 Added ufl.m
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents:
diff changeset
9 ## ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
9adf76893ce4 Added ufl.m
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents:
diff changeset
10 ## FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
9adf76893ce4 Added ufl.m
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents:
diff changeset
11 ## details.
9adf76893ce4 Added ufl.m
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents:
diff changeset
12 ##
9adf76893ce4 Added ufl.m
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents:
diff changeset
13 ## You should have received a copy of the GNU General Public License along with
9adf76893ce4 Added ufl.m
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents:
diff changeset
14 ## this program; if not, see <http://www.gnu.org/licenses/>.
9adf76893ce4 Added ufl.m
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents:
diff changeset
15
9adf76893ce4 Added ufl.m
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents:
diff changeset
16 ## -*- texinfo -*-
9adf76893ce4 Added ufl.m
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents:
diff changeset
17 ## @deftypefn {Function File} ufl [command] line
9adf76893ce4 Added ufl.m
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents:
diff changeset
18 ##
9adf76893ce4 Added ufl.m
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents:
diff changeset
19 ## Writes the given line to a ufl file. Optional commands are:
9adf76893ce4 Added ufl.m
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents:
diff changeset
20 ## @itemize @bullet
9adf76893ce4 Added ufl.m
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents:
diff changeset
21 ## @item start: opens an ufl file. It is possible to specify a name for it,
9adf76893ce4 Added ufl.m
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents:
diff changeset
22 ## otherwise 'default.ufl' will be used.
225
72af6354bf02 Compile right away after ufl end
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 224
diff changeset
23 ## @item end: closes the ufl file and compiles it. It is possible to
72af6354bf02 Compile right away after ufl end
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 224
diff changeset
24 ## specify its @var{content}, otherwise a complete problem is assumed.
72af6354bf02 Compile right away after ufl end
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 224
diff changeset
25 ## Possible options are: BilinearForm, Functional, FunctionSpace, LinearForm
72af6354bf02 Compile right away after ufl end
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 224
diff changeset
26 ## and Problem.
220
9adf76893ce4 Added ufl.m
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents:
diff changeset
27 ## @end itemize
9adf76893ce4 Added ufl.m
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents:
diff changeset
28 ##
225
72af6354bf02 Compile right away after ufl end
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 224
diff changeset
29 ## @example
226
043120f071de Correct help message for ufl
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 225
diff changeset
30 ## @code{ufl start linform}
043120f071de Correct help message for ufl
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 225
diff changeset
31 ## @code{ufl element = FiniteElement ("Lagrange", triangle, 1)}
043120f071de Correct help message for ufl
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 225
diff changeset
32 ## @code{ufl v = TestFunction (element)}
043120f071de Correct help message for ufl
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 225
diff changeset
33 ## @code{ufl f = Coefficient (element)}
043120f071de Correct help message for ufl
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 225
diff changeset
34 ## @code{ufl L = f*v*dx}
043120f071de Correct help message for ufl
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 225
diff changeset
35 ## @code{ufl end LinearForm}
225
72af6354bf02 Compile right away after ufl end
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 224
diff changeset
36 ## @end example
72af6354bf02 Compile right away after ufl end
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 224
diff changeset
37 ##
226
043120f071de Correct help message for ufl
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 225
diff changeset
38 ## This way you can write a ufl file and compile it obtaining a LinearForm.
043120f071de Correct help message for ufl
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 225
diff changeset
39 ##
225
72af6354bf02 Compile right away after ufl end
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 224
diff changeset
40 ## @seealso{import_ufl_Problem, import_ufl_BilinearForm, import_ufl_Functional,
72af6354bf02 Compile right away after ufl end
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 224
diff changeset
41 ## import_ufl_FunctionSpace, import_ufl_LinearForm}
220
9adf76893ce4 Added ufl.m
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents:
diff changeset
42 ## @end deftypefn
9adf76893ce4 Added ufl.m
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents:
diff changeset
43
9adf76893ce4 Added ufl.m
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents:
diff changeset
44 function ufl (varargin)
9adf76893ce4 Added ufl.m
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents:
diff changeset
45
9adf76893ce4 Added ufl.m
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents:
diff changeset
46 persistent fid = -1;
225
72af6354bf02 Compile right away after ufl end
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 224
diff changeset
47 persistent filename = "default.ufl";
72af6354bf02 Compile right away after ufl end
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 224
diff changeset
48 persistent opts = {"BilinearForm",
72af6354bf02 Compile right away after ufl end
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 224
diff changeset
49 "Functional",
72af6354bf02 Compile right away after ufl end
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 224
diff changeset
50 "FunctionSpace",
72af6354bf02 Compile right away after ufl end
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 224
diff changeset
51 "LinearForm",
72af6354bf02 Compile right away after ufl end
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 224
diff changeset
52 "Problem"};
220
9adf76893ce4 Added ufl.m
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents:
diff changeset
53
9adf76893ce4 Added ufl.m
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents:
diff changeset
54 if (numel (varargin) < 1)
222
6671cb83a2dd Make use of is_valid_file_id for fid checks
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 220
diff changeset
55 if (! is_valid_file_id (fid))
220
9adf76893ce4 Added ufl.m
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents:
diff changeset
56 print_usage ();
9adf76893ce4 Added ufl.m
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents:
diff changeset
57 endif
9adf76893ce4 Added ufl.m
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents:
diff changeset
58 elseif (! all (cellfun ("ischar", varargin)))
9adf76893ce4 Added ufl.m
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents:
diff changeset
59 error ("ufl: all arguments should be strings");
9adf76893ce4 Added ufl.m
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents:
diff changeset
60 elseif (strcmpi (varargin{1}, "start"))
222
6671cb83a2dd Make use of is_valid_file_id for fid checks
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 220
diff changeset
61 if (is_valid_file_id (fid))
220
9adf76893ce4 Added ufl.m
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents:
diff changeset
62 error ("ufl: a file is already open");
9adf76893ce4 Added ufl.m
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents:
diff changeset
63 else
9adf76893ce4 Added ufl.m
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents:
diff changeset
64 if (numel (varargin) > 1)
9adf76893ce4 Added ufl.m
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents:
diff changeset
65 filename = varargin{2};
9adf76893ce4 Added ufl.m
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents:
diff changeset
66 if (isempty (regexpi (filename, ".ufl$", "match")))
9adf76893ce4 Added ufl.m
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents:
diff changeset
67 filename = [filename, ".ufl"];
224
a108a0bfe201 Ensure that ufl opens a file with .ufl extension
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 223
diff changeset
68 else
a108a0bfe201 Ensure that ufl opens a file with .ufl extension
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 223
diff changeset
69 filename = [filename(1:end-4), ".ufl"];
220
9adf76893ce4 Added ufl.m
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents:
diff changeset
70 endif
9adf76893ce4 Added ufl.m
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents:
diff changeset
71 endif
223
8b159045242f ufl errors out if filename exists when start command is issued
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 222
diff changeset
72 [~, err, ~] = stat (filename);
8b159045242f ufl errors out if filename exists when start command is issued
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 222
diff changeset
73 if (err == 0)
8b159045242f ufl errors out if filename exists when start command is issued
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 222
diff changeset
74 error (["ufl: a file named ", filename, " already exists"]);
8b159045242f ufl errors out if filename exists when start command is issued
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 222
diff changeset
75 else
8b159045242f ufl errors out if filename exists when start command is issued
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 222
diff changeset
76 fid = fopen (filename, "w");
8b159045242f ufl errors out if filename exists when start command is issued
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 222
diff changeset
77 endif
220
9adf76893ce4 Added ufl.m
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents:
diff changeset
78 endif
222
6671cb83a2dd Make use of is_valid_file_id for fid checks
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 220
diff changeset
79 if (! is_valid_file_id (fid))
220
9adf76893ce4 Added ufl.m
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents:
diff changeset
80 error (["ufl: could not open file ", filename]);
9adf76893ce4 Added ufl.m
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents:
diff changeset
81 endif
9adf76893ce4 Added ufl.m
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents:
diff changeset
82 elseif (strcmpi (varargin{1}, "end"))
222
6671cb83a2dd Make use of is_valid_file_id for fid checks
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 220
diff changeset
83 if (! is_valid_file_id (fid))
220
9adf76893ce4 Added ufl.m
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents:
diff changeset
84 error ("ufl: no open file");
9adf76893ce4 Added ufl.m
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents:
diff changeset
85 else
9adf76893ce4 Added ufl.m
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents:
diff changeset
86 fclose (fid);
9adf76893ce4 Added ufl.m
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents:
diff changeset
87 fid = -1;
9adf76893ce4 Added ufl.m
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents:
diff changeset
88 endif
225
72af6354bf02 Compile right away after ufl end
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 224
diff changeset
89 compile = "Problem";
72af6354bf02 Compile right away after ufl end
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 224
diff changeset
90 if (numel (varargin) > 1)
72af6354bf02 Compile right away after ufl end
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 224
diff changeset
91 compile = validatestring (varargin{2}, opts, "ufl", "content");
72af6354bf02 Compile right away after ufl end
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 224
diff changeset
92 endif
72af6354bf02 Compile right away after ufl end
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 224
diff changeset
93 eval (["import_ufl_", compile, "(\"", filename(1:end-4), "\");"]);
72af6354bf02 Compile right away after ufl end
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 224
diff changeset
94 filename = "default.ufl";
222
6671cb83a2dd Make use of is_valid_file_id for fid checks
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 220
diff changeset
95 elseif (! is_valid_file_id (fid))
220
9adf76893ce4 Added ufl.m
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents:
diff changeset
96 error ("ufl: no open file");
9adf76893ce4 Added ufl.m
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents:
diff changeset
97 else
222
6671cb83a2dd Make use of is_valid_file_id for fid checks
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 220
diff changeset
98 if (is_valid_file_id (fid))
6671cb83a2dd Make use of is_valid_file_id for fid checks
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 220
diff changeset
99 fprintf (fid, "%s ", varargin{:});
6671cb83a2dd Make use of is_valid_file_id for fid checks
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 220
diff changeset
100 fprintf (fid, "\n");
6671cb83a2dd Make use of is_valid_file_id for fid checks
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 220
diff changeset
101 else
6671cb83a2dd Make use of is_valid_file_id for fid checks
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 220
diff changeset
102 error ("ufl: no open file");
6671cb83a2dd Make use of is_valid_file_id for fid checks
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 220
diff changeset
103 endif
220
9adf76893ce4 Added ufl.m
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents:
diff changeset
104 endif
9adf76893ce4 Added ufl.m
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents:
diff changeset
105
9adf76893ce4 Added ufl.m
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents:
diff changeset
106 endfunction