File: avtFVCOM_MTMDFileFormat.C

package info (click to toggle)
paraview 4.0.1-1~bpo70%2B1
  • links: PTS, VCS
  • area: main
  • in suites: wheezy-backports
  • size: 526,572 kB
  • sloc: cpp: 2,284,430; ansic: 816,374; python: 239,936; xml: 70,162; tcl: 48,295; fortran: 39,116; yacc: 5,466; java: 3,518; perl: 3,107; lex: 1,620; sh: 1,555; makefile: 932; asm: 471; pascal: 228
file content (1567 lines) | stat: -rw-r--r-- 60,760 bytes parent folder | download | duplicates (2)
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
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
/*****************************************************************************
*
* Copyright (c) 2000 - 2006, The Regents of the University of California
* Produced at the Lawrence Livermore National Laboratory
* LLNL-CODE-400124
* All rights reserved.
*
* This file is  part of VisIt. For  details, see https://visit.llnl.gov/.  The
* full copyright notice is contained in the file COPYRIGHT located at the root
* of the VisIt distribution or at http://www.llnl.gov/visit/copyright.html.
*
* Redistribution  and  use  in  source  and  binary  forms,  with  or  without
* modification, are permitted provided that the following conditions are met:
*
*  - Redistributions of  source code must  retain the above  copyright notice,
*    this list of conditions and the disclaimer below.
*  - Redistributions in binary form must reproduce the above copyright notice,
*    this  list of  conditions  and  the  disclaimer (as noted below)  in  the
*    documentation and/or other materials provided with the distribution.
*  - Neither the name of  the LLNS/LLNL nor the names of  its contributors may
*    be used to endorse or promote products derived from this software without
*    specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT  HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR  IMPLIED WARRANTIES, INCLUDING,  BUT NOT  LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND  FITNESS FOR A PARTICULAR  PURPOSE
* ARE  DISCLAIMED. IN  NO EVENT  SHALL LAWRENCE  LIVERMORE NATIONAL  SECURITY,
* LLC, THE  U.S.  DEPARTMENT OF  ENERGY  OR  CONTRIBUTORS BE  LIABLE  FOR  ANY
* DIRECT,  INDIRECT,   INCIDENTAL,   SPECIAL,   EXEMPLARY,  OR   CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT  LIMITED TO, PROCUREMENT OF  SUBSTITUTE GOODS OR
* SERVICES; LOSS OF  USE, DATA, OR PROFITS; OR  BUSINESS INTERRUPTION) HOWEVER
* CAUSED  AND  ON  ANY  THEORY  OF  LIABILITY,  WHETHER  IN  CONTRACT,  STRICT
* LIABILITY, OR TORT  (INCLUDING NEGLIGENCE OR OTHERWISE)  ARISING IN ANY  WAY
* OUT OF THE  USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
* DAMAGE.
*
*****************************************************************************/

// ************************************************************************* //
//                            avtFVCOM_MTMDFileFormat.C                      //
// ************************************************************************* //

#include <avtFVCOM_MTMDFileFormat.h>

#include <string>

#include <vtkCellData.h>
#include <vtkFloatArray.h>
#include <vtkRectilinearGrid.h>
#include <vtkUnsignedCharArray.h>
#include <vtkUnstructuredGrid.h>

#include <avtDatabaseMetaData.h>
#include <avtGhostData.h>
#include <avtIntervalTree.h>

#include <Expression.h>

#include <InvalidFilesException.h>
#include <InvalidVariableException.h>
#include <DebugStream.h>
#include <visit-config.h>
#include <snprintf.h>

#include <NETCDFFileObject.h>
#include <avtFVCOMReader.h>
#include <avtMaterial.h>
#include "vtk_netcdf.h"

using     std::string;


// ****************************************************************************
// Method: avtFVCOM_MTMDFileFormat::Identify
//
// Purpose:
//   This method checks to see if the file is an FVCOM Master file.
//
// Arguments:
//   fileObject : The file to check.
//
// Returns:    True if the file is a particle file; False otherwise.
//
// Note:
//
// Programmer: David Stuebe
// Creation:   Thu May 4 16:18:57 PST 2006
//
//     Edited for mtmd 
//
// Modifications:
//
// ****************************************************************************

bool
avtFVCOM_MTMDFileFormat::Identify(NETCDFFileObject *fileObject)
{
    bool isFVCOM = false;

    // Simple statement to identify FVCOM files:
    // Do not change source statement in mod_ncdio !!!

    std::string source;
    if(fileObject->ReadStringAttribute("source", source))
    {
        isFVCOM = strncmp("MDFVCOM",source.c_str(),7)==0;
    }

    return isFVCOM;
}



// ****************************************************************************
// Method: avtFVCOM_MTMDFileFormat::CreateInterface
//
// Purpose:
//   Creates the file format interface for this reader.
//
// Programmer: David Stuebe
// Creation:   Thu May 4 16:18:57 PST 2006
//
// Modifications:
//   Jeremy Meredith, Thu Jan 28 15:49:05 EST 2010
//   MTMD files can now be grouped into longer sequences.
//
// ****************************************************************************


avtFileFormatInterface *
avtFVCOM_MTMDFileFormat::CreateInterface(NETCDFFileObject *f,
    const char *const *list, int nList, int nBlock)
{
    // ignore any nBlocks past 1
    int nTimestepGroups = nList / nBlock;
    avtMTMDFileFormat **ffl = new avtMTMDFileFormat*[nTimestepGroups];
    for (int i = 0 ; i < nTimestepGroups ; i++)
    {
        ffl[i] = new avtFVCOM_MTMDFileFormat(list[i*nBlock], (i==0)?f:NULL);
    }
    return new avtMTMDFileFormatInterface(ffl, nTimestepGroups);
}


// ****************************************************************************
//  Method: avtFVCOM_MTMD constructor
//
//  Programmer: dstuebe -- generated by xml2avt
//  Creation:   Wed Aug 16 16:40:22 PST 2006
//
// ****************************************************************************


avtFVCOM_MTMDFileFormat::avtFVCOM_MTMDFileFormat(const char *filename)
  : avtMTMDFileFormat(filename)
{
    fileObject = new NETCDFFileObject(filename); 
    init = false;
    keysuffix=filename;
}

avtFVCOM_MTMDFileFormat::avtFVCOM_MTMDFileFormat(const char *filename, 
                         NETCDFFileObject *f)
  : avtMTMDFileFormat(filename)
{
    init = false;
    fileObject = f; 
    keysuffix=filename;
}

// ****************************************************************************
//  Method: avtFVCOM_MTMD destructor
//
//  Programmer: David Stuebe
//  Creation:   Wed May 31 15:50:52 PST 2006
//
// ****************************************************************************

avtFVCOM_MTMDFileFormat::~avtFVCOM_MTMDFileFormat()
{

  debug4 << "avtFVCOM_MTMDFileFormat::~avtFVCOM_MTMDFileFormat" << endl;

      for (int dom=0; dom<ndoms; ++dom)
      {
        debug4 << "dom: " << dom << endl;
          domainFiles[dom]->FreeUpResources();
          delete domainFiles[dom];
      }
  
      delete fileObject;
  debug4 << "avtFVCOM_MTMDFileFormat::~avtFVCOM_MTMDFileFormat: end" << endl;

}

