annotate extra/fpl/deprecated/fpl_dx_write_series.m @ 12671:20e8aca47b2c octave-forge

prepare for release
author cdf
date Mon, 17 Aug 2015 10:19:39 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
12671
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
1 ## Copyright (C) 2006,2007,2008,2009,2010 Carlo de Falco, Massimiliano Culpo
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
2 ##
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
3 ## This file is part of:
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
4 ## FPL - Fem PLotting package for octave
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
5 ##
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
6 ## FPL is free software; you can redistribute it and/or modify
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
7 ## it under the terms of the GNU General Public License as published by
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
8 ## the Free Software Foundation; either version 3 of the License, or
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
9 ## (at your option) any later version.
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
10 ##
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
11 ## FPL is distributed in the hope that it will be useful,
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
12 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
14 ## GNU General Public License for more details.
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
15 ##
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
16 ## You should have received a copy of the GNU General Public License
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
17 ## along with FPL; If not, see <http://www.gnu.org/licenses/>.
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
18 ##
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
19 ## author: Carlo de Falco <cdf _AT_ users.sourceforge.net>
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
20 ## author: Massimiliano Culpo <culpo _AT_ users.sourceforge.net>
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
21
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
22 ## -*- texinfo -*-
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
23 ## @deftypefn {Function File} {} fpl_dx_write_series (@var{basename}, @
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
24 ## @var{mesh}, @var{u}, @var{sp}, @var{attr_name}, @var{attr_rank}, @
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
25 ## @var{attr_shape})
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
26 ##
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
27 ## Output data series in ASCII Open-DX format.
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
28 ##
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
29 ## @var{basename} is a string containing the base-name of the dx file where the
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
30 ## data will be saved.
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
31 ##
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
32 ## @var{mesh} is a PDE-tool like mesh, like the ones generated by the
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
33 ## "msh" package.
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
34 ##
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
35 ## @var{u} is the series to be saved. It should represent scalar, vector
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
36 ## or tensor of doubles. @var{sp} is the vector of the sampled points
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
37 ## (e.g. time points in the case of a time series).
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
38 ##
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
39 ## @var{attr_name} is a descriptive name for the series @var{u}, while
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
40 ## @var{attr_rank} is the rank of the field items (0 for scalar, 1 for
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
41 ## vector, etc.) and @var{attr_shape} is the number of components of the
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
42 ## field items (assumed 1 for scalar).
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
43 ##
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
44 ## @seealso{fpl_dx_write_field}
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
45 ##
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
46 ## @end deftypefn
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
47
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
48 function fpl_dx_write_series(basename,mesh,u,tp,attr_name,attr_rank,attr_shape)
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
49
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
50 ## FIXME: add append capabilities as in fpl_dx_write_field??
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
51
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
52 if nargin!=7
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
53 error("fpl_dx_write_series: wrong number of input");
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
54 endif
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
55
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
56 if !ischar(basename)
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
57 error("fpl_dx_write_series: basename should be a valid string");
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
58 elseif !( isstruct(mesh) )
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
59 error("fpl_dx_write_series: mesh should be a valid structure");
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
60 elseif !ismatrix(u)
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
61 error("fpl_dx_write_series: u should be a valid matrix");
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
62 elseif !ischar(attr_name)
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
63 error("fpl_dx_write_series: attr_name should be a valid string");
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
64 elseif !isscalar(attr_rank)
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
65 error("fpl_dx_write_series: attr_rank should be a valid scalar");
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
66 elseif !isscalar(attr_shape)
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
67 error("fpl_dx_write_series: attr_shape should be a valid scalar");
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
68 ##elseif !isscalar(endfile)
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
69 ##error("fpl_dx_write_series: endfile should be a valid scalar");
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
70 endif
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
71
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
72 filename = [basename ".dx"];
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
73
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
74 npoints = length(tp);
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
75
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
76 p = mesh.p';
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
77 dim = columns(p); # 2D or 3D
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
78
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
79 if dim == 2
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
80 t = mesh.t(1:3,:)';
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
81 elseif dim == 3
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
82 t = mesh.t(1:4,:)';
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
83 else
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
84 error("fpl_dx_write_series: neither 2D triangle nor 3D tetrahedral mesh");
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
85 endif
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
86
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
87 nnodes = rows(p);
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
88 nelems = rows(t);
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
89 ndatas = rows(u);
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
90
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
91 if ndatas == nnodes
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
92 dep = "positions";
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
93 elseif ndatas == nelems
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
94 dep = "connections";
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
95 else
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
96 error("fpl_dx_write_series: neither position nor connection data type")
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
97 endif
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
98
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
99 ## Write field items to file
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
100 idx = (1:attr_shape);
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
101 for ii = 1:npoints
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
102 field = u(:,idx);
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
103 fname = sprintf("%s.%d",attr_name,ii);
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
104 fpl_dx_write_field(basename,mesh,field,fname,attr_rank,attr_shape,0);
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
105 idx += attr_shape;
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
106 endfor
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
107
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
108 ##if endfile
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
109 fid = fopen(filename,"a");
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
110 fprintf (fid, "object \"%s_series\" class series\n",attr_name);
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
111 for ii = 1:npoints
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
112 fname = sprintf("%s.%d",attr_name,ii);
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
113 fprintf (fid,"member %d position %g value \"%s\"\n",ii-1,tp(ii),fname);
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
114 endfor
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
115 fprintf (fid, "\nend\n");
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
116 fclose(fid);
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
117 ##endif
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
118
20e8aca47b2c prepare for release
cdf
parents:
diff changeset
119 endfunction