annotate +grid/Grid.m @ 164:772365e2cf96 feature/grids

Correct method signatures in Grid.m
author Jonatan Werpers <jonatan@werpers.com>
date Mon, 22 Feb 2016 15:56:33 +0100
parents 685ba6e6c679
children c2db0294f8ed
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
153
7aee9eba3bb8 Added abstract classes for some different types of grids.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
1 classdef Grid < handle
7aee9eba3bb8 Added abstract classes for some different types of grids.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
2 % General d dimensional grid with n points
7aee9eba3bb8 Added abstract classes for some different types of grids.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
3 methods (Abstract)
7aee9eba3bb8 Added abstract classes for some different types of grids.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
4 % n returns the number of points in the grid
7aee9eba3bb8 Added abstract classes for some different types of grids.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
5 o = N(obj)
7aee9eba3bb8 Added abstract classes for some different types of grids.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
6
7aee9eba3bb8 Added abstract classes for some different types of grids.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
7 % d returns the spatial dimension of the grid
7aee9eba3bb8 Added abstract classes for some different types of grids.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
8 o = D(obj)
7aee9eba3bb8 Added abstract classes for some different types of grids.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
9
155
cf748f33cd5b Removed some extra lines, added some notes and comments. Fixed classname.
Jonatan Werpers <jonatan@werpers.com>
parents: 153
diff changeset
10 % points returns a n x d matrix containing the coordinates for all points.
153
7aee9eba3bb8 Added abstract classes for some different types of grids.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
11 X = points(obj)
158
685ba6e6c679 Added abstract methods to Grid.
Jonatan Werpers <jonatan@werpers.com>
parents: 155
diff changeset
12
685ba6e6c679 Added abstract methods to Grid.
Jonatan Werpers <jonatan@werpers.com>
parents: 155
diff changeset
13 % Restricts the grid function gf on obj to the subgrid g.
164
772365e2cf96 Correct method signatures in Grid.m
Jonatan Werpers <jonatan@werpers.com>
parents: 158
diff changeset
14 gf = restrictFunc(obj, gf, g)
158
685ba6e6c679 Added abstract methods to Grid.
Jonatan Werpers <jonatan@werpers.com>
parents: 155
diff changeset
15
685ba6e6c679 Added abstract methods to Grid.
Jonatan Werpers <jonatan@werpers.com>
parents: 155
diff changeset
16 % Projects the grid function gf on obj to the grid g.
164
772365e2cf96 Correct method signatures in Grid.m
Jonatan Werpers <jonatan@werpers.com>
parents: 158
diff changeset
17 gf = projectFunc(obj, gf, g)
153
7aee9eba3bb8 Added abstract classes for some different types of grids.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
18 end
7aee9eba3bb8 Added abstract classes for some different types of grids.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
19 end
7aee9eba3bb8 Added abstract classes for some different types of grids.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
20
7aee9eba3bb8 Added abstract classes for some different types of grids.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
21
7aee9eba3bb8 Added abstract classes for some different types of grids.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
22 %% Should it be able to return a cell size aswell? For an equidistant grid this would be know
7aee9eba3bb8 Added abstract classes for some different types of grids.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
23 %% for other grids the constructor would have to make something up.
155
cf748f33cd5b Removed some extra lines, added some notes and comments. Fixed classname.
Jonatan Werpers <jonatan@werpers.com>
parents: 153
diff changeset
24 %% For example the grid.Cartesian constructor would take a h (1 x d) vector as an in parameter.
cf748f33cd5b Removed some extra lines, added some notes and comments. Fixed classname.
Jonatan Werpers <jonatan@werpers.com>
parents: 153
diff changeset
25
cf748f33cd5b Removed some extra lines, added some notes and comments. Fixed classname.
Jonatan Werpers <jonatan@werpers.com>
parents: 153
diff changeset
26
cf748f33cd5b Removed some extra lines, added some notes and comments. Fixed classname.
Jonatan Werpers <jonatan@werpers.com>
parents: 153
diff changeset
27 %Should define boundaries somehow, look in stitchSchemes.