// ****************************************************************************
//  Method: avtFVCOM_MTMDFileFormat::Init()
//
//  Purpose:  Open files listed in the master file and put then in domainFiles
//
//  Programmer: dstuebe -- generated by xml2avt
//  Creation:   Wed Aug 16 16:40:22 PST 2006
//
//  Modifications:
//    Brad Whitlock, Tue Sep 5 11:59:21 PDT 2006
//    Added code to use the path to the master file to override the paths
//    stored in the master file to support moving the data to other machines.
//
// ****************************************************************************


void
avtFVCOM_MTMDFileFormat::Init()
{
    if(init) return;
    
    
    const char *mName = "avtFVCOM_MTMDFileFormat::Init(): ";
    debug4 << mName << endl;

    ndoms=0;
    nfnames=0;
    ntime=0;
    ntwo=0;
     
    int ncid;
    int status;
    ncid=fileObject->GetFileHandle(); 

    int dom;
    int nfnames_id; 
    status = nc_inq_dimid(ncid, "nfnames", &nfnames_id);
    if (status != NC_NOERR) fileObject-> HandleError(status);
    
    status = nc_inq_dimlen(ncid, nfnames_id, &nfnames);
    if (status != NC_NOERR) fileObject-> HandleError(status);


    int ndoms_id;
    status = nc_inq_dimid(ncid, "ndoms", &ndoms_id);
    if (status != NC_NOERR) fileObject-> HandleError(status);
    
    status = nc_inq_dimlen(ncid, ndoms_id, &ndoms);
    if (status != NC_NOERR) fileObject-> HandleError(status);

    int ntwo_id;
    status = nc_inq_dimid(ncid, "ntwo", &ntwo_id);
    if (status != NC_NOERR) fileObject-> HandleError(status);
    
    status = nc_inq_dimlen(ncid, ntwo_id, &ntwo);
    if (status != NC_NOERR) fileObject-> HandleError(status);


    int ntime_id;
    status = nc_inq_dimid(ncid, "ntime", &ntime_id);
    if (status != NC_NOERR) fileObject-> HandleError(status);
    
    status = nc_inq_dimlen(ncid, ntime_id, &ntime);
    if (status != NC_NOERR) fileObject-> HandleError(status);



    char varname[NC_MAX_NAME+1];
    nc_type vartype;
    int  varndims;
    int  vardims[NC_MAX_VAR_DIMS];
    int  varnatts;
    int  fnamesID;
    status = nc_inq_varid (ncid, "fnames", &fnamesID);
    if (status != NC_NOERR) fileObject-> HandleError(status);
     
    // Now get variable type!
    status = nc_inq_var(ncid, fnamesID, varname, &vartype, &varndims, 
            vardims, &varnatts);
    if (status != NC_NOERR) fileObject-> HandleError(status);
    
    debug4 << mName << varname << endl;

    // Find a directory prefix based on the name of the master file.
    std::string prefix;
    std::string::size_type index = fileObject->GetName().rfind(VISIT_SLASH_STRING);
    if(index != std::string::npos)
    {
        prefix = fileObject->GetName().substr(0, index+1);
    }
    debug4 << mName << "prefix = \"" << prefix << "\"" << endl;

    bool fatalError = false;
    char *domainfilename = new char[nfnames];
    debug4 << mName << "Reading " << ndoms << " filenames." << endl;
    for(dom=0; dom<ndoms; ++dom)
    {

        size_t start[]={dom,0};
        size_t count[]={1, nfnames};
        ptrdiff_t stride[]={1,1};

        status= nc_get_vars_text(ncid,fnamesID,start,count,stride,domainfilename);
        if (status != NC_NOERR) fileObject-> HandleError(status);

#ifdef MDSERVER
        // If we're in the mdserver then only be really picky about the 
        // 1st file since that's the file we use to get metadata.
        if(domainFiles.size() > 0)
        {
            debug4 << mName << "Added " << domainfilename << " to domainFiles."
                   << endl;
            domainFiles.push_back(new avtFVCOMReader(domainfilename));
            continue;
        }
#endif

        // If we can access the raw filename that was stored in the master
        // then we should use it. Unfortunately, a common problem with
        // masters is that they tend to contain the entire path to the domain
        // files
        NETCDFFileObject *fobj = new NETCDFFileObject(domainfilename);
        if(fobj->Open())
        {
            fobj->Close();
            domainFiles.push_back(new avtFVCOMReader(domainfilename, fobj));
            debug4 << mName << "Opened " << domainfilename << endl;
        }
        else
        {
            //
            // The file must have been bad so construct an alternate filename
            // that uses the path to the master file. If that file can't be
            // opened then we have a problem and should probably throw an
            // exception. All of this opening to check the validity of the
            // files in the master can be split among processors if needed
            // later.
            // 
            delete fobj;

            std::string filename(domainfilename);
            index = filename.rfind(VISIT_SLASH_STRING);
            if(index != std::string::npos)
            {
                filename = filename.substr(index+1, filename.size()-1);
            }
            filename = prefix + filename;
            debug4 << mName << "New filename " << filename.c_str() << endl;

            fobj = new NETCDFFileObject(filename.c_str());
            if(fobj->Open())
            {
                fobj->Close();
                domainFiles.push_back(new avtFVCOMReader(filename.c_str(), fobj));
                debug4 << mName << "Opened " << filename.c_str() << endl;
            }
            else
            {
                delete fobj;

                debug4 << mName << "Cannot open " << filename.c_str() << endl;
                fatalError = true;
                break;
            }
        }
    }
    delete [] domainfilename;

    if(fatalError)
    {
        // Clean up the files that we've made sure exist.
        for(int i = 0; i < domainFiles.size(); ++i)
            delete domainFiles[i];
        domainFiles.clear();

        char msg[2000];
        SNPRINTF(msg, 2000,
                 "%s. One or more domain files in the master file cannot be accessed",
                 fileObject->GetName().c_str());
        EXCEPTION1(InvalidFilesException, msg);
    }


    for(dom=0; dom<ndoms; ++dom)
    {
      domainFiles[dom]->SetKeySuffixForCaching(keysuffix);
    }


    // Geo reference Coordinate system stuff
    IsGeoRef=false;
    std::string CoordSys;
    if(fileObject->ReadStringAttribute("CoordinateSystem", CoordSys))
      if (strcmp(CoordSys.c_str(),"GeoReferenced")==0) IsGeoRef=true;


    // Set init equal to true so we don't do this again!
    init = true;
    debug4 << mName << " end" << endl;

}

// ****************************************************************************
//  Method: avtFVCOM_MTMDFileFormat::GetNTimesteps
//
//  Purpose:
//      Tells the rest of the code how many timesteps there are in this file.
//
//  Programmer: dstuebe -- generated by xml2avt
//  Creation:   Wed Aug 16 16:40:22 PST 2006
//
// ****************************************************************************

int
avtFVCOM_MTMDFileFormat::GetNTimesteps(void)
{
  debug4 << "avtFVCOM_MTMDFileFormat::GetNTimesteps" << endl;
    Init();
    return domainFiles[0]->GetNTimesteps();
  debug4 << "avtFVCOM_MTMDFileFormat::GetNTimesteps: end" << endl;

}

