forked from VirtualPlanetaryLaboratory/vplanet
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathdistorb.c
6861 lines (5917 loc) · 256 KB
/
distorb.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
/**
@file distorb.c
@brief Subroutines that control the integration of the orbital model.
@author Russell Deitrick ([deitrr](https://github.com/deitrr/))
@date April 28 2015
*/
#include "vplanet.h"
#include <assert.h>
#include <math.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
void BodyCopyDistOrb(BODY *dest, BODY *src, int iTideModel, int iNumBodies,
int iBody) {
int iIndex, iPert;
dest[iBody].dPinc = src[iBody].dPinc;
dest[iBody].dQinc = src[iBody].dQinc;
dest[iBody].iGravPerts = src[iBody].iGravPerts;
// dest[iBody].iaGravPerts = malloc(dest[iBody].iGravPerts*sizeof(int));
for (iPert = 0; iPert < src[iBody].iGravPerts; iPert++) {
dest[iBody].iaGravPerts[iPert] = src[iBody].iaGravPerts[iPert];
}
}
void InitializeBodyDistOrb(BODY *body, CONTROL *control, UPDATE *update,
int iBody, int iModule) {
if (body[iBody].bDistOrb) {
if (control->Evolve.iDistOrbModel == RD4) {
body[iBody].iGravPerts = control->Evolve.iNumBodies - 2;
body[iBody].iDistOrbModel = RD4;
} else if (control->Evolve.iDistOrbModel == LL2) {
/* "Perturbers" in LL2 correspond to eigenfrequencies, not planet pairs.
Number of eigenfrequencies = number of planets. */
body[iBody].iGravPerts = control->Evolve.iNumBodies - 1;
body[iBody].iDistOrbModel = LL2;
}
}
body[iBody].iaGravPerts = malloc(body[iBody].iGravPerts * sizeof(int));
}
void InitializeUpdateTmpBodyDistOrb(BODY *body, CONTROL *control,
UPDATE *update, int iBody) {
control->Evolve.tmpBody[iBody].iaGravPerts =
malloc(body[iBody].iGravPerts * sizeof(int));
}
/**************** DISTORB options ********************/
void ReadDfCrit(BODY *body, CONTROL *control, FILES *files, OPTIONS *options,
SYSTEM *system, int iFile) {
/* This parameter can exist in any file, but only once */
int lTmp = -1;
double dTmp;
AddOptionDouble(files->Infile[iFile].cIn, options->cName, &dTmp, &lTmp,
control->Io.iVerbose);
if (lTmp >= 0) {
CheckDuplication(files, options, files->Infile[iFile].cIn, lTmp,
control->Io.iVerbose);
if (dTmp < 0) {
if (control->Io.iVerbose >= VERBERR) {
fprintf(stderr, "ERROR: %s must be greater than or equal to 0.\n",
options->cName);
}
LineExit(files->Infile[iFile].cIn, lTmp);
}
system->dDfcrit = dTmp;
if (system->dDfcrit > 1 && control->Io.iVerbose >= VERBALL) {
fprintf(stderr, "WARNING: %s > 1 is not advised (%s:%d).\n",
options->cName, files->Infile[iFile].cIn, lTmp);
}
UpdateFoundOption(&files->Infile[iFile], options, lTmp, iFile);
} else {
AssignDefaultDouble(options, &system->dDfcrit, files->iNumInputs);
}
}
void ReadInvPlane(BODY *body, CONTROL *control, FILES *files, OPTIONS *options,
SYSTEM *system, int iFile) {
int lTmp = -1, bTmp;
AddOptionBool(files->Infile[iFile].cIn, options->cName, &bTmp, &lTmp,
control->Io.iVerbose);
if (lTmp >= 0) {
CheckDuplication(files, options, files->Infile[iFile].cIn, lTmp,
control->Io.iVerbose);
/* Option was found */
control->bInvPlane = bTmp;
UpdateFoundOption(&files->Infile[iFile], options, lTmp, iFile);
} else {
AssignDefaultInt(options, &control->bInvPlane, files->iNumInputs);
}
}
void ReadOutputLapl(BODY *body, CONTROL *control, FILES *files,
OPTIONS *options, SYSTEM *system, int iFile) {
int lTmp = -1, bTmp;
AddOptionBool(files->Infile[iFile].cIn, options->cName, &bTmp, &lTmp,
control->Io.iVerbose);
if (lTmp >= 0) {
CheckDuplication(files, options, files->Infile[iFile].cIn, lTmp,
control->Io.iVerbose);
/* Option was found */
control->bOutputLapl = bTmp;
UpdateFoundOption(&files->Infile[iFile], options, lTmp, iFile);
} else {
AssignDefaultInt(options, &control->bOutputLapl, files->iNumInputs);
}
}
void ReadOutputEigen(BODY *body, CONTROL *control, FILES *files,
OPTIONS *options, SYSTEM *system, int iFile) {
int lTmp = -1, bTmp;
AddOptionBool(files->Infile[iFile].cIn, options->cName, &bTmp, &lTmp,
control->Io.iVerbose);
if (lTmp >= 0) {
CheckDuplication(files, options, files->Infile[iFile].cIn, lTmp,
control->Io.iVerbose);
/* Option was found */
control->bOutputEigen = bTmp;
UpdateFoundOption(&files->Infile[iFile], options, lTmp, iFile);
} else {
AssignDefaultInt(options, &control->bOutputEigen, files->iNumInputs);
}
}
void ReadOverrideMaxEcc(BODY *body, CONTROL *control, FILES *files,
OPTIONS *options, SYSTEM *system, int iFile) {
int lTmp = -1, bTmp;
AddOptionBool(files->Infile[iFile].cIn, options->cName, &bTmp, &lTmp,
control->Io.iVerbose);
if (lTmp >= 0) {
/* Option was found */
control->Halt[iFile - 1].bOverrideMaxEcc = bTmp;
UpdateFoundOption(&files->Infile[iFile], options, lTmp, iFile);
} else {
control->Halt[iFile - 1].bOverrideMaxEcc = options->dDefault;
}
// AssignDefaultInt(options,&control->Halt[iFile-1].bOverrideMaxEcc,files->iNumInputs);
}
void ReadHaltHillStab(BODY *body, CONTROL *control, FILES *files,
OPTIONS *options, SYSTEM *system, int iFile) {
int lTmp = -1, bTmp;
AddOptionBool(files->Infile[iFile].cIn, options->cName, &bTmp, &lTmp,
control->Io.iVerbose);
if (lTmp >= 0) {
CheckDuplication(files, options, files->Infile[iFile].cIn, lTmp,
control->Io.iVerbose);
/* Option was found */
control->Halt[iFile - 1].bHillStab = bTmp;
UpdateFoundOption(&files->Infile[iFile], options, lTmp, iFile);
} else {
control->Halt[iFile - 1].bHillStab = options->dDefault;
}
}
void ReadHaltCloseEnc(BODY *body, CONTROL *control, FILES *files,
OPTIONS *options, SYSTEM *system, int iFile) {
int lTmp = -1, bTmp;
AddOptionBool(files->Infile[iFile].cIn, options->cName, &bTmp, &lTmp,
control->Io.iVerbose);
if (lTmp >= 0) {
CheckDuplication(files, options, files->Infile[iFile].cIn, lTmp,
control->Io.iVerbose);
/* Option was found */
control->Halt[iFile - 1].bCloseEnc = bTmp;
UpdateFoundOption(&files->Infile[iFile], options, lTmp, iFile);
} else {
control->Halt[iFile - 1].bCloseEnc = options->dDefault;
}
}
/* For LL2 (eigenvalue) solution only, we could add these option to let the
user specify the eigenvalues instead of calculating them from scratch. This is
useful if you want to use, for example, an N-body code to compute frequencies
that are accurate to higher orders. One could conceivably fake the higher order
evolution using only the LL2 solution by doing this.
void ReadEigenSet(BODY *body,CONTROL *control,FILES *files,OPTIONS
*options,SYSTEM *system,int iFile) { int lTmp=-1,bTmp;
AddOptionBool(files->Infile[iFile].cIn,options->cName,&bTmp,&lTmp,control->Io.iVerbose);
if (lTmp >= 0) {
/ * Option was found * /
body[iFile-1].bEigenSet = bTmp;
UpdateFoundOption(&files->Infile[iFile],options,lTmp,iFile);
} else
body[iFile-1].bEigenSet = options->dDefault;
//
AssignDefaultInt(options,&control->Halt[iFile-1].bOverrideMaxEcc,files->iNumInputs);
}
void ReadEigenvalue(BODY *body,CONTROL *control,FILES *files,OPTIONS
*options,SYSTEM *system,int iFile) { / * This parameter cannot exist in the
primary file * / int lTmp=-1; double dTmp;
AddOptionDouble(files->Infile[iFile].cIn,options->cName,&dTmp,&lTmp,control->Io.iVerbose);
if (lTmp >= 0) {
NotPrimaryInput(iFile,options->cName,files->Infile[iFile].cIn,lTmp,control->Io.iVerbose);
dTmp *= DEGRAD/3600./YEARSEC;
body[iFile-1].dEigenvalue = dTmp;
UpdateFoundOption(&files->Infile[iFile],options,lTmp,iFile);
} else
if (iFile > 0)
body[iFile-1].dEigenvalue = options->dDefault;
}
void ReadEigenvector(BODY *body,CONTROL *control,FILES *files,OPTIONS
*options,SYSTEM *system,int iFile) { / * This parameter cannot exist in the
primary file * / int lTmp=-1; double dTmp;
AddOptionDouble(files->Infile[iFile].cIn,options->cName,&dTmp,&lTmp,control->Io.iVerbose);
if (lTmp >= 0) {
NotPrimaryInput(iFile,options->cName,files->Infile[iFile].cIn,lTmp,control->Io.iVerbose);
body[iFile-1].dEigenvector = dTmp;
UpdateFoundOption(&files->Infile[iFile],options,lTmp,iFile);
} else
if (iFile > 0)
body[iFile-1].dEigenvector = options->dDefault;
}
*/
void ReadOrbitModel(BODY *body, CONTROL *control, FILES *files,
OPTIONS *options, SYSTEM *system, int iFile) {
/* This parameter can exist in any file, but only once */
int lTmp = -1;
char cTmp[OPTLEN];
/* Tide Model, use #defined variables */
AddOptionString(files->Infile[iFile].cIn, options->cName, cTmp, &lTmp,
control->Io.iVerbose);
if (lTmp >= 0) {
/* This parameter can not appear in the primary input,
as it is module specific (it's easier to code this
way. It should also only appear in one body file
so as different tidal models cannot be called. */
NotPrimaryInput(iFile, options->cName, files->Infile[iFile].cIn, lTmp,
control->Io.iVerbose);
CheckDuplication(files, options, files->Infile[iFile].cIn, lTmp,
control->Io.iVerbose);
if (!memcmp(sLower(cTmp), "ll2", 3)) {
control->Evolve.iDistOrbModel = LL2;
} else if (!memcmp(sLower(cTmp), "rd4", 3)) {
control->Evolve.iDistOrbModel = RD4;
} else {
if (control->Io.iVerbose >= VERBERR) {
fprintf(stderr,
"ERROR: Unknown argument to %s: %s. Options are ll2 or rd4.\n",
options->cName, cTmp);
}
LineExit(files->Infile[iFile].cIn, lTmp);
}
UpdateFoundOption(&files->Infile[iFile], options, lTmp, iFile);
} else {
AssignDefaultInt(options, &control->Evolve.iDistOrbModel,
files->iNumInputs);
}
}
void InitializeOptionsDistOrb(OPTIONS *options, fnReadOption fnRead[]) {
sprintf(options[OPT_DFCRIT].cName, "dDfcrit");
sprintf(options[OPT_DFCRIT].cDescr,
"Tolerance parameter for recalculating semi-major axis functions");
sprintf(options[OPT_DFCRIT].cDefault, "0.1");
sprintf(options[OPT_DFCRIT].cDimension, "nd");
options[OPT_DFCRIT].dDefault = 0.1;
options[OPT_DFCRIT].iType = 2;
options[OPT_DFCRIT].bMultiFile = 0;
fnRead[OPT_DFCRIT] = &ReadDfCrit;
sprintf(options[OPT_DFCRIT].cLongDescr,
"When running DistOrb with other modules that modify the semi-major "
"axis,\n"
"set his argument to be the maximum relative change in the Laplace\n"
"coefficients before recalculating the values. Setting this value to "
"be\n"
"low can cause the simulation to run very slowly, with negligible "
"gain in\n"
"accuracy.");
sprintf(options[OPT_INVPLANE].cName, "bInvPlane");
sprintf(options[OPT_INVPLANE].cDescr,
"Convert input coordinates to invariable plane coordinates");
sprintf(options[OPT_INVPLANE].cDefault, "0");
options[OPT_INVPLANE].dDefault = 0;
options[OPT_INVPLANE].iType = 0;
options[OPT_INVPLANE].bMultiFile = 0;
fnRead[OPT_INVPLANE] = &ReadInvPlane;
sprintf(options[OPT_ORBITMODEL].cName, "sOrbitModel");
sprintf(options[OPT_ORBITMODEL].cDescr,
"Orbit Model: LL2 [2nd order] RD4 [4th order]");
sprintf(options[OPT_ORBITMODEL].cDefault, "rd4");
options[OPT_ORBITMODEL].dDefault = RD4;
options[OPT_ORBITMODEL].iType = 3;
fnRead[OPT_ORBITMODEL] = &ReadOrbitModel;
sprintf(options[OPT_ORBITMODEL].cLongDescr,
"The secular orbital evolution model used with DistOrb. Option LL2 "
"is the\n"
"Laplace-Lagrange (eigenvalue) solution that is valid for small "
"values of\n"
"of eccentricity (<0.1) and inclination (<10 deg). The RD4 method is "
"a 4th\n"
"order solution of the distrubing function that is accurante up to e "
"~ 0.3\n"
"and i ~ 30 deg. Note, however that setting both parameters to "
"moderate\n"
"values can still cause inaccurate evolution. Unless %s is set, this "
"model\n"
"will halt if the eccentricity exceeds ~0.69, at which point the "
"solution\n"
"does not converge.",
options[OPT_ORMAXECC].cName);
sprintf(options[OPT_ORMAXECC].cName, "bOverrideMaxEcc");
sprintf(options[OPT_ORMAXECC].cDescr,
"Override default maximum eccentricity (MAXORBDISTORB) in DistOrb?");
sprintf(options[OPT_ORMAXECC].cDefault, "0");
options[OPT_ORMAXECC].dDefault = 0;
options[OPT_ORMAXECC].iType = 0;
options[OPT_ORMAXECC].bMultiFile = 0;
fnRead[OPT_ORMAXECC] = &ReadOverrideMaxEcc;
sprintf(options[OPT_ORBITMODEL].cLongDescr,
"If RD4 is selected for %s, the code will halt if an eccentricity "
"reaches\n"
"~0.69 unless this flag is set to true.",
options[OPT_ORBITMODEL].cName);
sprintf(options[OPT_HALTHILLSTAB].cName, "bHaltHillStab");
sprintf(options[OPT_HALTHILLSTAB].cDescr, "Halt if Hill unstable?");
sprintf(options[OPT_HALTHILLSTAB].cDefault, "0");
options[OPT_HALTHILLSTAB].dDefault = 0;
options[OPT_HALTHILLSTAB].iType = 0;
options[OPT_HALTHILLSTAB].bMultiFile = 0;
fnRead[OPT_HALTHILLSTAB] = &ReadHaltHillStab;
sprintf(
options[OPT_HALTHILLSTAB].cLongDescr,
"If two planets come within the Hill stability criterion, the code will"
"halt if this parameter is set");
sprintf(options[OPT_HALTCLOSEENC].cName, "bHaltCloseEnc");
sprintf(options[OPT_HALTCLOSEENC].cDescr, "Halt if orbits get too close");
sprintf(options[OPT_HALTCLOSEENC].cDefault, "0");
options[OPT_HALTCLOSEENC].dDefault = 0;
options[OPT_HALTCLOSEENC].iType = 0;
options[OPT_HALTCLOSEENC].bMultiFile = 0;
fnRead[OPT_HALTCLOSEENC] = &ReadHaltCloseEnc;
sprintf(
options[OPT_HALTCLOSEENC].cLongDescr,
"Halt the code if the apocenter of an interior planets is less than 4 "
"mutual Hill radii from the pericenter of an outer planet.");
/* For LL2 (eigenvalue) solution only, we could add these option to let the
user specify the eigenvalues instead of calculating them from scratch. This is
useful if you want to use, for example, an N-body code to compute frequencies
that are accurate to higher orders. One could conceivably fake the higher
order evolution using only the LL2 solution by doing this.
sprintf(options[OPT_EIGENSET].cName,"bEigenSet");
sprintf(options[OPT_EIGENSET].cDescr,"Read in eigenvalues/vectors for
DistOrb?"); sprintf(options[OPT_EIGENSET].cDefault,"0");
options[OPT_EIGENSET].dDefault = 0;
options[OPT_EIGENSET].iType = 0;
options[OPT_EIGENSET].bMultiFile = 0;
fnRead[OPT_EIGENSET] = &ReadEigenSet;
sprintf(options[OPT_EIGENVALUE].cName,"dEigenvalue");
sprintf(options[OPT_EIGENVALUE].cDescr,"Set this to provide
eigenvalues/vectors at input"); sprintf(options[OPT_EIGENVALUE].cDefault,"0");
sprintf(options[OPT_EIGENVALUE].cDimension,"nd");
options[OPT_EIGENVALUE].dDefault = 0;
options[OPT_EIGENVALUE].iType = 0;
options[OPT_EIGENVALUE].bMultiFile = 0;
fnRead[OPT_EIGENVALUE] = &ReadEigenvalue;
sprintf(options[OPT_EIGENVECTOR].cName,"dEigenvector");
sprintf(options[OPT_EIGENVECTOR].cDescr,"Set this to provide
eigenvalues/vectors at input");
sprintf(options[OPT_EIGENVECTOR].cDefault,"0");
sprintf(options[OPT_EIGENVECTOR].cDimension,"nd");
options[OPT_EIGENVECTOR].dDefault = 0;
options[OPT_EIGENVECTOR].iType = 0;
options[OPT_EIGENVECTOR].bMultiFile = 0;
fnRead[OPT_EIGENVECTOR] = &ReadEigenvector;
*/
sprintf(options[OPT_OUTPUTLAPL].cName, "bOutputLapl");
sprintf(options[OPT_OUTPUTLAPL].cDescr,
"Output Laplace functions and related data?");
sprintf(options[OPT_OUTPUTLAPL].cDefault, "0");
options[OPT_OUTPUTLAPL].dDefault = 0;
options[OPT_OUTPUTLAPL].iType = 0;
options[OPT_OUTPUTLAPL].bMultiFile = 0;
fnRead[OPT_OUTPUTLAPL] = &ReadOutputLapl;
sprintf(
options[OPT_OUTPUTLAPL].cLongDescr,
"Write files that contain the Laplace coefficients and their "
"derivatives\n"
"in DistOrb. This file can be used to check that they are recomputed \n"
"frequently enough when damping (e.g. EqTide) is included.");
sprintf(options[OPT_OUTPUTEIGEN].cName, "bOutputEigen");
sprintf(options[OPT_OUTPUTEIGEN].cDescr, "Output Eigenvalues?");
sprintf(options[OPT_OUTPUTEIGEN].cDefault, "0");
options[OPT_OUTPUTEIGEN].dDefault = 0;
options[OPT_OUTPUTEIGEN].iType = 0;
options[OPT_OUTPUTEIGEN].bMultiFile = 0;
fnRead[OPT_OUTPUTEIGEN] = &ReadOutputEigen;
sprintf(
options[OPT_OUTPUTLAPL].cLongDescr,
"Write special files that contain the eigenvalues and eigenvectors of "
"the\n"
"system with DistOrb. In the LL2 solution, these are already computed. "
"In\n"
"the RD4 solution, they are computed at time of output. These can be\n"
"useful for interpretating results.");
}
void ReadOptionsDistOrb(BODY *body, CONTROL *control, FILES *files,
OPTIONS *options, SYSTEM *system, fnReadOption fnRead[],
int iBody) {
int iOpt;
for (iOpt = OPTSTARTDISTORB; iOpt < OPTENDDISTORB; iOpt++) {
if (options[iOpt].iType != -1) {
fnRead[iOpt](body, control, files, &options[iOpt], system, iBody + 1);
}
}
}
/******************* Verify DISTORB ******************/
/*
*
* Pericenter/Ascending node
*
*/
double fndCorrectDomain(double angle) {
while (angle >= 2 * PI) {
angle -= 2 * PI;
}
while (angle < 0.0) {
angle += 2 * PI;
}
return angle;
}
double fndCalcLongP(double dLongA, double dArgP) {
double varpi;
varpi = fndCorrectDomain(dLongA + dArgP);
return varpi;
}
double fndCalcLongA(double dLongP, double dArgP) {
double Omega;
Omega = fndCorrectDomain(dLongP - dArgP);
return Omega;
}
void VerifyOrbitModel(CONTROL *control, FILES *files, OPTIONS *options) {
int iFile, iFound = 0;
char cTmp[8];
for (iFile = 0; iFile < files->iNumInputs; iFile++) {
if (options[OPT_ORBITMODEL].iLine[iFile] >= 0) {
iFound++;
}
}
if (iFound > 1) {
if (control->Io.iVerbose > VERBERR) {
fprintf(stderr, "ERROR: Option %s set multiple times.\n",
options[OPT_ORBITMODEL].cName);
for (iFile = 0; iFile < files->iNumInputs; iFile++) {
if (options[OPT_ORBITMODEL].iLine[iFile] >= 0) {
fprintf(stderr, "\tFile %s, Line: %d\n", files->Infile[0].cIn,
options[OPT_ORBITMODEL].iLine[iFile]);
}
}
}
exit(EXIT_INPUT);
}
if (iFound == 0) {
strcpy(cTmp, options[OPT_ORBITMODEL].cDefault);
if (!memcmp(sLower(cTmp), "ll2", 3)) {
control->Evolve.iDistOrbModel = LL2;
} else if (!memcmp(sLower(cTmp), "rd4", 3)) {
control->Evolve.iDistOrbModel = RD4;
}
if (control->Io.iVerbose >= VERBINPUT) {
fprintf(stderr, "INFO: %s not set in any file, defaulting to %s.\n",
options[OPT_ORBITMODEL].cName, options[OPT_ORBITMODEL].cDefault);
}
/* Chicanery. Since I only want this set once, I will
make it seem like the user set it. */
options[OPT_ORBITMODEL].iLine[0] = 1;
}
}
// void VerifyStabilityHalts(CONTROL *control,FILES *files,OPTIONS *options) {
// int iFile, iHillSet, iCloseSet;
// /* make sure user doesn't set both bHaltHillStab and bHaltCloseEnc */
//
// }
void VerifyPericenter(BODY *body, CONTROL *control, OPTIONS *options,
char cFile[], int iBody, int iVerbose) {
/* First see if longitude of ascending node and longitude of pericenter and
* nothing else set, i.e. the user input the default parameters */
if (options[OPT_LONGA].iLine[iBody + 1] > -1 &&
options[OPT_LONGP].iLine[iBody + 1] > -1 &&
options[OPT_ARGP].iLine[iBody + 1] == -1) {
return;
}
/* If none are set, raise error */
if (options[OPT_LONGA].iLine[iBody + 1] == -1 &&
options[OPT_LONGP].iLine[iBody + 1] == -1 &&
options[OPT_ARGP].iLine[iBody + 1] == -1) {
if (iVerbose >= VERBERR) {
fprintf(stderr, "ERROR: Must set two of %s, %s, and %s in File: %s.\n",
options[OPT_LONGA].cName, options[OPT_LONGP].cName,
options[OPT_ARGP].cName, cFile);
}
exit(EXIT_INPUT);
}
/* At least 2 must be set */
if ((options[OPT_LONGA].iLine[iBody + 1] == -1 &&
options[OPT_LONGP].iLine[iBody + 1] == -1) ||
(options[OPT_LONGA].iLine[iBody + 1] == -1 &&
options[OPT_ARGP].iLine[iBody + 1] == -1) ||
(options[OPT_LONGP].iLine[iBody + 1] == -1 &&
options[OPT_ARGP].iLine[iBody + 1] == -1)) {
if (iVerbose >= VERBERR) {
fprintf(stderr, "ERROR: Must set two of %s, %s, and %s in File: %s.\n",
options[OPT_LONGA].cName, options[OPT_LONGP].cName,
options[OPT_ARGP].cName, cFile);
}
exit(EXIT_INPUT);
}
/* Were all set? */
if (options[OPT_LONGA].iLine[iBody + 1] > -1 &&
options[OPT_LONGP].iLine[iBody + 1] > -1 &&
options[OPT_ARGP].iLine[iBody + 1] > -1) {
VerifyTripleExit(options[OPT_LONGA].cName, options[OPT_LONGP].cName,
options[OPT_ARGP].cName,
options[OPT_LONGA].iLine[iBody + 1],
options[OPT_LONGP].iLine[iBody + 1],
options[OPT_ARGP].iLine[iBody + 1], cFile, iVerbose);
exit(EXIT_INPUT);
}
/* Was LONGA set? */
if (options[OPT_LONGA].iLine[iBody + 1] > -1) {
if (options[OPT_LONGP].iLine[iBody + 1] > -1) {
/* LONGA and LONGP were the only two set - Nothing to do */
return;
}
if (options[OPT_ARGP].iLine[iBody + 1] > -1) {
/* Must get radius from density */
body[iBody].dLongP = fndCalcLongP(body[iBody].dLongA, body[iBody].dArgP);
}
return;
}
/* Was LongP set? */
if (options[OPT_LONGP].iLine[iBody + 1] > -1) {
if (options[OPT_LONGA].iLine[iBody + 1] > -1) {
/* LONGA and LONGP were the only two set - Nothing to do */
return;
}
if (options[OPT_ARGP].iLine[iBody + 1] > -1) {
/* Must get radius from density */
body[iBody].dLongA = fndCalcLongA(body[iBody].dLongP, body[iBody].dArgP);
}
return;
}
}
/* In the following, iBody is the current body number that is getting assigned,
iPert counts the number of bodies perturbing iBody, and iBodyPert is the
body number of the current perturbing body. */
/* The indexing gets a bit confusing here. iPert = 0 to iGravPerts-1 correspond
to all perturbing planets, iPert = iGravPerts corresponds to the stellar
general relativistic correction, if applied. */
void InitializeHeccDistOrbRD4(BODY *body, UPDATE *update, int iBody,
int iPert) {
update[iBody]
.iaType[update[iBody].iHecc][update[iBody].iaHeccDistOrb[iPert]] = 2;
update[iBody].padDHeccDtDistOrb[iPert] =
&update[iBody].daDerivProc[update[iBody].iHecc]
[update[iBody].iaHeccDistOrb[iPert]];
update[iBody]
.iNumBodies[update[iBody].iHecc][update[iBody].iaHeccDistOrb[iPert]] =
2;
update[iBody]
.iaBody[update[iBody].iHecc][update[iBody].iaHeccDistOrb[iPert]] =
malloc(update[iBody].iNumBodies[update[iBody].iHecc]
[update[iBody].iaHeccDistOrb[iPert]] *
sizeof(int));
update[iBody]
.iaBody[update[iBody].iHecc][update[iBody].iaHeccDistOrb[iPert]][0] =
iBody;
update[iBody]
.iaBody[update[iBody].iHecc][update[iBody].iaHeccDistOrb[iPert]][1] =
body[iBody].iaGravPerts[iPert];
}
void InitializeKeccDistOrbRD4(BODY *body, UPDATE *update, int iBody,
int iPert) {
update[iBody]
.iaType[update[iBody].iKecc][update[iBody].iaKeccDistOrb[iPert]] = 2;
update[iBody].padDKeccDtDistOrb[iPert] =
&update[iBody].daDerivProc[update[iBody].iKecc]
[update[iBody].iaKeccDistOrb[iPert]];
update[iBody]
.iNumBodies[update[iBody].iKecc][update[iBody].iaKeccDistOrb[iPert]] =
2;
update[iBody]
.iaBody[update[iBody].iKecc][update[iBody].iaKeccDistOrb[iPert]] =
malloc(update[iBody].iNumBodies[update[iBody].iKecc]
[update[iBody].iaKeccDistOrb[iPert]] *
sizeof(int));
update[iBody]
.iaBody[update[iBody].iKecc][update[iBody].iaKeccDistOrb[iPert]][0] =
iBody;
update[iBody]
.iaBody[update[iBody].iKecc][update[iBody].iaKeccDistOrb[iPert]][1] =
body[iBody].iaGravPerts[iPert];
}
void InitializeHeccDistOrbGR(BODY *body, UPDATE *update, int iBody, int iPert) {
update[iBody]
.iaType[update[iBody].iHecc][update[iBody].iaHeccDistOrb[iPert]] = 2;
update[iBody].padDHeccDtDistOrb[iPert] =
&update[iBody].daDerivProc[update[iBody].iHecc]
[update[iBody].iaHeccDistOrb[iPert]];
update[iBody]
.iNumBodies[update[iBody].iHecc][update[iBody].iaHeccDistOrb[iPert]] =
2;
update[iBody]
.iaBody[update[iBody].iHecc][update[iBody].iaHeccDistOrb[iPert]] =
malloc(update[iBody].iNumBodies[update[iBody].iHecc]
[update[iBody].iaHeccDistOrb[iPert]] *
sizeof(int));
update[iBody]
.iaBody[update[iBody].iHecc][update[iBody].iaHeccDistOrb[iPert]][0] =
iBody;
update[iBody]
.iaBody[update[iBody].iHecc][update[iBody].iaHeccDistOrb[iPert]][1] = 0;
}
void InitializeKeccDistOrbGR(BODY *body, UPDATE *update, int iBody, int iPert) {
update[iBody]
.iaType[update[iBody].iKecc][update[iBody].iaKeccDistOrb[iPert]] = 2;
update[iBody].padDKeccDtDistOrb[iPert] =
&update[iBody].daDerivProc[update[iBody].iKecc]
[update[iBody].iaKeccDistOrb[iPert]];
update[iBody]
.iNumBodies[update[iBody].iKecc][update[iBody].iaKeccDistOrb[iPert]] =
2;
update[iBody]
.iaBody[update[iBody].iKecc][update[iBody].iaKeccDistOrb[iPert]] =
malloc(update[iBody].iNumBodies[update[iBody].iKecc]
[update[iBody].iaKeccDistOrb[iPert]] *
sizeof(int));
update[iBody]
.iaBody[update[iBody].iKecc][update[iBody].iaKeccDistOrb[iPert]][0] =
iBody;
update[iBody]
.iaBody[update[iBody].iKecc][update[iBody].iaKeccDistOrb[iPert]][1] = 0;
}
void InitializePincDistOrbRD4(BODY *body, UPDATE *update, int iBody,
int iPert) {
update[iBody]
.iaType[update[iBody].iPinc][update[iBody].iaPincDistOrb[iPert]] = 2;
update[iBody].padDPincDtDistOrb[iPert] =
&update[iBody].daDerivProc[update[iBody].iPinc]
[update[iBody].iaPincDistOrb[iPert]];
update[iBody]
.iNumBodies[update[iBody].iPinc][update[iBody].iaPincDistOrb[iPert]] =
2;
update[iBody]
.iaBody[update[iBody].iPinc][update[iBody].iaPincDistOrb[iPert]] =
malloc(update[iBody].iNumBodies[update[iBody].iPinc]
[update[iBody].iaPincDistOrb[iPert]] *
sizeof(int));
update[iBody]
.iaBody[update[iBody].iPinc][update[iBody].iaPincDistOrb[iPert]][0] =
iBody;
update[iBody]
.iaBody[update[iBody].iPinc][update[iBody].iaPincDistOrb[iPert]][1] =
body[iBody].iaGravPerts[iPert];
}
void InitializeQincDistOrbRD4(BODY *body, UPDATE *update, int iBody,
int iPert) {
update[iBody]
.iaType[update[iBody].iQinc][update[iBody].iaQincDistOrb[iPert]] = 2;
update[iBody].padDQincDtDistOrb[iPert] =
&update[iBody].daDerivProc[update[iBody].iQinc]
[update[iBody].iaQincDistOrb[iPert]];
update[iBody]
.iNumBodies[update[iBody].iQinc][update[iBody].iaQincDistOrb[iPert]] =
2;
update[iBody]
.iaBody[update[iBody].iQinc][update[iBody].iaQincDistOrb[iPert]] =
malloc(update[iBody].iNumBodies[update[iBody].iQinc]
[update[iBody].iaQincDistOrb[iPert]] *
sizeof(int));
update[iBody]
.iaBody[update[iBody].iQinc][update[iBody].iaQincDistOrb[iPert]][0] =
iBody;
update[iBody]
.iaBody[update[iBody].iQinc][update[iBody].iaQincDistOrb[iPert]][1] =
body[iBody].iaGravPerts[iPert];
}
void VerifyPerturbersDistOrbRD4(BODY *body, int iNumBodies, int iBody) {
int iPert = 0, j;
// body[iBody].iaGravPerts = malloc(body[iBody].iGravPerts*sizeof(int));
for (j = 1; j < iNumBodies; j++) {
if (j != iBody) {
if (body[j].bDistOrb == 0) {
fprintf(stderr, "ERROR: DistOrb must be the called for all planets\n");
exit(EXIT_INPUT);
}
body[iBody].iaGravPerts[iPert] = j;
iPert++;
}
}
}
void InitializeHeccDistOrbLL2(BODY *body, UPDATE *update, int iBody,
int iPert) {
if (body[iBody].bEqtide) {
update[iBody]
.iaType[update[iBody].iHecc][update[iBody].iaHeccDistOrb[iPert]] = 2;
} else {
update[iBody]
.iaType[update[iBody].iHecc][update[iBody].iaHeccDistOrb[iPert]] = 3;
}
update[iBody].padDHeccDtDistOrb[iPert] =
&update[iBody].daDerivProc[update[iBody].iHecc]
[update[iBody].iaHeccDistOrb[iPert]];
update[iBody]
.iNumBodies[update[iBody].iHecc][update[iBody].iaHeccDistOrb[iPert]] =
2;
update[iBody]
.iaBody[update[iBody].iHecc][update[iBody].iaHeccDistOrb[iPert]] =
malloc(update[iBody].iNumBodies[update[iBody].iHecc]
[update[iBody].iaHeccDistOrb[iPert]] *
sizeof(int));
update[iBody]
.iaBody[update[iBody].iHecc][update[iBody].iaHeccDistOrb[iPert]][0] =
iBody;
update[iBody]
.iaBody[update[iBody].iHecc][update[iBody].iaHeccDistOrb[iPert]][1] =
body[iBody].iaGravPerts[iPert];
}
void InitializeKeccDistOrbLL2(BODY *body, UPDATE *update, int iBody,
int iPert) {
if (body[iBody].bEqtide) {
update[iBody]
.iaType[update[iBody].iKecc][update[iBody].iaKeccDistOrb[iPert]] = 2;
} else {
update[iBody]
.iaType[update[iBody].iKecc][update[iBody].iaKeccDistOrb[iPert]] = 3;
}
update[iBody].padDKeccDtDistOrb[iPert] =
&update[iBody].daDerivProc[update[iBody].iKecc]
[update[iBody].iaKeccDistOrb[iPert]];
update[iBody]
.iNumBodies[update[iBody].iKecc][update[iBody].iaKeccDistOrb[iPert]] =
2;
update[iBody]
.iaBody[update[iBody].iKecc][update[iBody].iaKeccDistOrb[iPert]] =
malloc(update[iBody].iNumBodies[update[iBody].iKecc]
[update[iBody].iaKeccDistOrb[iPert]] *
sizeof(int));
update[iBody]
.iaBody[update[iBody].iKecc][update[iBody].iaKeccDistOrb[iPert]][0] =
iBody;
update[iBody]
.iaBody[update[iBody].iKecc][update[iBody].iaKeccDistOrb[iPert]][1] =
body[iBody].iaGravPerts[iPert];
}
void InitializePincDistOrbLL2(BODY *body, UPDATE *update, int iBody,
int iPert) {
update[iBody]
.iaType[update[iBody].iPinc][update[iBody].iaPincDistOrb[iPert]] = 3;
update[iBody].padDPincDtDistOrb[iPert] =
&update[iBody].daDerivProc[update[iBody].iPinc]
[update[iBody].iaPincDistOrb[iPert]];
update[iBody]
.iNumBodies[update[iBody].iPinc][update[iBody].iaPincDistOrb[iPert]] =
2;
update[iBody]
.iaBody[update[iBody].iPinc][update[iBody].iaPincDistOrb[iPert]] =
malloc(update[iBody].iNumBodies[update[iBody].iPinc]
[update[iBody].iaPincDistOrb[iPert]] *
sizeof(int));
update[iBody]
.iaBody[update[iBody].iPinc][update[iBody].iaPincDistOrb[iPert]][0] =
iBody;
update[iBody]
.iaBody[update[iBody].iPinc][update[iBody].iaPincDistOrb[iPert]][1] =
body[iBody].iaGravPerts[iPert];
}
void InitializeQincDistOrbLL2(BODY *body, UPDATE *update, int iBody,
int iPert) {
update[iBody]
.iaType[update[iBody].iQinc][update[iBody].iaQincDistOrb[iPert]] = 3;
update[iBody].padDQincDtDistOrb[iPert] =
&update[iBody].daDerivProc[update[iBody].iQinc]
[update[iBody].iaQincDistOrb[iPert]];
update[iBody]
.iNumBodies[update[iBody].iQinc][update[iBody].iaQincDistOrb[iPert]] =
2;
update[iBody]
.iaBody[update[iBody].iQinc][update[iBody].iaQincDistOrb[iPert]] =
malloc(update[iBody].iNumBodies[update[iBody].iQinc]
[update[iBody].iaQincDistOrb[iPert]] *
sizeof(int));
update[iBody]
.iaBody[update[iBody].iQinc][update[iBody].iaQincDistOrb[iPert]][0] =
iBody;
update[iBody]
.iaBody[update[iBody].iQinc][update[iBody].iaQincDistOrb[iPert]][1] =
body[iBody].iaGravPerts[iPert];
}
void VerifyPerturbersDistOrbLL2(BODY *body, int iNumBodies, int iBody) {
int iPert = 0, j;
// body[iBody].iaGravPerts = malloc(body[iBody].iGravPerts*sizeof(int));
for (j = 1; j < iNumBodies; j++) {
if (body[j].bDistOrb == 0) {
fprintf(stderr, "ERROR: DistOrb must be the called for all planets\n");
exit(EXIT_INPUT);
}
body[iBody].iaGravPerts[iPert] = j;
iPert++;
}
}
void VerifyGRCorrLL2(BODY *body, int iNumBodies) {
int iBody;
for (iBody = 2; iBody < iNumBodies; iBody++) {
if (body[iBody].bGRCorr != body[1].bGRCorr) {
fprintf(stderr, "ERROR: bGRCorr must be the same for all planets in "
"DistOrb LL2 model\n");
fprintf(stderr,"\t%s: %d\n",body[1].cName,body[1].bGRCorr);
fprintf(stderr,"\t%s: %d\n",body[iBody].cName,body[iBody].bGRCorr);
exit(EXIT_INPUT);
}
}
}
void AssignDistOrbDerivatives(BODY *body, EVOLVE *evolve, UPDATE *update,
fnUpdateVariable ***fnUpdate, int iBody) {
int iPert;
if (evolve->iDistOrbModel == RD4) {
body[iBody].iGravPerts =
evolve->iNumBodies -
2; // will need to change this for zero mass particles in future
/* The indexing gets a bit confusing here. iPert = 0 to iGravPerts-1
* correspond to all perturbing planets, iPert = iGravPerts corresponds to
* the stellar general relativistic correction, if applied */
/* Setup Semi-major axis functions (LaplaceF) for secular terms*/
if (iBody >= 1) {
/* Body updates */
for (iPert = 0; iPert < body[iBody].iGravPerts; iPert++) {
/* h = Ecc*sin(LongP) */
fnUpdate[iBody][update[iBody].iHecc]
[update[iBody].iaHeccDistOrb[iPert]] = &fndDistOrbRD4DhDt;
/* k = Ecc*cos(LongP) */
fnUpdate[iBody][update[iBody].iKecc]
[update[iBody].iaKeccDistOrb[iPert]] = &fndDistOrbRD4DkDt;
/* p = s*sin(LongA) */
fnUpdate[iBody][update[iBody].iPinc]
[update[iBody].iaPincDistOrb[iPert]] = &fndDistOrbRD4DpDt;
/* q = s*cos(LongA) */
fnUpdate[iBody][update[iBody].iQinc]
[update[iBody].iaQincDistOrb[iPert]] = &fndDistOrbRD4DqDt;
}
if (body[iBody].bGRCorr) {
/* Body updates for general relativistic correction, indexing star as a
* "perturber"*/
fnUpdate[iBody][update[iBody].iHecc]
[update[iBody].iaHeccDistOrb[body[iBody].iGravPerts]] =
&fndApsidalGRDhDt;
fnUpdate[iBody][update[iBody].iKecc]
[update[iBody].iaKeccDistOrb[body[iBody].iGravPerts]] =
&fndApsidalGRDkDt;
}
}
} else if (evolve->iDistOrbModel == LL2) {
body[iBody].iGravPerts = evolve->iNumBodies - 1;
VerifyPerturbersDistOrbLL2(body, evolve->iNumBodies, iBody);
for (iPert = 0; iPert < body[iBody].iGravPerts; iPert++) {
if (body[iBody].bEqtide) {
fnUpdate[iBody][update[iBody].iHecc]
[update[iBody].iaHeccDistOrb[iPert]] = &fndDistOrbLL2DhDt;
fnUpdate[iBody][update[iBody].iKecc]
[update[iBody].iaKeccDistOrb[iPert]] = &fndDistOrbLL2DkDt;
} else {
fnUpdate[iBody][update[iBody].iHecc]
[update[iBody].iaHeccDistOrb[iPert]] = &fndDistOrbLL2Hecc;
fnUpdate[iBody][update[iBody].iKecc]
[update[iBody].iaKeccDistOrb[iPert]] = &fndDistOrbLL2Kecc;
}
/* p = s*sin(LongA) */
fnUpdate[iBody][update[iBody].iPinc][update[iBody].iaPincDistOrb[iPert]] =
&fndDistOrbLL2Pinc;
/* q = s*cos(LongA) */
fnUpdate[iBody][update[iBody].iQinc][update[iBody].iaQincDistOrb[iPert]] =
&fndDistOrbLL2Qinc;
}
}
}
void NullDistOrbDerivatives(BODY *body, EVOLVE *evolve, UPDATE *update,
fnUpdateVariable ***fnUpdate, int iBody) {
int iPert;
if (evolve->iDistOrbModel == RD4) {
body[iBody].iGravPerts =
evolve->iNumBodies -
2; // will need to change this for zero mass particles in future
/* The indexing gets a bit confusing here. iPert = 0 to iGravPerts-1
* correspond to all perturbing planets, iPert = iGravPerts corresponds to
* the stellar general relativistic correction, if applied */
/* Setup Semi-major axis functions (LaplaceF) for secular terms*/
if (iBody >= 1) {
/* Body updates */
for (iPert = 0; iPert < body[iBody].iGravPerts; iPert++) {
/* h = Ecc*sin(LongP) */
fnUpdate[iBody][update[iBody].iHecc]
[update[iBody].iaHeccDistOrb[iPert]] = &fndUpdateFunctionTiny;
/* k = Ecc*cos(LongP) */
fnUpdate[iBody][update[iBody].iKecc]
[update[iBody].iaKeccDistOrb[iPert]] = &fndUpdateFunctionTiny;
/* p = s*sin(LongA) */
fnUpdate[iBody][update[iBody].iPinc]
[update[iBody].iaPincDistOrb[iPert]] = &fndUpdateFunctionTiny;
/* q = s*cos(LongA) */
fnUpdate[iBody][update[iBody].iQinc]
[update[iBody].iaQincDistOrb[iPert]] = &fndUpdateFunctionTiny;
}
if (body[iBody].bGRCorr) {
/* Body updates for general relativistic correction, indexing star as a
* "perturber"*/
fnUpdate[iBody][update[iBody].iHecc]
[update[iBody].iaHeccDistOrb[body[iBody].iGravPerts]] =
&fndUpdateFunctionTiny;