-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathscenario_obj.c
2786 lines (2629 loc) · 85.2 KB
/
scenario_obj.c
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
/*******************************************************************************
MODULE: scenario_obj.c
CONTAINING SYSTEM: SLEUTH Model 3.0 Beta
(Slope, Land-cover, Exclusion, Urbanization,
Transportation, and Hillshade)
also known as UGM 3.0 Beta (Urban Growth Model)
COMPLETE VERSION: Version 3.0 (Rev. D-2.0)
REVISION DATE(s): August 31, 2006
September 6, 2006
PURPOSE:
This module is a pseudo-object used to accept, store, and return
data read in from the scenario file.
NOTES:
MODIFICATIONS:
September 6, 2006 - The function "scen_init()" was modified to broadcast
the six new variables added in Version D to the non-root nodes
since only the root node reads and processes the scenario file.
TO DO:
**************************************************************************/
/******************************************************************************
*******************************************************************************
** MODULE PROLOG **
*******************************************************************************
The scenario_obj.c module or object encapsulates the UGM's interface to the
user generated scenario file. This object maintains the scenario_info scenario
structure which mirrors the input options present in the scenario file.
It reads the scenario file and then provides the rest of the UGM
code access to its data values through its member functions.
*******************************************************************************
******************************************************************************/
#define SCENARIO_OBJ_MODULE
#include <string.h>
#include <assert.h>
#include <stdlib.h>
#include <errno.h>
#ifdef MPI
#include "mpi.h"
#endif
#include "scenario_obj.h"
#include "utilities.h"
#include "globals.h"
#include "proc_obj.h"
#include "ugm_macros.h"
#include "wgrid_obj.h"
/*VerD*/
extern float aux_diffusion_coeff;
extern float aux_diffusion_mult;
extern float aux_breed_coeff;
extern BOOLEAN WriteSlopeFileFlag;
extern BOOLEAN WriteRatioFileFlag;
extern BOOLEAN WriteXypointsFileFlag;
/*VerD*/
/*****************************************************************************\
*******************************************************************************
** **
** MACROS **
** **
*******************************************************************************
\*****************************************************************************/
#define SCEN_LINE_BUF_LEN 256
/*****************************************************************************\
*******************************************************************************
** **
** SCCS ID **
** **
*******************************************************************************
\*****************************************************************************/
char scenario_obj_c_sccs_id[] = "@(#)scenario_obj.c 1.84 12/4/00";
/*****************************************************************************\
*******************************************************************************
** **
** STATIC MEMORY FOR THIS OBJECT **
** **
*******************************************************************************
\*****************************************************************************/
static scenario_info scenario;
static char log_filename[SCEN_MAX_FILENAME_LEN];
/*****************************************************************************\
*******************************************************************************
** **
** STATIC FUNCTION PROTOTYPES **
** **
*******************************************************************************
\*****************************************************************************/
static void scen_open_log ();
static void scen_read_file (char *filename);
static int scen_process_user_color (char *string2process);
/******************************************************************************
*******************************************************************************
** FUNCTION NAME: scen_MemoryLog
** PURPOSE: log memory map to FILE* fp
** AUTHOR: Keith Clarke
** PROGRAMMER: Tommy E. Cathey of NESC (919)541-1500
** CREATION DATE: 11/11/1999
** DESCRIPTION:
**
**
*/
void
scen_MemoryLog (FILE * fp)
{
LOG_MEM (fp, &scenario, sizeof (scenario_info), 1);
}
/******************************************************************************
*******************************************************************************
** FUNCTION NAME: scen_GetScenarioFilename
** PURPOSE: return scenario filename
** AUTHOR: Keith Clarke
** PROGRAMMER: Tommy E. Cathey of NESC (919)541-1500
** CREATION DATE: 11/11/1999
** DESCRIPTION:
**
**
*/
char *
scen_GetScenarioFilename ()
{
return scenario.filename;
}
/******************************************************************************
*******************************************************************************
** FUNCTION NAME: scen_GetLogFP
** PURPOSE: return log file pointer
** AUTHOR: Keith Clarke
** PROGRAMMER: Tommy E. Cathey of NESC (919)541-1500
** CREATION DATE: 11/11/1999
** DESCRIPTION:
**
**
*/
FILE *
scen_GetLogFP ()
{
return scenario.log_fp;
}
/******************************************************************************
*******************************************************************************
** FUNCTION NAME: scen_Append2Log
** PURPOSE: open log for appending
** AUTHOR: Keith Clarke
** PROGRAMMER: Tommy E. Cathey of NESC (919)541-1500
** CREATION DATE: 11/11/1999
** DESCRIPTION:
**
**
*/
void
scen_Append2Log ()
{
char func[] = "scen_Append2Log";
FUNC_INIT;
if (scenario.log_fp == NULL)
{
FILE_OPEN (scenario.log_fp, log_filename, "a");
}
else
{
sprintf (msg_buf, "%s is already open", log_filename);
LOG_ERROR (msg_buf);
EXIT (1);
}
FUNC_END;
}
/******************************************************************************
*******************************************************************************
** FUNCTION NAME: scen_GetOutputDir
** PURPOSE: return output directory
** AUTHOR: Keith Clarke
** PROGRAMMER: Tommy E. Cathey of NESC (919)541-1500
** CREATION DATE: 11/11/1999
** DESCRIPTION:
**
**
*/
char *
scen_GetOutputDir ()
{
return scenario.output_dir;
}
/******************************************************************************
*******************************************************************************
** FUNCTION NAME: scen_GetWhirlgifBinary
** PURPOSE: return whirlgif_binary
** AUTHOR: Keith Clarke
** PROGRAMMER: Tommy E. Cathey of NESC (919)541-1500
** CREATION DATE: 11/11/1999
** DESCRIPTION:
**
**
*/
char *
scen_GetWhirlgifBinary ()
{
return scenario.whirlgif_binary;
}
/******************************************************************************
*******************************************************************************
** FUNCTION NAME: scen_GetInputDir
** PURPOSE: return input directory
** AUTHOR: Keith Clarke
** PROGRAMMER: Tommy E. Cathey of NESC (919)541-1500
** CREATION DATE: 11/11/1999
** DESCRIPTION:
**
**
*/
char *
scen_GetInputDir ()
{
return scenario.input_dir;
}
/******************************************************************************
*******************************************************************************
** FUNCTION NAME: scen_GetUrbanDataFileCount
** PURPOSE: return # of urban input files
** AUTHOR: Keith Clarke
** PROGRAMMER: Tommy E. Cathey of NESC (919)541-1500
** CREATION DATE: 11/11/1999
** DESCRIPTION:
**
**
*/
int
scen_GetUrbanDataFileCount ()
{
return scenario.urban_data_file_count;
}
/******************************************************************************
*******************************************************************************
** FUNCTION NAME: scen_GetRoadDataFileCount
** PURPOSE: return # road data files
** AUTHOR: Keith Clarke
** PROGRAMMER: Tommy E. Cathey of NESC (919)541-1500
** CREATION DATE: 11/11/1999
** DESCRIPTION:
**
**
*/
int
scen_GetRoadDataFileCount ()
{
return scenario.road_data_file_count;
}
/******************************************************************************
*******************************************************************************
** FUNCTION NAME: scen_GetLanduseDataFileCount
** PURPOSE: return # landuse data files
** AUTHOR: Keith Clarke
** PROGRAMMER: Tommy E. Cathey of NESC (919)541-1500
** CREATION DATE: 11/11/1999
** DESCRIPTION:
**
**
*/
int
scen_GetLanduseDataFileCount ()
{
return scenario.landuse_data_file_count;
}
/******************************************************************************
*******************************************************************************
** FUNCTION NAME: scen_GetDoingLanduseFlag
** PURPOSE: return doing landuse flag
** AUTHOR: Keith Clarke
** PROGRAMMER: Tommy E. Cathey of NESC (919)541-1500
** CREATION DATE: 11/11/1999
** DESCRIPTION: if doing landuse, then landuse_data_file_count is = 2
**
**
*/
int
scen_GetDoingLanduseFlag ()
{
return scenario.landuse_data_file_count;
}
/******************************************************************************
*******************************************************************************
** FUNCTION NAME: scen_GetUrbanDataFilename
** PURPOSE: return urban data filename by index, i
** AUTHOR: Keith Clarke
** PROGRAMMER: Tommy E. Cathey of NESC (919)541-1500
** CREATION DATE: 11/11/1999
** DESCRIPTION:
**
**
*/
char *
scen_GetUrbanDataFilename (int i)
{
return scenario.urban_data_file[i];
}
/******************************************************************************
*******************************************************************************
** FUNCTION NAME: scen_GetRoadDataFilename
** PURPOSE: return road data filename by index, i
** AUTHOR: Keith Clarke
** PROGRAMMER: Tommy E. Cathey of NESC (919)541-1500
** CREATION DATE: 11/11/1999
** DESCRIPTION:
**
**
*/
char *
scen_GetRoadDataFilename (int i)
{
return scenario.road_data_file[i];
}
/******************************************************************************
*******************************************************************************
** FUNCTION NAME: scen_GetLanduseDataFilename
** PURPOSE: return landuse data filename by index
** AUTHOR: Keith Clarke
** PROGRAMMER: Tommy E. Cathey of NESC (919)541-1500
** CREATION DATE: 11/11/1999
** DESCRIPTION:
**
**
*/
char *
scen_GetLanduseDataFilename (int i)
{
return scenario.landuse_data_file[i];
}
/******************************************************************************
*******************************************************************************
** FUNCTION NAME: scen_GetExcludedDataFilename
** PURPOSE: return excluded data filename by index
** AUTHOR: Keith Clarke
** PROGRAMMER: Tommy E. Cathey of NESC (919)541-1500
** CREATION DATE: 11/11/1999
** DESCRIPTION:
**
**
*/
char *
scen_GetExcludedDataFilename ()
{
return scenario.excluded_data_file;
}
/******************************************************************************
*******************************************************************************
** FUNCTION NAME: scen_GetSlopeDataFilename
** PURPOSE: return slope data filename
** AUTHOR: Keith Clarke
** PROGRAMMER: Tommy E. Cathey of NESC (919)541-1500
** CREATION DATE: 11/11/1999
** DESCRIPTION:
**
**
*/
char *
scen_GetSlopeDataFilename ()
{
return scenario.slope_data_file;
}
/******************************************************************************
*******************************************************************************
** FUNCTION NAME: scen_GetBackgroundDataFilename
** PURPOSE: return background data filename
** AUTHOR: Keith Clarke
** PROGRAMMER: Tommy E. Cathey of NESC (919)541-1500
** CREATION DATE: 11/11/1999
** DESCRIPTION:
**
**
*/
char *
scen_GetBackgroundDataFilename ()
{
return scenario.background_data_file;
}
/******************************************************************************
*******************************************************************************
** FUNCTION NAME: scen_GetEchoImageFlag
** PURPOSE: return echo_image_files flag
** AUTHOR: Keith Clarke
** PROGRAMMER: Tommy E. Cathey of NESC (919)541-1500
** CREATION DATE: 11/11/1999
** DESCRIPTION:
**
**
*/
BOOLEAN
scen_GetEchoImageFlag ()
{
return scenario.echo_image_files;
}
/******************************************************************************
*******************************************************************************
** FUNCTION NAME: scen_GetWriteColorKeyFlag
** PURPOSE: return write_color_keys flag
** AUTHOR: Keith Clarke
** PROGRAMMER: Tommy E. Cathey of NESC (919)541-1500
** CREATION DATE: 11/11/1999
** DESCRIPTION:
**
**
*/
BOOLEAN
scen_GetWriteColorKeyFlag ()
{
return scenario.write_color_keys;
}
/******************************************************************************
*******************************************************************************
** FUNCTION NAME: scen_GetPostprocessingFlag
** PURPOSE: return Postprocessing flag
** AUTHOR: Keith Clarke
** PROGRAMMER: Tommy E. Cathey of NESC (919)541-1500
** CREATION DATE: 11/11/1999
** DESCRIPTION:
**
**
*/
BOOLEAN
scen_GetPostprocessingFlag ()
{
return scenario.postprocessing;
}
/******************************************************************************
*******************************************************************************
** FUNCTION NAME: scen_GetLogFlag
** PURPOSE: return Log flag
** AUTHOR: Keith Clarke
** PROGRAMMER: Tommy E. Cathey of NESC (919)541-1500
** CREATION DATE: 11/11/1999
** DESCRIPTION:
**
**
*/
BOOLEAN
scen_GetLogFlag ()
{
return scenario.logging;
}
/******************************************************************************
*******************************************************************************
** FUNCTION NAME: scen_GetEchoFlag
** PURPOSE: return echo flag
** AUTHOR: Keith Clarke
** PROGRAMMER: Tommy E. Cathey of NESC (919)541-1500
** CREATION DATE: 11/11/1999
** DESCRIPTION:
**
**
*/
BOOLEAN
scen_GetEchoFlag ()
{
return scenario.echo;
}
/******************************************************************************
*******************************************************************************
** FUNCTION NAME: scen_GetRandomSeed
** PURPOSE: return random seed value
** AUTHOR: Keith Clarke
** PROGRAMMER: Tommy E. Cathey of NESC (919)541-1500
** CREATION DATE: 11/11/1999
** DESCRIPTION:
**
**
*/
int
scen_GetRandomSeed ()
{
return scenario.random_seed;
}
/******************************************************************************
*******************************************************************************
** FUNCTION NAME: scen_GetMonteCarloIterations
** PURPOSE: return # monte carlo iterations
** AUTHOR: Keith Clarke
** PROGRAMMER: Tommy E. Cathey of NESC (919)541-1500
** CREATION DATE: 11/11/1999
** DESCRIPTION:
**
**
*/
int
scen_GetMonteCarloIterations ()
{
return scenario.monte_carlo_iterations;
}
/******************************************************************************
*******************************************************************************
** FUNCTION NAME: scen_GetCoeffDiffusionStart
** PURPOSE: return diffusion start value
** AUTHOR: Keith Clarke
** PROGRAMMER: Tommy E. Cathey of NESC (919)541-1500
** CREATION DATE: 11/11/1999
** DESCRIPTION:
**
**
*/
int
scen_GetCoeffDiffusionStart ()
{
return scenario.start.diffusion;
}
/******************************************************************************
*******************************************************************************
** FUNCTION NAME: scen_GetCoeffBreedStart
** PURPOSE: return breed start value
** AUTHOR: Keith Clarke
** PROGRAMMER: Tommy E. Cathey of NESC (919)541-1500
** CREATION DATE: 11/11/1999
** DESCRIPTION:
**
**
*/
int
scen_GetCoeffBreedStart ()
{
return scenario.start.breed;
}
/******************************************************************************
*******************************************************************************
** FUNCTION NAME: scen_GetCoeffSpreadStart
** PURPOSE: return spread start value
** AUTHOR: Keith Clarke
** PROGRAMMER: Tommy E. Cathey of NESC (919)541-1500
** CREATION DATE: 11/11/1999
** DESCRIPTION:
**
**
*/
int
scen_GetCoeffSpreadStart ()
{
return scenario.start.spread;
}
/******************************************************************************
*******************************************************************************
** FUNCTION NAME: scen_GetCoeffSlopeResistStart
** PURPOSE: return slope resistance start value
** AUTHOR: Keith Clarke
** PROGRAMMER: Tommy E. Cathey of NESC (919)541-1500
** CREATION DATE: 11/11/1999
** DESCRIPTION:
**
**
*/
int
scen_GetCoeffSlopeResistStart ()
{
return scenario.start.slope_resistance;
}
/******************************************************************************
*******************************************************************************
** FUNCTION NAME: scen_GetCoeffRoadGravityStart
** PURPOSE: return road gravity start value
** AUTHOR: Keith Clarke
** PROGRAMMER: Tommy E. Cathey of NESC (919)541-1500
** CREATION DATE: 11/11/1999
** DESCRIPTION:
**
**
*/
int
scen_GetCoeffRoadGravityStart ()
{
return scenario.start.road_gravity;
}
/******************************************************************************
*******************************************************************************
** FUNCTION NAME: scen_GetCoeffDiffusionStop
** PURPOSE: return diffusion stop value
** AUTHOR: Keith Clarke
** PROGRAMMER: Tommy E. Cathey of NESC (919)541-1500
** CREATION DATE: 11/11/1999
** DESCRIPTION:
**
**
*/
int
scen_GetCoeffDiffusionStop ()
{
return scenario.stop.diffusion;
}
/******************************************************************************
*******************************************************************************
** FUNCTION NAME: scen_GetCoeffBreedStop
** PURPOSE: return breed stop value
** AUTHOR: Keith Clarke
** PROGRAMMER: Tommy E. Cathey of NESC (919)541-1500
** CREATION DATE: 11/11/1999
** DESCRIPTION:
**
**
*/
int
scen_GetCoeffBreedStop ()
{
return scenario.stop.breed;
}
/******************************************************************************
*******************************************************************************
** FUNCTION NAME: scen_GetCoeffSpreadStop
** PURPOSE: return spread stop value
** AUTHOR: Keith Clarke
** PROGRAMMER: Tommy E. Cathey of NESC (919)541-1500
** CREATION DATE: 11/11/1999
** DESCRIPTION:
**
**
*/
int
scen_GetCoeffSpreadStop ()
{
return scenario.stop.spread;
}
/******************************************************************************
*******************************************************************************
** FUNCTION NAME: scen_GetCoeffSlopeResistStop
** PURPOSE: return slope resistance stop value
** AUTHOR: Keith Clarke
** PROGRAMMER: Tommy E. Cathey of NESC (919)541-1500
** CREATION DATE: 11/11/1999
** DESCRIPTION:
**
**
*/
int
scen_GetCoeffSlopeResistStop ()
{
return scenario.stop.slope_resistance;
}
/******************************************************************************
*******************************************************************************
** FUNCTION NAME: scen_GetCoeffRoadGravityStop
** PURPOSE: return road gravity stop value
** AUTHOR: Keith Clarke
** PROGRAMMER: Tommy E. Cathey of NESC (919)541-1500
** CREATION DATE: 11/11/1999
** DESCRIPTION:
**
**
*/
int
scen_GetCoeffRoadGravityStop ()
{
return scenario.stop.road_gravity;
}
/******************************************************************************
*******************************************************************************
** FUNCTION NAME: scen_GetCoeffDiffusionStep
** PURPOSE: return diffustion step value
** AUTHOR: Keith Clarke
** PROGRAMMER: Tommy E. Cathey of NESC (919)541-1500
** CREATION DATE: 11/11/1999
** DESCRIPTION:
**
**
*/
int
scen_GetCoeffDiffusionStep ()
{
return scenario.step.diffusion;
}
/******************************************************************************
*******************************************************************************
** FUNCTION NAME: scen_GetCoeffBreedStep
** PURPOSE: return breed step value
** AUTHOR: Keith Clarke
** PROGRAMMER: Tommy E. Cathey of NESC (919)541-1500
** CREATION DATE: 11/11/1999
** DESCRIPTION:
**
**
*/
int
scen_GetCoeffBreedStep ()
{
return scenario.step.breed;
}
/******************************************************************************
*******************************************************************************
** FUNCTION NAME: scen_GetCoeffSpreadStep
** PURPOSE: return spread step value
** AUTHOR: Keith Clarke
** PROGRAMMER: Tommy E. Cathey of NESC (919)541-1500
** CREATION DATE: 11/11/1999
** DESCRIPTION:
**
**
*/
int
scen_GetCoeffSpreadStep ()
{
return scenario.step.spread;
}
/******************************************************************************
*******************************************************************************
** FUNCTION NAME: scen_GetCoeffSlopeResistStep
** PURPOSE: return slope resistance step value
** AUTHOR: Keith Clarke
** PROGRAMMER: Tommy E. Cathey of NESC (919)541-1500
** CREATION DATE: 11/11/1999
** DESCRIPTION:
**
**
*/
int
scen_GetCoeffSlopeResistStep ()
{
return scenario.step.slope_resistance;
}
/******************************************************************************
*******************************************************************************
** FUNCTION NAME: scen_GetCoeffRoadGravityStep
** PURPOSE: return road gravity step value
** AUTHOR: Keith Clarke
** PROGRAMMER: Tommy E. Cathey of NESC (919)541-1500
** CREATION DATE: 11/11/1999
** DESCRIPTION:
**
**
*/
int
scen_GetCoeffRoadGravityStep ()
{
return scenario.step.road_gravity;
}
/******************************************************************************
*******************************************************************************
** FUNCTION NAME: scen_GetCoeffDiffusionBestFit
** PURPOSE: return diffusion best fit value
** AUTHOR: Keith Clarke
** PROGRAMMER: Tommy E. Cathey of NESC (919)541-1500
** CREATION DATE: 11/11/1999
** DESCRIPTION:
**
**
*/
int
scen_GetCoeffDiffusionBestFit ()
{
return scenario.best_fit.diffusion;
}
/******************************************************************************
*******************************************************************************
** FUNCTION NAME: scen_GetCoeffBreedBestFit
** PURPOSE: return breed best fit value
** AUTHOR: Keith Clarke
** PROGRAMMER: Tommy E. Cathey of NESC (919)541-1500
** CREATION DATE: 11/11/1999
** DESCRIPTION:
**
**
*/
int
scen_GetCoeffBreedBestFit ()
{
return scenario.best_fit.breed;
}
/******************************************************************************
*******************************************************************************
** FUNCTION NAME: scen_GetCoeffSpreadBestFit
** PURPOSE: return spread best fit value
** AUTHOR: Keith Clarke
** PROGRAMMER: Tommy E. Cathey of NESC (919)541-1500
** CREATION DATE: 11/11/1999
** DESCRIPTION:
**
**
*/
int
scen_GetCoeffSpreadBestFit ()
{
return scenario.best_fit.spread;
}
/******************************************************************************
*******************************************************************************
** FUNCTION NAME: scen_GetCoeffSlopeResistBestFit
** PURPOSE: return slope resistance best fit value
** AUTHOR: Keith Clarke
** PROGRAMMER: Tommy E. Cathey of NESC (919)541-1500
** CREATION DATE: 11/11/1999
** DESCRIPTION:
**
**
*/
int
scen_GetCoeffSlopeResistBestFit ()
{
return scenario.best_fit.slope_resistance;
}
/******************************************************************************
*******************************************************************************
** FUNCTION NAME: scen_GetCoeffRoadGravityBestFit
** PURPOSE: return road gravity best fit value
** AUTHOR: Keith Clarke
** PROGRAMMER: Tommy E. Cathey of NESC (919)541-1500
** CREATION DATE: 11/11/1999
** DESCRIPTION:
**
**
*/
int
scen_GetCoeffRoadGravityBestFit ()
{
return scenario.best_fit.road_gravity;
}
/******************************************************************************
*******************************************************************************
** FUNCTION NAME: scen_GetPredictionStartDate
** PURPOSE: return prediction start date
** AUTHOR: Keith Clarke
** PROGRAMMER: Tommy E. Cathey of NESC (919)541-1500
** CREATION DATE: 11/11/1999
** DESCRIPTION:
**
**
*/
int
scen_GetPredictionStartDate ()
{
return scenario.prediction_start_date;
}
/******************************************************************************
*******************************************************************************
** FUNCTION NAME: scen_GetPredictionStopDate
** PURPOSE: return prediction stop date
** AUTHOR: Keith Clarke
** PROGRAMMER: Tommy E. Cathey of NESC (919)541-1500
** CREATION DATE: 11/11/1999
** DESCRIPTION:
**
**
*/
int
scen_GetPredictionStopDate ()
{
return scenario.prediction_stop_date;
}
/******************************************************************************
*******************************************************************************
** FUNCTION NAME: scen_GetDateColor
** PURPOSE: return date color
** AUTHOR: Keith Clarke
** PROGRAMMER: Tommy E. Cathey of NESC (919)541-1500
** CREATION DATE: 11/11/1999
** DESCRIPTION:
**
**
*/
int
scen_GetDateColor ()
{
return scenario.date_color;
}
/******************************************************************************
*******************************************************************************
** FUNCTION NAME: scen_GetSeedColor
** PURPOSE: return seed color
** AUTHOR: Keith Clarke
** PROGRAMMER: Tommy E. Cathey of NESC (919)541-1500
** CREATION DATE: 11/11/1999
** DESCRIPTION:
**
**
*/
int
scen_GetSeedColor ()
{
return scenario.seed_color;
}
/******************************************************************************
*******************************************************************************
** FUNCTION NAME: scen_GetWaterColor
** PURPOSE: return water color
** AUTHOR: Keith Clarke
** PROGRAMMER: Tommy E. Cathey of NESC (919)541-1500
** CREATION DATE: 11/11/1999
** DESCRIPTION:
**
**
*/
int
scen_GetWaterColor ()
{
return scenario.water_color;
}
/******************************************************************************
*******************************************************************************
** FUNCTION NAME: scen_GetProbabilityColorCount
** PURPOSE: return # probability color count
** AUTHOR: Keith Clarke
** PROGRAMMER: Tommy E. Cathey of NESC (919)541-1500
** CREATION DATE: 11/11/1999
** DESCRIPTION:
**
**
*/
int
scen_GetProbabilityColorCount ()
{
return scenario.probability_color_count;
}
/******************************************************************************
*******************************************************************************
** FUNCTION NAME: scen_GetProbabilityColorLowerBound
** PURPOSE: return lower bound for probability color index, i
** AUTHOR: Keith Clarke
** PROGRAMMER: Tommy E. Cathey of NESC (919)541-1500
** CREATION DATE: 11/11/1999
** DESCRIPTION:
**
**
*/
int
scen_GetProbabilityColorLowerBound (int i)
{
return scenario.probability_color[i].lower_bound;
}
/******************************************************************************
*******************************************************************************
** FUNCTION NAME: scen_GetProbabilityColorUpperBound
** PURPOSE: return upper bound for probability color index, i
** AUTHOR: Keith Clarke
** PROGRAMMER: Tommy E. Cathey of NESC (919)541-1500
** CREATION DATE: 11/11/1999