// ****************************************************************************
// Method: avtFVCOM_MTMDFileFormat::GetCycles
//
// Purpose: 
//   Returns the time cycle a domain file from avtFVCOMReader.
//
// Arguments:
//   cyc : The times cycle to be returned.
//
// Programmer: David Stuebe
// Creation:   Thu May 18 08:39:01 PDT 2006
//
// Modifications:  Ref to FVCOM Reader class!
//   
// ****************************************************************************

void
avtFVCOM_MTMDFileFormat::GetCycles(std::vector<int> &cycles)
{
    Init();
    domainFiles[0]->GetCycles(cycles);
}


// ****************************************************************************
// Method: avtFVCOM_MTMDFileFormat::GetTimes
//
// Purpose: 
//   Returns the times from a domain file using avtFVCOMReader.
//
// Arguments:
//   t : The times to be returned.
//
// Programmer: David Stuebe
// Creation:   Thu May 18 08:39:01 PDT 2006
//
// Modifications:
//   
// ****************************************************************************


void
avtFVCOM_MTMDFileFormat::GetTimes(std::vector<double> &times)
{
    Init();
    domainFiles[0]->GetTimes(times);
}


// ****************************************************************************
//  Method: avtFVCOM_MTMDFileFormat::FreeUpResources
//
//  Purpose:
//      When VisIt is done focusing on a particular timestep, it asks that
//      timestep to free up any resources (memory, file descriptors) that
//      it has associated with it.  This method is the mechanism for doing
//      that.
//
//  Programmer: dstuebe -- generated by xml2avt
//  Creation:   Wed Aug 16 16:40:22 PST 2006
//
// ****************************************************************************

void
avtFVCOM_MTMDFileFormat::FreeUpResources(void)
{    
  debug4 << "avtFVCOM_MTMDFileFormat::FreeUpResources: turned off!" << endl;


//     for (int dom=0; dom<ndoms; ++dom)
//     {
//       debug4 << "dom: " << dom << endl;
//         domainFiles[dom]->FreeUpResources();
//     }


    debug4 << "avtFVCOM_MTMDFileFormat::FreeUpResources; complete" << endl;

}


// ****************************************************************************
//  Method: avtFVCOM_MTMDFileFormat::PopulateDatabaseMetaData
//
//  Purpose:
//      This database meta-data object is like a table of contents for the
//      file.  By populating it, you are telling the rest of VisIt what
//      information it can request from you.
//
//  Programmer: dstuebe -- generated by xml2avt
//  Creation:   Wed Aug 16 16:40:22 PST 2006
//
//  Modifications:
//    Brad Whitlock, Tue Sep 5 16:59:41 PST 2006
//    Added code to cache data extents.
//
// ****************************************************************************

