aboutsummaryrefslogtreecommitdiff
path: root/Carpet/Carpet/src/modes.hh
blob: 23a20ed5d03a6930eb31bed0dc1c561d541cce1e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
#ifndef MODES_HH
#define MODES_HH

#include <cctk.h>
  


namespace Carpet {
  
  using namespace std;
  
  
  
  //
  // These are the modes:
  //
  // meta mode:
  // global mode:    mglevel ("convergence level") is defined
  // level mode:     reflevel is defined
  // singlemap mode: map ("map index") is defined
  // local mode:     component ("patch index")
  //
  // maybe missing:
  // convtest mode:  [rl, map, c]
  //
  
  
  
  // Mode indicators
  bool is_meta_mode () CCTK_ATTRIBUTE_PURE;
  bool is_global_mode () CCTK_ATTRIBUTE_PURE;
  bool is_level_mode () CCTK_ATTRIBUTE_PURE;
  bool is_singlemap_mode () CCTK_ATTRIBUTE_PURE;
  bool is_local_mode () CCTK_ATTRIBUTE_PURE;
  
  
  
  // Mode setting
  
  void enter_global_mode (cGH * cctkGH, int ml);
  void leave_global_mode (cGH * cctkGH);
  
  void enter_level_mode (cGH * cctkGH, int rl);
  void leave_level_mode (cGH * cctkGH);
  
  void enter_singlemap_mode (cGH * cctkGH, int m, int grouptype);
  void leave_singlemap_mode (cGH * cctkGH);
  
  void enter_local_mode (cGH * cctkGH, int c, int lc, int grouptype);
  void leave_local_mode (cGH * cctkGH);
  
  
  
  // Mode iterators
  
  class mglevel_iterator {
    cGH * cctkGH;
    int ml;
  public:
    mglevel_iterator (cGH const * cctkGH);
    ~mglevel_iterator ();
    bool done () const;
    void step ();
  };
  
  class reverse_mglevel_iterator {
    cGH * cctkGH;
    int ml;
  public:
    reverse_mglevel_iterator (cGH const * cctkGH);
    ~reverse_mglevel_iterator ();
    bool done () const;
    void step ();
  };
  
  class reflevel_iterator {
    cGH * cctkGH;
    int rl;
  public:
    reflevel_iterator (cGH const * cctkGH);
    ~reflevel_iterator ();
    bool done () const;
    void step ();
  };
  
  class reverse_reflevel_iterator {
    cGH * cctkGH;
    int rl;
  public:
    reverse_reflevel_iterator (cGH const * cctkGH);
    ~reverse_reflevel_iterator ();
    bool done () const;
    void step ();
  };
  
  // Loop over all maps.  If grouptype is CCTK_GF, then loop over grid
  // function maps.  If grouptype is CCTK_ARRAY (or CCTK_SCALAR), then
  // loop over grid array (or grid scalar) maps.  In the latter case,
  // map denotes the current grid array map, i.e. it cannot be used to
  // access grid functions.
  class map_iterator {
    cGH * cctkGH;
    int grouptype;
    int m;
  public:
    map_iterator (cGH const * cctkGH, int grouptype);
    ~map_iterator ();
    bool done () const;
    void step ();
  };
    
  class local_map_iterator {
    cGH * cctkGH;
    int grouptype;
    int m;
  public:
    local_map_iterator (cGH const * cctkGH, int grouptype);
    ~local_map_iterator ();
    bool done () const;
    void step ();
  };
    
  // Loop over all components.  If grouptype is CCTK_GF, then loop
  // over grid function components.  If grouptype is CCTK_ARRAY (or
  // CCTK_SCALAR), then loop over grid array (or grid scalar)
  // components.  In the latter case, component denotes the current
  // grid array component, i.e. it cannot be used to index grid
  // functions.
  class component_iterator {
    cGH * cctkGH;
    int grouptype;
    int c;
  public:
    component_iterator (cGH const * cctkGH, int grouptype);
    ~component_iterator ();
    bool done () const;
    void step ();
  };
    
  class local_component_iterator {
    cGH * cctkGH;
    int grouptype;
    int lc;
  public:
    local_component_iterator (cGH const * cctkGH, int grouptype);
    ~local_component_iterator ();
    bool done () const;
    void step ();
  };
  
  
  
