annotate +grid/evalOn.m @ 582:ce44af8d7dd1 feature/grids

Rename grid.EmptyGrid to grid.Empty
author Jonatan Werpers <jonatan@werpers.com>
date Thu, 07 Sep 2017 10:21:15 +0200
parents 4c3f55a628c8
children d196b7cdc626
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
276
30321dc180e1 Fixed documentation for Curvilinear and evalOn.
Jonatan Werpers <jonatan@werpers.com>
parents: 275
diff changeset
1 % Takes a function and evaluates it on a grid to return a grid function in the
157
ea8103ad2cc5 Added function eval on.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
2 % form of a (n*k)x1 vector, where n is the number of grid points and k is the
ea8103ad2cc5 Added function eval on.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
3 % number of components of the function.
ea8103ad2cc5 Added function eval on.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
4 % g -- Grid to evaluate on.
ea8103ad2cc5 Added function eval on.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
5 % func -- Function to evaluate. May be a function handle or a constant. If
ea8103ad2cc5 Added function eval on.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
6 % it is a vector value it has to be provided as a column vector,
ea8103ad2cc5 Added function eval on.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
7 function gf = evalOn(g, func)
ea8103ad2cc5 Added function eval on.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
8 if ~isa(func, 'function_handle')
ea8103ad2cc5 Added function eval on.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
9 % We should have a constant.
ea8103ad2cc5 Added function eval on.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
10 if size(func,2) ~= 1
ea8103ad2cc5 Added function eval on.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
11 error('grid:evalOn:VectorValuedWrongDim', 'A vector valued function must be given as a column vector')
ea8103ad2cc5 Added function eval on.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
12 end
ea8103ad2cc5 Added function eval on.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
13
ea8103ad2cc5 Added function eval on.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
14 gf = repmat(func,[g.N, 1]);
ea8103ad2cc5 Added function eval on.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
15 return
ea8103ad2cc5 Added function eval on.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
16 end
ea8103ad2cc5 Added function eval on.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
17 % func should now be a function_handle
ea8103ad2cc5 Added function eval on.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
18
277
4c3f55a628c8 Made evalOn give more error message.
Jonatan Werpers <jonatan@werpers.com>
parents: 276
diff changeset
19 if g.D ~= nargin(func)
4c3f55a628c8 Made evalOn give more error message.
Jonatan Werpers <jonatan@werpers.com>
parents: 276
diff changeset
20 g.D
4c3f55a628c8 Made evalOn give more error message.
Jonatan Werpers <jonatan@werpers.com>
parents: 276
diff changeset
21 nargin(func)
4c3f55a628c8 Made evalOn give more error message.
Jonatan Werpers <jonatan@werpers.com>
parents: 276
diff changeset
22 error('grid:evalOn:WrongNumberOfInputs', 'The number of inputs of the function must match the dimension of the domain.')
4c3f55a628c8 Made evalOn give more error message.
Jonatan Werpers <jonatan@werpers.com>
parents: 276
diff changeset
23 end
4c3f55a628c8 Made evalOn give more error message.
Jonatan Werpers <jonatan@werpers.com>
parents: 276
diff changeset
24
4c3f55a628c8 Made evalOn give more error message.
Jonatan Werpers <jonatan@werpers.com>
parents: 276
diff changeset
25
157
ea8103ad2cc5 Added function eval on.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
26 % Get coordinates and convert to cell array for easier use as a parameter
275
3ea2ae2a3d15 Improvments to eval on grids. Added function to extrac components of a vector gf.
Jonatan Werpers <jonatan@werpers.com>
parents: 274
diff changeset
27 x = num2cell(g.points());
157
ea8103ad2cc5 Added function eval on.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
28
ea8103ad2cc5 Added function eval on.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
29 % Find the number of components
582
ce44af8d7dd1 Rename grid.EmptyGrid to grid.Empty
Jonatan Werpers <jonatan@werpers.com>
parents: 277
diff changeset
30 if size(x,1) ~= 0
ce44af8d7dd1 Rename grid.EmptyGrid to grid.Empty
Jonatan Werpers <jonatan@werpers.com>
parents: 277
diff changeset
31 x0 = x(1,:);
ce44af8d7dd1 Rename grid.EmptyGrid to grid.Empty
Jonatan Werpers <jonatan@werpers.com>
parents: 277
diff changeset
32 else
ce44af8d7dd1 Rename grid.EmptyGrid to grid.Empty
Jonatan Werpers <jonatan@werpers.com>
parents: 277
diff changeset
33 x0 = num2cell(ones(1,size(x,2)));
ce44af8d7dd1 Rename grid.EmptyGrid to grid.Empty
Jonatan Werpers <jonatan@werpers.com>
parents: 277
diff changeset
34 end
157
ea8103ad2cc5 Added function eval on.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
35 f0 = func(x0{:});
ea8103ad2cc5 Added function eval on.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
36 k = length(f0);
ea8103ad2cc5 Added function eval on.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
37
ea8103ad2cc5 Added function eval on.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
38 if size(f0,2) ~= 1
ea8103ad2cc5 Added function eval on.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
39 error('grid:evalOn:VectorValuedWrongDim', 'A vector valued function must be given as a column vector')
ea8103ad2cc5 Added function eval on.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
40 end
ea8103ad2cc5 Added function eval on.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
41
275
3ea2ae2a3d15 Improvments to eval on grids. Added function to extrac components of a vector gf.
Jonatan Werpers <jonatan@werpers.com>
parents: 274
diff changeset
42 gf = zeros(g.N*k, 1);
3ea2ae2a3d15 Improvments to eval on grids. Added function to extrac components of a vector gf.
Jonatan Werpers <jonatan@werpers.com>
parents: 274
diff changeset
43 % keyboard
3ea2ae2a3d15 Improvments to eval on grids. Added function to extrac components of a vector gf.
Jonatan Werpers <jonatan@werpers.com>
parents: 274
diff changeset
44 for i = 1:g.N
3ea2ae2a3d15 Improvments to eval on grids. Added function to extrac components of a vector gf.
Jonatan Werpers <jonatan@werpers.com>
parents: 274
diff changeset
45 % (1 + (i-1)*k):(i*k)
3ea2ae2a3d15 Improvments to eval on grids. Added function to extrac components of a vector gf.
Jonatan Werpers <jonatan@werpers.com>
parents: 274
diff changeset
46 % func(x{i,:})
3ea2ae2a3d15 Improvments to eval on grids. Added function to extrac components of a vector gf.
Jonatan Werpers <jonatan@werpers.com>
parents: 274
diff changeset
47 gf((1 + (i-1)*k):(i*k)) = func(x{i,:});
171
0e56192f6459 Made evalOn a bit clearer.
Jonatan Werpers <jonatan@werpers.com>
parents: 157
diff changeset
48 end
157
ea8103ad2cc5 Added function eval on.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
49 end