void
avtFVCOM_MTMDFileFormat::PopulateDatabaseMetaData(avtDatabaseMetaData *md, int timeState)
{
    const char *mName = "avtFVCOM_MTMDFileFormat::PopulateDatabaseMetaData: ";

    debug4 << mName << "timestate= "<< timeState << endl;


    Init();
    // Let domain 0 provide the metadata.
    domainFiles[0]->PopulateDatabaseMetaData(md, timeState, GetType() );
    



    for(int i = 0; i < md->GetNumMeshes(); ++i)
    {
        avtMeshMetaData *mmd = const_cast<avtMeshMetaData*>(md->GetMesh(i));
        mmd->numBlocks = domainFiles.size();
    }


#ifndef MDSERVER
    // If we are not in the MDSERVER Get the spatial and data extents.

    int nts = GetNTimesteps();
    int ndoms = domainFiles.size();


    // Do not try to load extents for IsGeoRef case. It is too complicated for too little benafit. The user must get more info for this to be useful! 

//     float Xi[3];
//     Xi[0]=90.0;
//     Xi[1]=45.0;
//     Xi[2]=300.0;
//     debug4<<"sperical"<< endl;
//     debug4<< "Xi="<<Xi[0]<<","<<Xi[1]<<","<<Xi[2]<<endl;
//     domainFiles[0]->Sphere2Cart(Xi);
//     debug4<<"cartesian"<< endl;
//     debug4<< "Xi="<<Xi[0]<<","<<Xi[1]<<","<<Xi[2]<<endl;
//     if(IsGeoRef)
//       {
//         // 
//         // Let's iterate through all the Meshs and try to cache the spatial extents
//         // for each time steps domains.
        
//         //    debug4 << "GOT HERE1" << endl;
//         int status=1;
//         TypeEnum lon_t = NO_TYPE;
//         int lon_ndims = 0, *lon_dims = 0;
//         void *lon_values = 0;
        
//         TypeEnum lat_t = NO_TYPE;
//         int lat_ndims = 0, *lat_dims = 0;
//         void *lat_values = 0;
        
//         TypeEnum h_t = NO_TYPE;
//         int h_ndims = 0, *h_dims = 0;
//         void *h_values = 0;
        
//         TypeEnum zeta_t = NO_TYPE;
//         int zeta_ndims = 0, *zeta_dims = 0;
//         void *zeta_values = 0;
        
//         status *= fileObject->ReadVariable("lon_ext", &lon_t, &lon_ndims, 
//                                            &lon_dims, &lon_values);
//         if (lon_t != FLOATARRAY_TYPE) status=0;
        
//         status *= fileObject->ReadVariable("lat_ext", &lat_t, &lat_ndims, 
//                                            &lat_dims, &lat_values);
//         if (lat_t != FLOATARRAY_TYPE) status=0;
        
//         status *= fileObject->ReadVariable("h_ext", &h_t, &h_ndims, 
//                                            &h_dims, &h_values);
//         if (h_t != FLOATARRAY_TYPE) status=0;
        
//         status *= fileObject->ReadVariable("zeta_ext", &zeta_t, 
//                                            &zeta_ndims, &zeta_dims, &zeta_values);
//         if (zeta_t != FLOATARRAY_TYPE) status=0;
        
//         //    debug4 << "GOT HERE2" << endl;
        
        
        
//         if (status == 1)
//           {
//             debug4 << mName << "Makeing pointers to spatial extents variables" << endl;
//             float *lon_fptr = (float *)lon_values;
//             float *lat_fptr = (float *)lat_values;
//             float *h_fptr = (float *)h_values;
//             //float *zeta_fptr = (float *)zeta_values;
//             //        debug4 << "GOT HERE3" << endl;
            
//             float x_min[ndoms];
//             float x_max=[ndoms];

//             float y_min[ndoms];
//             float y_max=[ndoms];
            

//             // do some work to re arrange the min and max values for 
//             // sphereical coordinates
//             float a,b;
              
//             for (int j = 0; j < ndoms; j++)
//               {
//                 //if 180 should be the min, find the max
//                 if (lon_fptr[j*2+1]<180 && lon_fptr[j+2]>180)
//                   {
//                     a=cos(lon_fptr[j*2]);
//                     b=cos(lon_fptr[j*2+1]);
//                     // take the value with the max cosine
//                     lon_fptr[j*2]= (a>b) ? lon_fptr[j*2] : lon_fptr[j*2+1];

//                     lon_fptr[j*2+1]=180; // min becomes 180
//                   }
//                 // if the max is less than 180 just switch the values
//                 else if (lon_fptr[j+2]<180)
//                   {
//                     a= lon_fptr[j+2];
//                     b=lon_fptr[j+2+1];
//                     lon_fptr[j+2]=b;
//                     lon_fptr[j+2+1]=a;
//                   }
//                 else if (lon_fptr[j+2+1]>180)
//                   {
//                     // do nothing
//                   }  
//                 else
//                   {
//                     debug4<< "Very bad! lon_min= "<< lon_fptr[j+2+1] <<
//                       "lon_max= "<< lon_fptr[j+2] << endl;
//                   }

//                 //if the min <90 and max >90
//                 if (lat_fptr[j*2+1]<90 && lat_fptr[j+2]>90)
//                   {
//                     // if max >270
//                     if(lat_fptr[j+2]>270)
//                       {
//                         lat_fptr[j*2+1]=270;
//                         lat_fptr[j+2]=90;
//                       }

//                     a=sin(lat_fptr[j*2]); // sin of max
//                     b=sin(lat_fptr[j*2+1]); // sin of min
//                     // take the value with the min sine
//                     lat_fptr[j*2+1]= (a<b) ? lat_fptr[j*2] : lat_fptr[j*2+1];

//                     lon_fptr[j*2]=90; // max becomes 90
//                   }
//                 // if the max <90 do nothing
//                 else if (lat_fptr[j+2]<90)
//                   {

//                   }
//                 // if the min >90 switch the values
//                 else if (lat_fptr[j+2+1]>90)
//                   {
//                     // do nothing
//                   }  
//                 else
//                   {
//                     debug4<< "Very bad! lon_min= "<< lon_fptr[j+2+1] <<
//                       "lon_max= "<< lon_fptr[j+2] << endl;
//                   }





//             for(int i = 0; i < md->GetNumMeshes(); ++i)
//               { 
//                 avtMeshMetaData *mmd = const_cast<avtMeshMetaData*>(md->GetMesh(i));
//                 std::string MeshName(mmd->name);
//                 //mmd->numBlocks = domainFiles.size();
                
                
//                 double  extents[6];
//                 if(MeshName == "Bathymetry_Mesh")
//                   {
//                     debug4 << mName << "Adding Bathymetry_Mesh spatial extents" << endl;
//                     avtIntervalTree *itree = new avtIntervalTree(ndoms, 3);
                    
//                     for (int j = 0; j < ndoms; j++)
//                       {

                        


//                         extents[0] = x_fptr[j*2+1]; // min
//                         extents[1] = x_fptr[j*2]; // max
                        
//                         extents[2] = y_fptr[j*2+1];
//                         extents[3] = y_fptr[j*2];
                        
//                         // Watch the negative sign on h!!!
//                         extents[4] = -h_fptr[j*2];
//                         extents[5] = -h_fptr[j*2+1];
//                         itree->AddElement(j, extents);
//                         //1.5.3                    itree->AddDomain(j, extents);
                        
//                         debug5 << "\tdomain[" << j << "] = X{"
//                                << extents[0] << ", " << extents[1] << "}" << endl;
//                         debug5 << "\tdomain[" << j << "] = Y{"
//                                << extents[2] << ", " << extents[3] << "}" << endl;
//                         debug5 << "\tdomain[" << j << "] = Z{"
//                                << extents[4] << ", " << extents[5] << "}" << endl;
//                       }
//                     itree->Calculate(true);
//                     // Cache the extents for all doms and all ts.
//                     void_ref_ptr vr = void_ref_ptr(itree, avtIntervalTree::Destruct);
//                     cache->CacheVoidRef(MeshName.c_str(), AUXILIARY_DATA_SPATIAL_EXTENTS, 
//                                         -1, -1, vr);
//                     debug4 << mName << "Cached spatial extents for " << MeshName << endl;
//                   } // END Bathymetry Mesh spatial extents
//                 else if(MeshName == "TWOD_Mesh")
//                   {
//                     debug4 << mName << "Adding TWOD_Mesh spatial extents" << endl;
//                 avtIntervalTree *itree = new avtIntervalTree(ndoms, 3);
                
//                 for (int j = 0; j < ndoms; j++)
//                   {
//                     extents[0] = x_fptr[j*2+1];
//                     extents[1] = x_fptr[j*2];
                    
//                     extents[2] = y_fptr[j*2+1];
//                     extents[3] = y_fptr[j*2];
                    
//                     // USE DUMMY VALUES FOR TWOD MESH
//                     extents[4] = -1;
//                     extents[5] = 1;
//                     itree->AddElement(j, extents);
//                     //1.5.3                    itree->AddDomain(j, extents);
                    
//                     debug5 << "\tdomain[" << j << "] = X{"
//                            << extents[0] << ", " << extents[1] << "}" << endl;
//                     debug5 << "\tdomain[" << j << "] = Y{"
//                            << extents[2] << ", " << extents[3] << "}" << endl;
//                     debug5 << "\tdomain[" << j << "] = Z{"
//                            << extents[4] << ", " << extents[5] << "}" << endl;
//                   }
//                 itree->Calculate(true);
//                 // Cache the extents for all doms and all ts.
//                 void_ref_ptr vr = void_ref_ptr(itree, avtIntervalTree::Destruct);
//                 cache->CacheVoidRef(MeshName.c_str(), AUXILIARY_DATA_SPATIAL_EXTENTS, 
//                                     -1, -1, vr);
//                 debug4 << mName << "Cached spatial extents for " << MeshName << endl;
//                   } // END TWOD Mesh spatial extents
                
//                 else if(MeshName == "SSH_Mesh")
//                   {
//                     debug4 << mName << "Adding SSH_Mesh spatial extents" << endl;
                    
//                     float *zeta_fptr = (float *)zeta_values;
//                     for (int t = 0; t < nts; t++)
//                       {
//                         debug4 << "Spatial Extents for: " << MeshName <<
//                           ": ts = " << t << endl;
                        
//                         avtIntervalTree *itree = new avtIntervalTree(ndoms, 3);
                        
//                         for (int j = 0; j < ndoms; j++)
//                     {
//                       extents[0] = x_fptr[j*2+1];
//                       extents[1] = x_fptr[j*2];
                      
//                       extents[2] = y_fptr[j*2+1];
//                       extents[3] = y_fptr[j*2];
                        
//                       extents[4] = zeta_fptr[j*2+1];
//                       extents[5] = zeta_fptr[j*2];
                      
//                       itree->AddElement(j, extents);
//                       //1.5.3                        itree->AddDomain(j, extents);
                      
//                       debug5 << "\tdomain[" << j << "] = X{"
//                              << extents[0] << ", " << extents[1] << "}" << endl;
//                       debug5 << "\tdomain[" << j << "] = Y{"
//                              << extents[2] << ", " << extents[3] << "}" << endl;
//                       debug5 << "\tdomain[" << j << "] = Z{"
//                              << extents[4] << ", " << extents[5] << "}" << endl;
//                     }
//                         itree->Calculate(true);
//                         // Cache the extents for all doms and all ts.
//                         void_ref_ptr vr = void_ref_ptr(itree, avtIntervalTree::Destruct);
//                         cache->CacheVoidRef(MeshName.c_str(), AUXILIARY_DATA_SPATIAL_EXTENTS,
//                                             t, -1, vr);
//                         debug4 << mName << "Cached spatial extents for " << MeshName << endl;
                        
//                         // Advance zeta_fptr to the next time step!
//                         zeta_fptr += (ndoms * 2);
                        
//                       }
//                     //delete [] zeta_fptr;                
//                   }  // end SSH MESH   spatial extents
                

//                 else if(MeshName == "SigmaLayer_Mesh")
//                   {
//                     debug4 << mName << "Adding SigmaLayer_Mesh spatial extents" << endl;
                    
//                     float *zeta_fptr = (float *)zeta_values;
//                     for (int t = 0; t < nts; t++)
//                       {
//                         debug4 << "Spatial Extents for: " << MeshName <<
//                           ": ts = " << t << endl;
                        
//                         avtIntervalTree *itree = new avtIntervalTree(ndoms, 3);
                        
//                         for (int j = 0; j < ndoms; j++)
//                           {
//                             extents[0] = x_fptr[j*2+1];
//                             extents[1] = x_fptr[j*2];
                            
//                             extents[2] = y_fptr[j*2+1];
//                             extents[3] = y_fptr[j*2];
                            
//                             // for sigma layer mesh: use zeta to get ssh
//                             //                       use -h to get bathymetry
//                             // Watch the sign of H!!!
//                             extents[4] = -h_fptr[j*2];
//                             extents[5] = zeta_fptr[j*2];

//                             itree->AddElement(j, extents);
//                             //1.5.3                        itree->AddDomain(j, extents);
                            
//                             debug5 << "\tdomain[" << j << "] = X{"
//                                    << extents[0] << ", " << extents[1] << "}" << endl;
//                             debug5 << "\tdomain[" << j << "] = Y{"
//                                    << extents[2] << ", " << extents[3] << "}" << endl;
//                             debug5 << "\tdomain[" << j << "] = Z{"
//                                    << extents[4] << ", " << extents[5] << "}" << endl;
//                           }
//                         itree->Calculate(true);
//                         // Cache the extents for all doms and all ts.
//                         void_ref_ptr vr = void_ref_ptr(itree, avtIntervalTree::Destruct);
//                         cache->CacheVoidRef(MeshName.c_str(), AUXILIARY_DATA_SPATIAL_EXTENTS, 
//                                             t, -1, vr);
//                         debug4 << mName << "Cached spatial extents for " << MeshName << endl;
                        
//                         // Advance zeta_fptr to the next time step!
//                         zeta_fptr += (ndoms * 2);
                        
//                       }
//                     //delete [] zeta_fptr;                
//                   }  // end SigmaLayer MESH   spatial extents
//                 else if(MeshName == "SigmaLevel_Mesh")
//                   {
//                 debug4 << mName << "Adding SigmaLevel_Mesh spatial extents" << endl;
                
//                 float *zeta_fptr = (float *)zeta_values;
//                 for (int t = 0; t < nts; t++)
//                   {
//                     debug4 << "Spatial Extents for: " << MeshName <<
//                       ": ts = " << t << endl;
                    
//                     avtIntervalTree *itree = new avtIntervalTree(ndoms, 3);
                    
//                     for (int j = 0; j < ndoms; j++)
//                       {
//                         extents[0] = x_fptr[j*2+1];
//                         extents[1] = x_fptr[j*2];
                        
//                         extents[2] = y_fptr[j*2+1];
//                         extents[3] = y_fptr[j*2];
                        
//                         // for sigma layer mesh: use zeta to get ssh
//                         //                       use h to get bathymetry
//                         extents[4] = -h_fptr[j*2];
//                         extents[5] = zeta_fptr[j*2];
//                         itree->AddElement(j, extents);
//                         //1.5.3                        itree->AddDomain(j, extents);
                        
//                         debug5 << "\tdomain[" << j << "] = X{"
//                                << extents[0] << ", " << extents[1] << "}" << endl;
//                         debug5 << "\tdomain[" << j << "] = Y{"
//                                << extents[2] << ", " << extents[3] << "}" << endl;
//                         debug5 << "\tdomain[" << j << "] = Z{"
//                                << extents[4] << ", " << extents[5] << "}" << endl;
//                       }
//                     itree->Calculate(true);
//                     // Cache the extents for all doms and all ts.
//                     void_ref_ptr vr = void_ref_ptr(itree, avtIntervalTree::Destruct);
//                     cache->CacheVoidRef(MeshName.c_str(), AUXILIARY_DATA_SPATIAL_EXTENTS, 
//                                         t, -1, vr);
//                     debug4 << mName << "Cached spatial extents for " << MeshName << endl;
                    
//                     // Advance zeta_fptr to the next time step!
//                     zeta_fptr += (ndoms * 2);
                    
//                   } // end time for loop
                
//                   }  // end SigmaLevel MESH   spatial extents
                
//               } // end for # of meshs 
            
//           } // end if got spatial extent data!
        
//         delete [] x_dims;
//         delete [] y_dims;
//         delete [] h_dims;
//         delete [] zeta_dims;
        
//         // free mem: ( varname, type)
//         free_void_mem(x_values, x_t);
        
//         free_void_mem(y_values, y_t);
        
//         free_void_mem(h_values, h_t);
        
//         free_void_mem(zeta_values, zeta_t);
        
        
//       } // End If (IsGeoRef)    
    if(!IsGeoRef)
      {
        // 
        // Let's iterate through all the Meshs and try to cache the spatial extents
        // for each time steps domains.
        
        //    debug4 << "GOT HERE1" << endl;
        int status=1;
        TypeEnum x_t = NO_TYPE;
        int x_ndims = 0, *x_dims = 0;
        void *x_values = 0;
        
        TypeEnum y_t = NO_TYPE;
        int y_ndims = 0, *y_dims = 0;
        void *y_values = 0;
        
        TypeEnum h_t = NO_TYPE;
        int h_ndims = 0, *h_dims = 0;
        void *h_values = 0;
        
        TypeEnum zeta_t = NO_TYPE;
        int zeta_ndims = 0, *zeta_dims = 0;
        void *zeta_values = 0;
        
        status *= fileObject->ReadVariable("x_ext", &x_t, &x_ndims, &x_dims, &x_values);
        if (x_t != FLOATARRAY_TYPE) status=0;
        
        status *= fileObject->ReadVariable("y_ext", &y_t, &y_ndims, &y_dims, &y_values);
        if (y_t != FLOATARRAY_TYPE) status=0;
        
        status *= fileObject->ReadVariable("h_ext", &h_t, &h_ndims, &h_dims, &h_values);
        if (h_t != FLOATARRAY_TYPE) status=0;
        
        status *= fileObject->ReadVariable("zeta_ext", &zeta_t, &zeta_ndims, &zeta_dims,
                                           &zeta_values);
        if (zeta_t != FLOATARRAY_TYPE) status=0;
        
        //    debug4 << "GOT HERE2" << endl;
        
        
        
        if (status == 1)
          {
            debug4 << mName << "Makeing pointers to spatial extents variables" << endl;
            float *x_fptr = (float *)x_values;
            float *y_fptr = (float *)y_values;
            float *h_fptr = (float *)h_values;
            //float *zeta_fptr = (float *)zeta_values;
            //        debug4 << "GOT HERE3" << endl;
            
            for(int i = 0; i < md->GetNumMeshes(); ++i)
              { 
                avtMeshMetaData *mmd = const_cast<avtMeshMetaData*>(md->GetMesh(i));
                std::string MeshName(mmd->name);
                //mmd->numBlocks = domainFiles.size();
                
                
                double  extents[6];
                if(MeshName == "Bathymetry_Mesh")
                  {
                    debug4 << mName << "Adding Bathymetry_Mesh spatial extents" << endl;
                    avtIntervalTree *itree = new avtIntervalTree(ndoms, 3);
                    
                    for (int j = 0; j < ndoms; j++)
                      {
                        extents[0] = x_fptr[j*2+1];
                        extents[1] = x_fptr[j*2];
                        
                        extents[2] = y_fptr[j*2+1];
                        extents[3] = y_fptr[j*2];
                        
                        // Watch the negative sign on h!!!
                        extents[4] = -h_fptr[j*2];
                        extents[5] = -h_fptr[j*2+1];
                        itree->AddElement(j, extents);
                        //1.5.3                    itree->AddDomain(j, extents);
                        
                        debug5 << "\tdomain[" << j << "] = X{"
                               << extents[0] << ", " << extents[1] << "}" << endl;
                        debug5 << "\tdomain[" << j << "] = Y{"
                               << extents[2] << ", " << extents[3] << "}" << endl;
                        debug5 << "\tdomain[" << j << "] = Z{"
                               << extents[4] << ", " << extents[5] << "}" << endl;
                      }
                    itree->Calculate(true);
                    // Cache the extents for all doms and all ts.
                    void_ref_ptr vr = void_ref_ptr(itree, avtIntervalTree::Destruct);
                    cache->CacheVoidRef(MeshName.c_str(), AUXILIARY_DATA_SPATIAL_EXTENTS, 
                                        -1, -1, vr);
                    debug4 << mName << "Cached spatial extents for " << MeshName << endl;
                  } // END Bathymetry Mesh spatial extents
                else if(MeshName == "TWOD_Mesh")
                  {
                    debug4 << mName << "Adding TWOD_Mesh spatial extents" << endl;
                avtIntervalTree *itree = new avtIntervalTree(ndoms, 3);
                
                for (int j = 0; j < ndoms; j++)
                  {
                    extents[0] = x_fptr[j*2+1];
                    extents[1] = x_fptr[j*2];
                    
                    extents[2] = y_fptr[j*2+1];
                    extents[3] = y_fptr[j*2];
                    
                    // USE DUMMY VALUES FOR TWOD MESH
                    extents[4] = -1;
                    extents[5] = 1;
                    itree->AddElement(j, extents);
                    //1.5.3                    itree->AddDomain(j, extents);
                    
                    debug5 << "\tdomain[" << j << "] = X{"
                           << extents[0] << ", " << extents[1] << "}" << endl;
                    debug5 << "\tdomain[" << j << "] = Y{"
                           << extents[2] << ", " << extents[3] << "}" << endl;
                    debug5 << "\tdomain[" << j << "] = Z{"
                           << extents[4] << ", " << extents[5] << "}" << endl;
                  }
                itree->Calculate(true);
                // Cache the extents for all doms and all ts.
                void_ref_ptr vr = void_ref_ptr(itree, avtIntervalTree::Destruct);
                cache->CacheVoidRef(MeshName.c_str(), AUXILIARY_DATA_SPATIAL_EXTENTS, 
                                    -1, -1, vr);
                debug4 << mName << "Cached spatial extents for " << MeshName << endl;
                  } // END TWOD Mesh spatial extents
                
                else if(MeshName == "SSH_Mesh")
                  {
                    debug4 << mName << "Adding SSH_Mesh spatial extents" << endl;
                    
                    float *zeta_fptr = (float *)zeta_values;
                    for (int t = 0; t < nts; t++)
                      {
                        debug4 << "Spatial Extents for: " << MeshName <<
                          ": ts = " << t << endl;
                        
                        avtIntervalTree *itree = new avtIntervalTree(ndoms, 3);
                        
                        for (int j = 0; j < ndoms; j++)
                    {
                      extents[0] = x_fptr[j*2+1];
                      extents[1] = x_fptr[j*2];
                      
                      extents[2] = y_fptr[j*2+1];
                      extents[3] = y_fptr[j*2];
                        
                      extents[4] = zeta_fptr[j*2+1];
                      extents[5] = zeta_fptr[j*2];
                      
                      itree->AddElement(j, extents);
                      //1.5.3                        itree->AddDomain(j, extents);
                      
                      debug5 << "\tdomain[" << j << "] = X{"
                             << extents[0] << ", " << extents[1] << "}" << endl;
                      debug5 << "\tdomain[" << j << "] = Y{"
                             << extents[2] << ", " << extents[3] << "}" << endl;
                      debug5 << "\tdomain[" << j << "] = Z{"
                             << extents[4] << ", " << extents[5] << "}" << endl;
                    }
                        itree->Calculate(true);
                        // Cache the extents for all doms and all ts.
                        void_ref_ptr vr = void_ref_ptr(itree, avtIntervalTree::Destruct);
                        cache->CacheVoidRef(MeshName.c_str(), AUXILIARY_DATA_SPATIAL_EXTENTS,
                                            t, -1, vr);
                        debug4 << mName << "Cached spatial extents for " << MeshName << endl;
                        
                        // Advance zeta_fptr to the next time step!
                        zeta_fptr += (ndoms * 2);
                        
                      }
                    //delete [] zeta_fptr;                
                  }  // end SSH MESH   spatial extents
                

                else if(MeshName == "SigmaLayer_Mesh")
                  {
                    debug4 << mName << "Adding SigmaLayer_Mesh spatial extents" << endl;
                    
                    float *zeta_fptr = (float *)zeta_values;
                    for (int t = 0; t < nts; t++)
                      {
                        debug4 << "Spatial Extents for: " << MeshName <<
                          ": ts = " << t << endl;
                        
                        avtIntervalTree *itree = new avtIntervalTree(ndoms, 3);
                        
                        for (int j = 0; j < ndoms; j++)
                          {
                            extents[0] = x_fptr[j*2+1];
                            extents[1] = x_fptr[j*2];
                            
                            extents[2] = y_fptr[j*2+1];
                            extents[3] = y_fptr[j*2];
                            
                            // for sigma layer mesh: use zeta to get ssh
                            //                       use -h to get bathymetry
                            // Watch the sign of H!!!
                            extents[4] = -h_fptr[j*2];
                            extents[5] = zeta_fptr[j*2];

                            itree->AddElement(j, extents);
                            //1.5.3                        itree->AddDomain(j, extents);
                            
                            debug5 << "\tdomain[" << j << "] = X{"
                                   << extents[0] << ", " << extents[1] << "}" << endl;
                            debug5 << "\tdomain[" << j << "] = Y{"
                                   << extents[2] << ", " << extents[3] << "}" << endl;
                            debug5 << "\tdomain[" << j << "] = Z{"
                                   << extents[4] << ", " << extents[5] << "}" << endl;
                          }
                        itree->Calculate(true);
                        // Cache the extents for all doms and all ts.
                        void_ref_ptr vr = void_ref_ptr(itree, avtIntervalTree::Destruct);
                        cache->CacheVoidRef(MeshName.c_str(), AUXILIARY_DATA_SPATIAL_EXTENTS, 
                                            t, -1, vr);
                        debug4 << mName << "Cached spatial extents for " << MeshName << endl;
                        
                        // Advance zeta_fptr to the next time step!
                        zeta_fptr += (ndoms * 2);
                        
                      }
                    //delete [] zeta_fptr;                
                  }  // end SigmaLayer MESH   spatial extents
                else if(MeshName == "SigmaLevel_Mesh")
                  {
                debug4 << mName << "Adding SigmaLevel_Mesh spatial extents" << endl;
                
                float *zeta_fptr = (float *)zeta_values;
                for (int t = 0; t < nts; t++)
                  {
                    debug4 << "Spatial Extents for: " << MeshName <<
                      ": ts = " << t << endl;
                    
                    avtIntervalTree *itree = new avtIntervalTree(ndoms, 3);
                    
                    for (int j = 0; j < ndoms; j++)
                      {
                        extents[0] = x_fptr[j*2+1];
                        extents[1] = x_fptr[j*2];
                        
                        extents[2] = y_fptr[j*2+1];
                        extents[3] = y_fptr[j*2];
                        
                        // for sigma layer mesh: use zeta to get ssh
                        //                       use h to get bathymetry
                        extents[4] = -h_fptr[j*2];
                        extents[5] = zeta_fptr[j*2];
                        itree->AddElement(j, extents);
                        //1.5.3                        itree->AddDomain(j, extents);
                        
                        debug5 << "\tdomain[" << j << "] = X{"
                               << extents[0] << ", " << extents[1] << "}" << endl;
                        debug5 << "\tdomain[" << j << "] = Y{"
                               << extents[2] << ", " << extents[3] << "}" << endl;
                        debug5 << "\tdomain[" << j << "] = Z{"
                               << extents[4] << ", " << extents[5] << "}" << endl;
                      }
                    itree->Calculate(true);
                    // Cache the extents for all doms and all ts.
                    void_ref_ptr vr = void_ref_ptr(itree, avtIntervalTree::Destruct);
                    cache->CacheVoidRef(MeshName.c_str(), AUXILIARY_DATA_SPATIAL_EXTENTS, 
                                        t, -1, vr);
                    debug4 << mName << "Cached spatial extents for " << MeshName << endl;
                    
                    // Advance zeta_fptr to the next time step!
                    zeta_fptr += (ndoms * 2);
                    
                  } // end time for loop
                
                  }  // end SigmaLevel MESH   spatial extents
                
              } // end for # of meshs 
            
          } // end if got spatial extent data!
        
        delete [] x_dims;
        delete [] y_dims;
        delete [] h_dims;
        delete [] zeta_dims;
        
        // free mem: ( varname, type)
        free_void_mem(x_values, x_t);
        
        free_void_mem(y_values, y_t);
        
        free_void_mem(h_values, h_t);
        
        free_void_mem(zeta_values, zeta_t);
        
        
      } // End If (!IsGeoRef)
    
    //
    // Let's iterate through all of the scalars and try to cache data extents
    // for each time step's domains. We do this here as opposed to doing it
    // inside of the GetAuxiliaryData method because GetAuxiliaryData does not
    // get called for MTMD when requesting data for all domains.
    //

    for(int i = 0; i < md->GetNumScalars(); ++i)
    {
        const avtScalarMetaData *smd = md->GetScalar(i);
        std::string extName(smd->name);
        extName += "_ext";

        TypeEnum t = NO_TYPE;
        int ndims = 0, *dims = 0;
        void *values = 0;
        if(fileObject->ReadVariable(extName.c_str(), &t, &ndims, &dims, &values))
        {
            if(t == FLOATARRAY_TYPE)
            {
                float *fptr = (float *)values;
                int thisSize = 1;
                debug4 << mName << extName.c_str() << " dims = {";
                for(int j = 0; j < ndims; ++j)
                {
                    thisSize *= dims[j];
                    debug4 << ", " << dims[j];
                }
                debug4 << "}\n";

                // We have time-varying extents.
                if(thisSize == nts * ndoms * 2)
                {
                    for(int t = 0; t < nts; ++t)
                    {
                        avtIntervalTree *itree = new avtIntervalTree(ndoms, 1);
                        debug5 << mName << "Data extents for " << smd->name.c_str()
                               << " at ts=" << t << ": " << endl;
                        for (int j = 0; j < ndoms; j++)
                        {
                            double range[2];
                            range[0] = fptr[j*2+1];
                            range[1] = fptr[j*2];
                            itree->AddElement(j, range);
//1.5.3                            itree->AddDomain(j, range);

                            debug5 << "\tdomain[" << j << "] = {"
                                   << range[0] << ", " << range[1] << "}" << endl;
                        }
                        itree->Calculate(true);

                        // Cache the extents for all doms in this ts.
                        void_ref_ptr vr = void_ref_ptr(itree, avtIntervalTree::Destruct);
                        cache->CacheVoidRef(smd->name.c_str(),
                            AUXILIARY_DATA_DATA_EXTENTS, t, -1, vr);
                        debug4 << mName << "Cache data extents for " << smd->name.c_str()
                               << " at ts=" << t << endl;

                        fptr += (ndoms * 2);
                    }
                }
                // We have extents that we should use for all time steps.
                else if(thisSize == ndoms * 2)
                {
                    avtIntervalTree *itree = new avtIntervalTree(ndoms, 1);
                    debug5 << mName << "Data extents for " << smd->name.c_str()
                           << ": " << endl;
                    for (int j = 0; j < ndoms; j++)
                    {
                        double range[2];
                        range[0] = fptr[j*2+1];
                        range[1] = fptr[j*2];
                        itree->AddElement(j, range);
//1.5.3                        itree->AddDomain(j, range);

                        debug5 << "\tdomain[" << j << "] = {"
                               << range[0] << ", " << range[1] << "}" << endl;
                    }
                    itree->Calculate(true);

                    // Cache the extents for all doms and all ts.
                    void_ref_ptr vr = void_ref_ptr(itree, avtIntervalTree::Destruct);
                    cache->CacheVoidRef(smd->name.c_str(),
                        AUXILIARY_DATA_DATA_EXTENTS, -1, -1, vr);
                    debug4 << mName << "Cache data extents for " << smd->name.c_str()
                           << " all times." << endl;
                }

            }

            delete [] dims;
            free_void_mem(values, t);
        }
    }

    // Figure out spatial extents for domains in each mesh and cache the metadata
    // on a per-mesh basis.
#endif
}