  // Compatibility defines for the mode iterators
  
#define BEGIN_MGLEVEL_LOOP(cctkGH)                      \
  do {                                                  \
    bool mglevel_loop_ = true;                          \
    for (Carpet::mglevel_iterator mg_iter_(cctkGH);     \
         not mg_iter_.done();                           \
         mg_iter_.step()) {
#define END_MGLEVEL_LOOP                        \
    }                                           \
    assert (mglevel_loop_);                     \
    mglevel_loop_ = false;                      \
  } while (false)
  
#define BEGIN_REVERSE_MGLEVEL_LOOP(cctkGH)                      \
  do {                                                          \
    bool reverse_mglevel_loop_ = true;                          \
    for (Carpet::reverse_mglevel_iterator mg_iter_(cctkGH);     \
         not mg_iter_.done();                                   \
         mg_iter_.step()) {
#define END_REVERSE_MGLEVEL_LOOP                \
    }                                           \
    assert (reverse_mglevel_loop_);             \
    reverse_mglevel_loop_ = false;              \
  } while (false)

#define BEGIN_REFLEVEL_LOOP(cctkGH)                     \
  do {                                                  \
    bool reflevel_loop_ = true;                         \
    for (Carpet::reflevel_iterator ref_iter_(cctkGH);   \
         not ref_iter_.done();                          \
         ref_iter_.step()) {
#define END_REFLEVEL_LOOP                       \
    }                                           \
    assert (reflevel_loop_);                    \
    reflevel_loop_ = false;                     \
  } while (false)

#define BEGIN_REVERSE_REFLEVEL_LOOP(cctkGH)                     \
  do {                                                          \
    bool reverse_reflevel_loop_ = true;                         \
    for (Carpet::reverse_reflevel_iterator ref_iter_(cctkGH);   \
         not ref_iter_.done();                                  \
         ref_iter_.step()) {
#define END_REVERSE_REFLEVEL_LOOP               \
    }                                           \
    assert (reverse_reflevel_loop_);            \
    reverse_reflevel_loop_ = false;             \
  } while (false)

#define BEGIN_MAP_LOOP(cctkGH, grouptype)                       \
  do {                                                          \
    bool map_loop_ = true;                                      \
    for (Carpet::map_iterator map_iter_(cctkGH, grouptype);     \
         not map_iter_.done();                                  \
         map_iter_.step()) {
#define END_MAP_LOOP                            \
    }                                           \
    assert (map_loop_);                         \
    map_loop_ = false;                          \
  } while (false)

#define BEGIN_LOCAL_MAP_LOOP(cctkGH, grouptype)                         \
  do {                                                                  \
    bool local_map_loop_ = true;                                        \
    for (Carpet::local_map_iterator local_map_iter_(cctkGH, grouptype); \
         not local_map_iter_.done();                                    \
         local_map_iter_.step()) {
#define END_LOCAL_MAP_LOOP                      \
    }                                           \
    assert (local_map_loop_);                   \
    local_map_loop_ = false;                    \
  } while (false)

#define BEGIN_COMPONENT_LOOP(cctkGH, grouptype)                         \
  do {                                                                  \
    bool component_loop_ = true;                                        \
    for (Carpet::component_iterator comp_iter_(cctkGH, grouptype);      \
         not comp_iter_.done();                                         \
         comp_iter_.step()) {
#define END_COMPONENT_LOOP                      \
    }                                           \
    assert (component_loop_);                   \
    component_loop_ = false;                    \
  } while (false)

#define BEGIN_LOCAL_COMPONENT_LOOP(cctkGH, grouptype)                   \
  do {                                                                  \
    bool local_component_loop_ = true;                                  \
    for (Carpet::local_component_iterator comp_iter_(cctkGH, grouptype); \
         not comp_iter_.done();                                         \
         comp_iter_.step()) {
#define END_LOCAL_COMPONENT_LOOP                \
    }                                           \
    assert (local_component_loop_);             \
    local_component_loop_ = false;              \
  } while (false)

#define BEGIN_TIMELEVEL_LOOP(cctkGH)                                    \
  do {                                                                  \
    bool timelevel_loop_ = true;                                        \
    assert (do_allow_past_timelevels);                                  \
    do_allow_past_timelevels = false;                                   \
    assert (timelevel == 0);                                            \
    assert (timelevel_offset == 0);                                     \
    assert (not adaptive_stepsize);                                     \
    for (timelevel = timelevels - 1; timelevel >= 0; -- timelevel) {    \
      timelevel_offset = timelevel;                                     \
      cctkGH->cctk_time = tt->get_time (mglevel, reflevel, timelevel);  \
      {
#define END_TIMELEVEL_LOOP                                              \
      }                                                                 \
    }                                                                   \
    assert (timelevel_loop_);                                           \
    timelevel_loop_ = false;                                            \
    timelevel = 0;                                                      \
    timelevel_offset = 0;                                               \
    /* cctkGH->cctk_time = tt->get_time (mglevel, reflevel, timelevel); */ \
    do_allow_past_timelevels = true;                                    \
  } while (false)
  
  
  
#if 0
// TODO: Introduce such maybe-loops for the other loops as well

#define BEGIN_MAYBE_TIMELEVEL_LOOP(cctkGH)                              \
  do {                                                                  \
    bool timelevel_maybe_loop_ = true;                                  \
    assert (do_allow_past_timelevels);                                  \
    int const min_tl = timelevel == -1 ? 0 : timelevel;                 \
    int const max_tl = timelevel == -1 ? timelevels : timelevel+1;      \
    int const old_timelevel = timelevel;                                \
    bool const old_do_allow_past_timelevels = do_allow_past_timelevels; \
    do_allow_past_timelevels = timelevel != -1;                         \
    for (timelevel = min_tl; timelevel < max_tl; ++ timelevel) {        \
      if (mglevel != -1 and reflevel != -1) {                           \
        cctkGH->cctk_time = tt->get_time (mglevel, reflevel, timelevel); \
      }                                                                 \
      {
#define END_MAYBE_TIMELEVEL_LOOP                                \
      }                                                         \
    }                                                           \
    assert (timelevel_maybe_loop_);                             \
    timelevel_maybe_loop_ = false;                              \
    timelevel = old_timelevel;                                  \
    if (mglevel != -1 and reflevel != -1) {                     \
      int const tl = timelevel == -1 ? 0 : timelevel;           \
      cctkGH->cctk_time = tt->get_time (mglevel, reflevel, tl); \
    }                                                           \
    do_allow_past_timelevels = old_do_allow_past_timelevels;    \
  } while (false)
#endif



