Mercurial > repos > public > sbplib
annotate +grid/Staggered.m @ 1262:b673081db86b feature/poroelastic
Rename the Staggered1d grid class Staggered
author | Martin Almquist <malmquist@stanford.edu> |
---|---|
date | Wed, 29 Apr 2020 21:03:28 -0700 |
parents | |
children | 8aa0909125a4 |
rev | line source |
---|---|
1262
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
1 classdef Staggered < grid.Structured |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
2 properties |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
3 gridGroups % Cell array of grid groups, each group is a cell array |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
4 nGroups % Number of grid groups |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
5 h % Interior grid spacing |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
6 d % Number of dimensions |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
7 end |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
8 |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
9 methods |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
10 |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
11 % Accepts multiple grids and combines them into a staggered grid |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
12 % Each grid entry is a cell array of grids that store the same field |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
13 function obj = Staggered(d, varargin) |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
14 default_arg('d', 2); |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
15 |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
16 obj.d = d; |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
17 |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
18 obj.nGroups = length(varargin); |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
19 obj.gridGroups = cell(obj.nGroups, 1); |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
20 for i = 1:obj.nGroups |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
21 obj.gridGroups{i} = varargin{i}; |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
22 end |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
23 |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
24 obj.h = []; |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
25 end |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
26 |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
27 % N returns the number of points in the first grid group |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
28 function o = N(obj) |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
29 o = 0; |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
30 gs = obj.gridGroups{1}; |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
31 for i = 1:length(gs) |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
32 o = o+gs{i}.N(); |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
33 end |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
34 end |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
35 |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
36 % D returns the spatial dimension of the grid |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
37 function o = D(obj) |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
38 o = obj.d; |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
39 end |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
40 |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
41 % size returns a reference size |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
42 function m = size(obj) |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
43 m = obj.gridGroups{1}{1}; |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
44 end |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
45 |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
46 % points returns an n x 1 vector containing the coordinates for the first grid group. |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
47 function X = points(obj) |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
48 X = []; |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
49 gs = obj.gridGroups{1}; |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
50 for i = 1:length(gs) |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
51 X = [X; gs{i}.points()]; |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
52 end |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
53 end |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
54 |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
55 % matrices returns a cell array with coordinates in matrix form. |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
56 % For 2d case these will have to be transposed to work with plotting routines. |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
57 function X = matrices(obj) |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
58 error('grid:Staggered1d:matrices', 'Not implemented') |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
59 end |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
60 |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
61 function h = scaling(obj) |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
62 if isempty(obj.h) |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
63 error('grid:Staggered1d:NoScalingSet', 'No scaling set') |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
64 end |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
65 |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
66 h = obj.h; |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
67 end |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
68 |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
69 % Restricts the grid function gf on obj to the subgrid g. |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
70 % Only works for even multiples |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
71 function gf = restrictFunc(obj, gf, g) |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
72 error('grid:Staggered1d:NotImplemented','This method does not exist yet') |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
73 end |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
74 |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
75 % Projects the grid function gf on obj to the grid g. |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
76 function gf = projectFunc(obj, gf, g) |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
77 error('grid:Staggered1d:NotImplemented','This method does not exist yet') |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
78 end |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
79 |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
80 % Return the names of all boundaries in this grid. |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
81 function bs = getBoundaryNames(obj) |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
82 switch obj.d() |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
83 case 1 |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
84 bs = {'l', 'r'}; |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
85 case 2 |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
86 bs = {'w', 'e', 's', 'n'}; |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
87 case 3 |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
88 bs = {'w', 'e', 's', 'n', 'd', 'u'}; |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
89 otherwise |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
90 error('not implemented'); |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
91 end |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
92 end |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
93 |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
94 % Return coordinates for the given boundary |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
95 function X = getBoundary(obj, name) |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
96 % Use boundaries of first grid |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
97 X = obj.gridGroups{1}{1}.getBoundary(name); |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
98 end |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
99 end |
b673081db86b
Rename the Staggered1d grid class Staggered
Martin Almquist <malmquist@stanford.edu>
parents:
diff
changeset
|
100 end |