// ****************************************************************************
//  Method: avtFVCOM_MTMDFileFormat::GetAuxiliaryData
//
//  Purpose:
//      Gets auxiliary data, data and spatial extents.
//
//  Programmer: David Stuebe
//  Creation:   September 1, 2006
//
//  Modifications:
//
// ****************************************************************************

void *
avtFVCOM_MTMDFileFormat::GetAuxiliaryData(const char *var, int timestate,
                                   int domain, const char *type, void *args,
                                   DestructorFunction &df)
{
    const char *mName = "avtFVCOM_MTMD::GetAuxiliaryData: ";
    void *rv = NULL;
 
    debug4 << mName << endl;
    debug4 << "Type= " << type << endl;
    debug4 << "var= " << var << endl;
    debug4 << "Timestate= " << timestate << endl;
    debug4 << "Domain= " << domain << endl;

    // Data extents are already cached but we can still call GetAuxiliaryData
    // on the reader for materials.
    rv = domainFiles[domain]->GetAuxiliaryData(var, timestate, type, args, df);   

    debug4 << mName << "end" << endl;
    
    return rv;
}


// ****************************************************************************
//  Method: avtFVCOM_MTMDFileFormat::GetMesh
//
//  Purpose:
//      Gets the mesh associated with this file.  The mesh is returned as a
//      derived type of vtkDataSet (ie vtkRectilinearGrid, vtkStructuredGrid,
//      vtkUnstructuredGrid, etc).
//
//  Arguments:
//      timestate   The index of the timestate.  If GetNTimesteps returned
//                  'N' time steps, this is guaranteed to be between 0 and N-1.
//      domain      The index of the domain.  If there are NDomains, this
//                  value is guaranteed to be between 0 and NDomains-1,
//                  regardless of block origin.
//      meshname    The name of the mesh of interest.  This can be ignored if
//                  there is only one mesh.
//
//  Programmer: dstuebe -- generated by xml2avt
//  Creation:   Wed Aug 16 16:40:22 PST 2006
//
// ****************************************************************************