  // Mode escapes
  
  class singlemap_escape {
    cGH * cctkGH;
    int c;
    int lc;
  public:
    singlemap_escape (cGH const * cctkGH);
    ~singlemap_escape ();
  };
  
  class level_escape {
    cGH * cctkGH;
    int grouptype;
    int m;
    int c;
    int lc;
  public:
    level_escape (cGH const * cctkGH);
    ~level_escape ();
  };
  
  class global_escape {
    cGH * cctkGH;
    int rl;
    int grouptype;
    int m;
    int c;
    int lc;
  public:
    global_escape (cGH const * cctkGH);
    ~global_escape ();
  };
  
  class meta_escape {
    cGH * cctkGH;
    int ml;
    int rl;
    int grouptype;
    int m;
    int c;
    int lc;
  public:
    meta_escape (cGH const * cctkGH);
    ~meta_escape ();
  };
  
  
  
  // Compatibility defines for the mode escapes
  
#define BEGIN_SINGLEMAP_MODE(cctkGH)            \
  do {                                          \
    bool singlemap_mode_ = true;                \
    Carpet::singlemap_escape esc_(cctkGH);      \
    {
#define END_SINGLEMAP_MODE                      \
    }                                           \
    assert (singlemap_mode_);                   \
    singlemap_mode_ = false;                    \
  } while (false)
  
#define BEGIN_LEVEL_MODE(cctkGH)                \
  do {                                          \
    bool level_mode_ = true;                    \
    Carpet::level_escape esc_(cctkGH);          \
    {
#define END_LEVEL_MODE                          \
    }                                           \
    assert (level_mode_);                       \
    level_mode_ = false;                        \
  } while (false)
  
#define BEGIN_GLOBAL_MODE(cctkGH)               \
  do {                                          \
    bool global_mode_ = true;                   \
    Carpet::global_escape esc_(cctkGH);         \
    {
#define END_GLOBAL_MODE                         \
    }                                           \
    assert (global_mode_);                      \
    global_mode_ = false;                       \
  } while (false)
  
#define BEGIN_META_MODE(cctkGH)                 \
  do {                                          \
    bool meta_mode_ = true;                     \
    Carpet::meta_escape esc_(cctkGH);           \
    {
#define END_META_MODE                           \
    }                                           \
    assert (meta_mode_);                        \
    meta_mode_ = false;                         \
  } while (false)
  
  
  