vtkDataSet *
avtFVCOM_MTMDFileFormat::GetMesh(int timestate, int domain, const char *meshname)
{
    const char *mName = "avtFVCOM_MTMD::GetMesh: ";
    debug4 << mName << "timestate= "<< timestate << "; domain= " << domain <<
      "; meshname= " << meshname << endl;

    Init();
    
    // Let the avtFVCOMFileFormat object know which value to use for domain
    // when it needs to cache something.
    domainFiles[domain]->SetDomainIndexForCaching(domain);
    
    // Call the domain'th MTSD reader object to get its data for the desired
    // domain at the desired time step.
    vtkDataSet *retval = domainFiles[domain]->GetMesh(timestate, meshname, cache);


    debug4 << mName << "Got mesh: try to add Ghost Zones" << endl;
    // ADD GHOST ZONES!
    int nCells = retval->GetNumberOfCells();
    int *blanks = new int[nCells];


    int *helems = new int[ndoms];
    int *telems = new int[ndoms];
    bool have_h, have_t;
    have_h=fileObject->ReadVariableInto("Halos_Elems", INTEGERARRAY_TYPE, helems);
    have_t=fileObject->ReadVariableInto("Total_Elems", INTEGERARRAY_TYPE, telems);
    
    if(have_h && have_t)
    {
      
        if (nCells == telems[domain])
        {
            for (int i = 0 ; i < nCells ; i++)
            {
                blanks[i]=0;
                if ( i < (nCells - helems[domain]) ) 
                { 
                    blanks[i]=1;
                }
            }
        }
        else
        {
            int nl = nCells/telems[domain];

            int count;
            for (int j = 0 ; j < nl ; j++)
            {
                for (int i = 0 ; i < telems[domain] ; i++)
                {
                  count = j * telems[domain]+i;
                    blanks[count]=0;
                    if ( i < (telems[domain] - helems[domain]) ) 
                    { 
                        blanks[count]=1;
                    }
                }
            }
        }


        unsigned char RealVal=0, ghost=1;
    
        avtGhostData::AddGhostZoneType(ghost,DUPLICATED_ZONE_INTERNAL_TO_PROBLEM);
        vtkUnsignedCharArray *ghostCells= vtkUnsignedCharArray::New();



        ghostCells->SetName("avtGhostZones");
        ghostCells->Allocate(nCells);


        for (int i = 0 ; i < nCells ; i++)
        {
            if(blanks[i])
                ghostCells->InsertNextValue(RealVal);
            else
                ghostCells->InsertNextValue(ghost);
        }
    
        retval->GetCellData()->AddArray(ghostCells);
        ghostCells->Delete();
        debug4 << mName << "Found Ghost Zones" << endl;


    }
    else
    {
        debug4 << "Reading Halos_Elems or reading Total_Elems failed "
                  "so no ghost zones will be added." << endl;
    }

    delete [] blanks;
    delete [] helems;
    delete [] telems;

    debug4 << mName << "end"<< endl;

    return  retval;
}


// ****************************************************************************
//  Method: avtFVCOM_MTMDFileFormat::GetVar
//
//  Purpose:
//      Gets a scalar variable associated with this file.  Although VTK has
//      support for many different types, the best bet is vtkFloatArray, since
//      that is supported everywhere through VisIt.
//
//  Arguments:
//      timestate  The index of the timestate.  If GetNTimesteps returned
//                 'N' time steps, this is guaranteed to be between 0 and N-1.
//      domain     The index of the domain.  If there are NDomains, this
//                 value is guaranteed to be between 0 and NDomains-1,
//                 regardless of block origin.
//      varname    The name of the variable requested.
//
//  Programmer: dstuebe -- generated by xml2avt
//  Creation:   Wed Aug 16 16:40:22 PST 2006
//
// ****************************************************************************

vtkDataArray *
avtFVCOM_MTMDFileFormat::GetVar(int timestate, int domain, const char *varname)
{
    
    const char *mName = "avtFVCOM_MTMD::GetVar: ";
    debug4 << mName << "timestate= "<< timestate << "; domain= " << domain <<
      "; varname= " << varname << endl;

    Init();
    
    // Let the avtFVCOMFileFormat object know which value to use for domain
    // when it needs to cache something.
    domainFiles[domain]->SetDomainIndexForCaching(domain);
    
    // Call the domain'th MTSD reader object to get its data for the desired
    // domain at the desired time step.
    return domainFiles[domain]->GetVar(timestate, varname, cache);
}