  // Mode setters
  
  class mglevel_setter {
    cGH * cctkGH;
  public:
    mglevel_setter (cGH const * cctkGH, int ml);
    ~mglevel_setter ();
  };
  
  class reflevel_setter {
    cGH * cctkGH;
  public:
    reflevel_setter (cGH const * cctkGH, int rl);
    ~reflevel_setter ();
  };
  
  class map_setter {
    cGH * cctkGH;
  public:
    map_setter (cGH const * cctkGH, int m, int grouptype);
    ~map_setter ();
  };
  
  class component_setter {
    cGH * cctkGH;
  public:
    component_setter (cGH const * cctkGH, int c, int grouptype);
    ~component_setter ();
  };
  
  
  
  // Compatibility defines for the mode setters
  
#define ENTER_GLOBAL_MODE(cctkGH, ml)                   \
  do {                                                  \
    Carpet::mglevel_setter mg_setter_(cctkGH, ml);      \
    {
#define LEAVE_GLOBAL_MODE                       \
    }                                           \
  } while (false)
  
#define ENTER_LEVEL_MODE(cctkGH, rl)                    \
  do {                                                  \
    Carpet::reflevel_setter ref_setter_(cctkGH, rl);    \
    {
#define LEAVE_LEVEL_MODE                        \
    }                                           \
  } while (false)
  
#define ENTER_SINGLEMAP_MODE(cctkGH, m, grouptype)      \
  do {                                                  \
    Carpet::map_setter m_setter_(cctkGH, m, grouptype); \
    {
#define LEAVE_SINGLEMAP_MODE                    \
    }                                           \
  } while (false)
  
#define ENTER_LOCAL_MODE(cctkGH, c, grouptype)                  \
  do {                                                          \
    Carpet::component_setter c_setter_(cctkGH, c, grouptype);   \
    {
#define LEAVE_LOCAL_MODE                        \
    }                                           \
  } while (false)
  
  
  
  // Loop over a bounding box
  
  void ibbox2iminimax (ibbox const& ext, // component extent
                       ibbox const& box, // this bbox
                       ivect& imin, ivect& imax);
  
#define LOOP_OVER_BBOX(cctkGH, box_, box, imin, imax)                   \
  do {                                                                  \
    bool bbox_loop_ = true;                                             \
    assert (Carpet::is_local_mode());                                   \
    dh::light_mboxes const& light_boxes_ =                              \
      Carpet::vdd.AT(Carpet::map)->light_boxes;                         \
    ibbox const& ext_ =                                                 \
      light_boxes_.AT(mglevel).AT(reflevel).AT(component).exterior;     \
    ibbox const box = (box_) & ext_;                                    \
    if (not box.empty()) {                                              \
      ivect imin;                                                       \
      ivect imax;                                                       \
      Carpet::ibbox2iminimax (ext_, box, imin, imax);                   \
      {
#define END_LOOP_OVER_BBOX                      \
      }                                         \
    } /* if not empty */                        \
    assert (bbox_loop_);                        \
    bbox_loop_ = false;                         \
  } while (false)

#define LOOP_OVER_BSET(cctkGH, set_, box, imin, imax)                   \
  do {                                                                  \
    bool bset_loop_ = true;                                             \
    ibset const& set1_ (set_);                                          \
    for (ibset::const_iterator bi = set1_.begin(); bi != set1_.end(); ++bi) { \
      LOOP_OVER_BBOX(cctkGH, *bi, box, imin, imax) {
#define END_LOOP_OVER_BSET                      \
      } END_LOOP_OVER_BBOX;                     \
    } /* for */                                 \
    assert (bset_loop_);                        \
    bset_loop_ = false;                         \
  } while (false)
  
  
  
} // namespace Carpet

#endif // #ifndef MODES_HH