// ****************************************************************************
//  Method: avtFVCOM_MTMDFileFormat::GetVectorVar
//
//  Purpose:
//      Gets a vector variable associated with this file.  Although VTK has
//      support for many different types, the best bet is vtkFloatArray, since
//      that is supported everywhere through VisIt.
//
//  Arguments:
//      timestate  The index of the timestate.  If GetNTimesteps returned
//                 'N' time steps, this is guaranteed to be between 0 and N-1.
//      domain     The index of the domain.  If there are NDomains, this
//                 value is guaranteed to be between 0 and NDomains-1,
//                 regardless of block origin.
//      varname    The name of the variable requested.
//
//  Programmer: dstuebe -- generated by xml2avt
//  Creation:   Wed Aug 16 16:40:22 PST 2006
//
// ****************************************************************************

vtkDataArray *
avtFVCOM_MTMDFileFormat::GetVectorVar(int timestate, int domain,const char *varname)
{

    const char *mName = "avtFVCOM_MTMD::GetVectorVar: ";
    debug4 << mName << "timestate= "<< timestate << "; domain= " << domain <<
      "; varname= " << varname << endl;

    Init();


    // Let the avtFVCOMFileFormat object know which value to use for domain
    // when it needs to cache something.
    domainFiles[domain]->SetDomainIndexForCaching(domain);

    return domainFiles[domain]->GetVectorVar(timestate, varname, cache);

}