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
// JEOD_INV: TS.01 — `<SelfRef>` is used here at the typed↔raw kernel-boundary helpers (named-method opt-in; the implicit `From<RotationalState>` / `From<MassProperties>` bypass was removed in #397).
//! Body lifecycle, accessors, setters, and contact-pair registration
//! for [`super::Simulation`].
//!
//! Methods: `register_contact_pair`, `num_contact_pairs`, `add_body`,
//! `body`, `convert_body_trans_core_to_composite`, `body_core_inertial`,
//! `subtree_composite_inertial`, `srp_plate_temperatures`, body setters
//! (`set_body_external_force`, `set_body_external_torque`,
//! `set_body_position`, `set_body_velocity`, `set_body_mass`),
//! `sync_body_mass_from_tree`.
use glam::DVec3;
use astrodyn::typed_bridge::{
mass_raw_to_self_ref, mass_typed_to_raw, rot_raw_to_self_ref, rot_typed_to_raw,
trans_typed_to_raw,
};
use astrodyn::{
evaluate_ground_contact_pair, ContactFacet, DragConfig, GroundFacet, IntegrationFrame,
MassBodyId, MassPointState, MassProperties, MassPropertiesTyped, Phase, Position, RefFrameRot,
RefFrameState, RefFrameTrans, SelfRef, VehicleConfig, Velocity,
};
use super::types::{
ContactPairConfig, GroundContactImpulse, GroundContactPairConfig, SimBody, VehicleOutput,
};
use super::Simulation;
impl Simulation {
/// Register a contact interaction between two bodies.
///
/// Once registered, contact forces between these facets are evaluated at
/// each RK4 stage of [`step`](Self::step). This matches JEOD's
/// derivative-class `check_contact()` scheduling in `SIM_contact`.
///
/// The force acts on body A (`facet_a`); the equal-and-opposite force
/// acts on body B. Torques are accumulated about each body's CoM.
///
/// # Panics
/// * Called after the first [`step`](Self::step). Contact-pair
/// registration must precede integration — see
/// [`Simulation::has_stepped`](super::Simulation) for the rationale.
/// * Either `body_a` or `body_b` is out of range for the registered bodies.
/// * `body_a == body_b` — contact pair bodies must be distinct
/// (JEOD_INV: IN.30, matching JEOD's `unique_pair` invariant).
/// * `facet_a.material != facet_b.material`. JEOD parks the
/// spring/damper/friction parameters on a single `SpringPairInteraction`
/// per pair, so both facets must carry identical
/// [`ContactMaterial`](astrodyn::ContactMaterial) values.
/// Panic here instead of deferring until the first integrator step.
pub fn register_contact_pair(
&mut self,
body_a: usize,
facet_a: ContactFacet,
body_b: usize,
facet_b: ContactFacet,
) {
// Reject late registration: see `Simulation::has_stepped`.
assert!(
!self.has_stepped,
"register_contact_pair: contact-pair registration must precede the first \
`step()` — registering after integration starts would inject a t=0 init-phase \
impulse into a running trajectory"
);
assert!(
body_a < self.bodies.len(),
"register_contact_pair: body_a index {body_a} out of range ({} bodies)",
self.bodies.len()
);
assert!(
body_b < self.bodies.len(),
"register_contact_pair: body_b index {body_b} out of range ({} bodies)",
self.bodies.len()
);
// JEOD_INV: IN.30 — contact pair bodies must be distinct (JEOD `unique_pair`)
assert_ne!(
body_a, body_b,
"register_contact_pair: body A and body B must be distinct (got both = {body_a})"
);
// JEOD pairs a single `SpringPairInteraction` to each facet pair, so
// both facets must carry identical material parameters. Enforce here
// rather than inside `compute_contact_force` at first step.
assert_eq!(
facet_a.material, facet_b.material,
"register_contact_pair: facet_a.material and facet_b.material must be equal \
(JEOD pairs a single SpringPairInteraction to each facet pair)"
);
self.contact_pairs.push(ContactPairConfig {
body_a,
facet_a,
body_b,
facet_b,
});
}
/// Number of registered contact pairs.
pub fn num_contact_pairs(&self) -> usize {
self.contact_pairs.len()
}
/// Register a ground-contact interaction between a vehicle and a
/// planetary surface.
///
/// Once registered, ground contact forces on `body_a` are evaluated
/// at each RK4 stage of [`step`](Self::step) — matching JEOD's
/// derivative-class `check_contact_ground()` job in
/// `SIM_ground_contact/S_modules/contact.sm`.
///
/// The first call also pins the planet source whose `pfix` rotation
/// will be queried for terrain lookups; subsequent registrations must
/// use the same `planet_source`. For [`SphericalTerrain`](astrodyn::SphericalTerrain)
/// the pfix rotation cancels in the ground-point computation and
/// `planet_source` is documentation-only — but we still validate
/// consistency to keep ground-contact registrations explicit.
///
/// # Panics
/// * Called after the first [`step`](Self::step). Ground-contact-pair
/// registration must precede integration — see
/// [`Simulation::has_stepped`](super::Simulation) for the rationale.
/// * `body_a` is out of range for the registered bodies.
/// * `body_a` lacks a `RotationalState` or [`MassProperties`]
/// (ground contact requires 6-DOF + mass — checked here so the
/// coupled-RK4 path can rely on it without re-checking per stage).
/// * `vehicle_facet.material != ground_facet.material` (JEOD pairs a
/// single `SpringPairInteraction` per facet pair).
/// * `ground_facet.active == false` (JEOD_INV: IN.35).
/// * `ground_facet.alt_offset` is not finite (JEOD_INV: IN.36).
/// * `planet_source` is out of range for the registered gravity
/// sources, or differs from a previously-registered ground-contact
/// pair's `planet_source` (all ground pairs must share one
/// `pfix` rotation).
pub fn register_ground_contact_pair(
&mut self,
body_a: usize,
vehicle_facet: ContactFacet,
ground_facet: GroundFacet,
planet_source: usize,
) {
// Reject late registration: `pending_initial_impulse` is
// computed against `t=0` body state below and consumed at
// stage 1 of the first step. Registering mid-run would inject
// that impulse into an already-propagating trajectory. See
// `Simulation::has_stepped`.
assert!(
!self.has_stepped,
"register_ground_contact_pair: ground-contact-pair registration must precede \
the first `step()` — registering after integration starts would inject a t=0 \
init-phase impulse into a running trajectory"
);
assert!(
body_a < self.bodies.len(),
"register_ground_contact_pair: body_a index {body_a} out of range ({} bodies)",
self.bodies.len()
);
// JEOD pairs a single SpringPairInteraction per facet pair. Both
// sides carry identical material (vehicle "steel" vs ground
// "dirt" reduce to a single pair material in JEOD's lookup).
assert_eq!(
vehicle_facet.material, ground_facet.material,
"register_ground_contact_pair: vehicle_facet.material and \
ground_facet.material must be equal (JEOD pairs a single \
SpringPairInteraction per facet pair)"
);
// JEOD_INV: IN.35 — only active GroundFacets contribute force.
assert!(
ground_facet.active,
"register_ground_contact_pair: ground_facet.active must be true"
);
// JEOD_INV: IN.36 — alt_offset must be finite.
assert!(
ground_facet.alt_offset.is_finite(),
"register_ground_contact_pair: ground_facet.alt_offset must be finite, got {}",
ground_facet.alt_offset
);
assert!(
planet_source < self.gravity_data.len(),
"register_ground_contact_pair: planet_source index {planet_source} out of range \
({} sources)",
self.gravity_data.len()
);
match self.ground_contact_planet_source {
None => self.ground_contact_planet_source = Some(planet_source),
Some(prev) => assert_eq!(
prev, planet_source,
"register_ground_contact_pair: all ground-contact pairs must reference the \
same planet source (got {planet_source}, previously registered with {prev})"
),
}
// Compute JEOD's initialization-time impulse (pre-propagation
// `GroundInteraction::initialize → in_contact()` with
// `vp.state.trans.position == (0, 0, 0)`). This is the impulsive
// force JEOD records on `subject->force` during init and that
// the integrator consumes at stage 1 of the first step.
//
// For non-spherical Terrain implementations, the pfix rotation
// matters in the ground-point computation, so we fetch the
// current value from the frame tree. SphericalTerrain happens
// to cancel the rotation out, but we don't special-case it
// here — the matrix is correct for whatever Terrain the caller
// provides. Callers using non-trivial planet rotation should
// ensure ephemeris/RNP has been propagated before
// registering ground-contact pairs; for SphericalTerrain it
// doesn't matter.
let t_inertial_pfix = self.source_frame_ids[planet_source]
.pfix
.map(|pfix_id| self.frame_tree.get(pfix_id).state.rot.t_parent_this)
.unwrap_or(glam::DMat3::IDENTITY);
let body = &self.bodies[body_a];
let body_rot = body.rot.as_ref().unwrap_or_else(|| {
panic!(
"register_ground_contact_pair: body_a={body_a} has no RotationalState; \
ground contact requires 6-DOF (set `rot: Some(RotationalStateTyped::<SelfRef>::new(...))` on the VehicleConfig)"
)
});
let body_mass = body.mass.as_ref().unwrap_or_else(|| {
panic!(
"register_ground_contact_pair: body_a={body_a} has no MassProperties; \
set `mass: Some(MassPropertiesTyped::<SelfRef>::with_inertia(...))` on the VehicleConfig"
)
});
// allowed: typed↔raw kernel boundary — `body.trans` is
// `TranslationalStateTyped<IntegrationFrame>` after #258;
// `evaluate_ground_contact_pair` takes the untyped form.
let trans_untyped = trans_typed_to_raw(&body.trans);
let body_rot_untyped = rot_typed_to_raw(body_rot);
let body_mass_untyped = mass_typed_to_raw(body_mass);
let pending_initial_impulse = evaluate_ground_contact_pair(
&vehicle_facet,
&ground_facet,
&trans_untyped,
&body_rot_untyped,
body.t_struct_body,
&body_mass_untyped,
t_inertial_pfix,
Phase::Initialization,
)
.map(|eval| GroundContactImpulse {
force_inertial: eval.force_on_a,
torque_body: eval.torque_a_body,
});
self.ground_contact_pairs.push(GroundContactPairConfig {
body_a,
vehicle_facet,
ground_facet,
pending_initial_impulse,
});
}
/// Number of registered ground-contact pairs.
pub fn num_ground_contact_pairs(&self) -> usize {
self.ground_contact_pairs.len()
}
/// Add a dynamic body from a [`VehicleConfig`]. Returns its index.
///
/// The config is consumed and converted into internal state. Creates a
/// body frame in the frame tree under the integration frame. Use
/// [`body`](Simulation::body) to access results after stepping.
pub fn add_body(&mut self, config: VehicleConfig) -> usize {
let idx = self.bodies.len();
// Resolve integration frame from the config-carried source
// identity (issue #668).
let integ_frame_id = config
.integ_source
.as_ref()
.map(|uid| {
let src = self.source_idx_for_uid(uid).unwrap_or_else(|| {
panic!(
"VehicleConfig::integ_source `{uid}` does not resolve to a \
registered gravity source; {} source(s) configured. Register \
the source (add_source / add_source_typed) before adding the \
body, or fix the identity.",
self.source_frame_ids.len()
)
});
self.source_frame_ids[src].inertial
})
.unwrap_or(self.root_frame_id);
// RFS-303: the resolved integration frame's identity is asserted,
// not assumed — identity is required at construction (issue #664),
// so only the class-eligibility half needs a runtime check.
let integ_uid = self.frame_tree.get(integ_frame_id).uid().clone();
// JEOD_INV: RF.10 — a body may only integrate in a root- or
// planet-inertial frame; integrating in a rotating frame without
// fictitious-force treatment is silently wrong physics.
assert!(
integ_uid.class.may_be_root_or_integ(),
"add_body: body {idx}'s integration frame has identity `{integ_uid}` \
(class {:?}), which is not eligible to host integration (only \
RootInertial / PlanetInertial / BarycenterInertial classes are). Set \
VehicleConfig::integ_source to a planet's inertial source, or leave it \
None to integrate in the root frame.",
integ_uid.class
);
// Create body frame in tree under the integration frame, stamped
// with the mission-supplied identity carried by the config.
let body_frame_id = self.frame_tree.add_child_uid(
integ_frame_id,
config.frame_uid.clone(),
format!("body_{idx}.integ"),
RefFrameState {
trans: RefFrameTrans {
// VehicleConfig::trans is typed `<RootInertial>`; the
// frame tree node stores raw DVec3 in parent-frame
// coordinates, so unwrap to raw here.
position: config.trans.position.raw_si(),
velocity: config.trans.velocity.raw_si(),
},
rot: RefFrameRot::default(),
},
Some(self.time.tdb()),
);
self.bodies
.push(SimBody::from_config(config, integ_frame_id, body_frame_id));
idx
}
/// The resolved identity of `body_idx`'s integration frame —
/// `RootInertial` or a `PlanetInertial<P>`, never the
/// `IntegrationFrame` marker (RF.10: the marker resolves per body;
/// the runner publishes the resolution).
pub fn body_integ_frame_uid(&self, body_idx: usize) -> &astrodyn::FrameUid {
assert!(
body_idx < self.bodies.len(),
"body_integ_frame_uid: body index {body_idx} out of range ({} bodies)",
self.bodies.len()
);
self.frame_tree
.get(self.bodies[body_idx].integ_frame_id)
.uid()
}
// JEOD_INV: DS.01 — derived state config immutable after init; read-only access only
/// Get the current output state of a body by index.
///
/// Returns a [`VehicleOutput`] containing the current integrated state
/// plus any derived states that were configured.
pub fn body(&self, idx: usize) -> VehicleOutput {
self.bodies[idx].output()
}
/// Mass-tree id of the body at index `idx`, or `None` if the body
/// was added without a mass-tree registration (e.g. a fixed
/// gravity source). Test code that needs to read live mass-tree
/// state for assertions on composite mass / parent topology after
/// runtime attach/detach uses this to translate the body index it
/// holds into the [`MassBodyId`] the [`MassTree`] indexes by.
///
/// [`MassTree`]: astrodyn::MassTree
/// Frame-tree node id of the body's `composite_body` reference
/// frame.
///
/// Exposed so callers that need to look up the body's pose in a
/// non-integration parent frame (e.g. JEOD's
/// `RUN_attach_to_ref_frame` "capture pre-attach pfix-relative
/// pose" pattern) can pass the id to
/// [`FrameTree::compute_relative_state`](astrodyn::FrameTree::compute_relative_state)
/// via [`Self::frame_tree`]. The id is stable for the lifetime of
/// the simulation — `add_body` allocates it once and never reuses
/// it.
///
/// # Panics
/// Panics if `idx` is out of range.
pub fn body_frame_id(&self, idx: usize) -> astrodyn::FrameId {
assert!(
idx < self.bodies.len(),
"body_frame_id: body index {idx} out of range (have {} bodies)",
self.bodies.len()
);
self.bodies[idx].body_frame_id
}
/// Mass-tree node id of body `idx`, or `None` if the body has not
/// been registered via [`Self::add_body_to_tree`]. Stable for the
/// lifetime of the simulation.
pub fn body_mass_id(&self, idx: usize) -> Option<MassBodyId> {
self.bodies[idx].mass_body_id
}
/// Mass / inertia / CoM-offset block for the body at index `idx`,
/// or `None` for 3-DOF bodies that were configured without a
/// `MassPropertiesTyped`. Mirrors JEOD's
/// `dyn_body.mass.composite_properties` accessor for atomic
/// (non-mass-tree) bodies — for tree-attached bodies the live
/// composite is recomputed in the mass tree, but the per-body
/// `MassPropertiesTyped` carried here still reflects the body's own
/// mass properties at its structural origin. Used by the JEOD
/// surface-attach test fixtures that need to compute the body's
/// structure pose from its composite-body inertial state.
///
/// # Panics
/// Panics if `idx` is out of range.
pub fn body_mass(&self, idx: usize) -> Option<&MassPropertiesTyped<SelfRef>> {
assert!(
idx < self.bodies.len(),
"body_mass: body index {idx} out of range (have {} bodies)",
self.bodies.len()
);
self.bodies[idx].mass.as_ref()
}
/// Adjust an integrated body's `trans` from a `core_body` inertial
/// state to the corresponding `composite_body` inertial state,
/// using the current mass tree's `core_wrt_composite` offset.
///
/// JEOD's integration variable is `composite_body`; at init time,
/// however, callers often have JEOD-published values that were
/// logged from `core_body` (as in our `tier3_sim_apollo_trajectory`
/// reference CSV). Use this once after the mass tree has reached
/// its initial topology to flip the interpretation.
///
/// `body.rot` is unchanged — composite and core share body axes
/// (see `body_core_inertial` for the full convention).
///
/// # Panics
/// Panics if the body is not registered in the mass tree, or has
/// no rotational state.
pub fn convert_body_trans_core_to_composite(&mut self, idx: usize) {
let cw_inertial;
let dvel_inertial;
{
let body = &self.bodies[idx];
let mass_body_id = body.mass_body_id.expect(
"convert_body_trans_core_to_composite: body is not registered in the mass tree",
);
let tree = self
.mass_tree
.as_ref()
.expect("convert_body_trans_core_to_composite: no mass tree configured");
let node = tree.get(mass_body_id);
let cw_struct = node.core_wrt_composite.position;
let t_struct_to_body = node.composite_properties.t_parent_this;
let cw_body = t_struct_to_body * cw_struct;
let body_rot = body
.rot
.expect("convert_body_trans_core_to_composite: 6-DOF body required");
let t_inertial_to_body = body_rot
.q_inertial_body
.as_witness()
.left_quat_to_transformation();
let t_body_to_inertial = t_inertial_to_body.transpose();
cw_inertial = t_body_to_inertial * cw_body;
dvel_inertial = t_body_to_inertial * body_rot.ang_vel_body.raw_si().cross(cw_body);
}
// composite = core − cw_inertial; subtract the rigid-body
// ω × r contribution on velocity. All values stay in the body's
// integration frame.
let trans = &mut self.bodies[idx].trans;
trans.position =
Position::<IntegrationFrame>::from_raw_si(trans.position.raw_si() - cw_inertial);
trans.velocity =
Velocity::<IntegrationFrame>::from_raw_si(trans.velocity.raw_si() - dvel_inertial);
}
/// Derive the integrated body's `core_body` inertial position +
/// velocity from its `composite_body` integration state and the
/// current mass tree.
///
/// JEOD integrates `composite_body` (matching
/// `DynamicsIntegrationGroup::gravitation()` and
/// `DynBody::trans_integ()`), so during stages 1–6 of the JEOD
/// integration loop `body.trans` represents the composite. The
/// `core_body` frame is the per-body CoM, derived via the mass
/// tree's `core_wrt_composite` offset rotated to inertial.
///
/// In our mass tree `composite_properties.t_parent_this` is left
/// equal to `core_properties.t_parent_this` (set per-body at init,
/// not re-derived for the merged composite), so composite and core
/// share body axes — only position and velocity differ. Returns
/// `(position, velocity)` in the body's integration-frame inertial
/// coordinates (same frame as `body.trans`).
///
/// # Panics
/// Panics if the body is not registered in the mass tree, or if
/// the body has no rotational state (6-DOF required to derive the
/// kinematic offset).
pub fn body_core_inertial(&self, idx: usize) -> (DVec3, DVec3) {
let body = &self.bodies[idx];
let mass_body_id = body
.mass_body_id
.expect("body_core_inertial: body is not registered in the mass tree");
let tree = self
.mass_tree
.as_ref()
.expect("body_core_inertial: no mass tree configured");
let node = tree.get(mass_body_id);
let core_wrt_composite_struct = node.core_wrt_composite.position;
// Struct → composite-body rotation (composite shares core's body axes).
let t_struct_to_body = node.composite_properties.t_parent_this;
let cw_body = t_struct_to_body * core_wrt_composite_struct;
// Body → inertial via T_inertial_to_body⁻¹ = T_inertial_to_body.transpose().
let body_rot = body.rot.expect("body_core_inertial: 6-DOF body required");
let t_inertial_to_body = body_rot
.q_inertial_body
.as_witness()
.left_quat_to_transformation();
let t_body_to_inertial = t_inertial_to_body.transpose();
let cw_inertial = t_body_to_inertial * cw_body;
let core_position = body.trans.position.raw_si() + cw_inertial;
// v_core = v_composite + ω × r (in inertial frame). ω in body
// frame is body.rot.ang_vel_body; rotate the cross-product to
// inertial.
let omega_body = body_rot.ang_vel_body.raw_si();
let core_velocity =
body.trans.velocity.raw_si() + t_body_to_inertial * omega_body.cross(cw_body);
(core_position, core_velocity)
}
/// Resolve the `composite_body` inertial state of any mass-tree body,
/// regardless of whether it is the integrated body, attached as a
/// child of the integrated body, or the root of a detached subtree.
///
/// Walks to the tree root, reads the root's inertial composite state
/// from either the integrated-body slot ([`Self::body`]) or the
/// [`Self::detached_subtrees`] map (when the root is detached), then
/// chain-walks down to `target_id` using the same body-aware step as
/// [`Self::detach_subtree`] (with [`astrodyn::propagate_forward`]
/// at each level).
///
/// This mirrors what JEOD's truth recorder logs for `lm_dyn.composite_body`
/// regardless of the LM's current attach state — the
/// `tier3_sim_apollo_lm_state_vs_truth` diagnostic compares against
/// `apollo_attach_truth.csv` rows produced by that same recorder.
///
/// # Panics
/// Panics if no mass tree is configured, `target_id` is not in the
/// tree, the root has no integrated body and no detached-subtree
/// entry, or the integrated root is missing rotational state.
pub fn subtree_composite_inertial(&self, target_id: MassBodyId) -> RefFrameState {
let tree = self
.mass_tree
.as_ref()
.expect("subtree_composite_inertial: no mass tree configured");
// Walk to root.
let mut root_id = target_id;
while let Some(p) = tree.parent(root_id) {
root_id = p;
}
// Resolve the root's inertial composite_body state.
let integrated_idx = self
.bodies
.iter()
.position(|b| b.mass_body_id == Some(root_id));
let root_state: RefFrameState = if let Some(idx) = integrated_idx {
let body = &self.bodies[idx];
let body_rot = body.rot.expect(
"subtree_composite_inertial: integrated root has no rotational state \
(6-DOF required)",
);
RefFrameState {
trans: RefFrameTrans {
position: body.trans.position.raw_si(),
velocity: body.trans.velocity.raw_si(),
},
rot: RefFrameRot {
q_parent_this: body_rot.q_inertial_body.to_jeod_quat(),
t_parent_this: body_rot
.q_inertial_body
.as_witness()
.left_quat_to_transformation(),
ang_vel_this: body_rot.ang_vel_body.raw_si(),
},
}
} else if let Some(detached) = self.detached_subtrees.get(&root_id) {
detached.to_ref_frame_state()
} else {
panic!(
"subtree_composite_inertial: tree root {root_id:?} for target \
{target_id:?} has no integrated body and no detached-subtree entry"
);
};
// Build the chain root → target and walk down with the body-aware step.
let mut chain = Vec::<MassBodyId>::new();
let mut cur = target_id;
while cur != root_id {
chain.push(cur);
cur = tree.parent(cur).expect(
"subtree_composite_inertial: chain walk hit a parentless intermediate \
(target lost its parent during traversal)",
);
}
chain.reverse();
let mut current_state = root_state;
let mut current_node_id = root_id;
for next_id in chain {
let next_node = tree.get(next_id);
let current_node = tree.get(current_node_id);
let t_current_struct_to_body = current_node.composite_properties.t_parent_this;
let t_next_struct_to_body = next_node.composite_properties.t_parent_this;
let offset_struct =
next_node.composite_wrt_pstr.position - current_node.composite_properties.position;
let offset_in_current_body = t_current_struct_to_body * offset_struct;
let t_current_body_to_next_body = t_next_struct_to_body
* next_node.structure_point.t_parent_this
* t_current_struct_to_body.transpose();
let rel = MassPointState {
position: offset_in_current_body,
t_parent_this: t_current_body_to_next_body,
};
current_state = astrodyn::propagate_forward(¤t_state, &rel);
current_node_id = next_id;
}
current_state
}
/// Read the current per-plate temperatures (K) for a body's flat-plate
/// SRP configuration, or `None` if the body has no flat-plate SRP.
///
/// Useful for unit tests and data recording; returns a reference so no
/// allocation is needed for the common steady-state case.
pub fn srp_plate_temperatures(&self, body_idx: usize) -> Option<&[f64]> {
self.bodies[body_idx]
.flat_plate_state
.as_ref()
.map(|fps| fps.temperatures.as_slice())
}
/// Set the externally applied force (inertial frame, N) for a body.
///
/// Added to `total_force.force` each step after force collection.
///
/// Prefer [`set_body_external_force_typed`](Self::set_body_external_force_typed)
/// for the typed-input path; the raw entry point stays for callers
/// that have not yet migrated.
pub fn set_body_external_force(&mut self, idx: usize, force: DVec3) {
self.bodies[idx].external_force = force;
}
/// Typed sibling of [`set_body_external_force`](Self::set_body_external_force).
/// The `Force<RootInertial>` argument's phantom enforces at compile
/// time that the value is in the root-inertial frame, matching the
/// `external_force` storage convention.
pub fn set_body_external_force_typed(
&mut self,
idx: usize,
force: astrodyn::Force<astrodyn::RootInertial>,
) {
self.set_body_external_force(idx, force.raw_si());
}
/// Set the externally applied torque (body frame, N*m) for a body.
///
/// Added to `total_force.torque` each step after force collection.
///
/// Prefer [`set_body_external_torque_typed`](Self::set_body_external_torque_typed)
/// for the typed-input path; the raw entry point stays for callers
/// that have not yet migrated.
pub fn set_body_external_torque(&mut self, idx: usize, torque: DVec3) {
self.bodies[idx].external_torque = torque;
}
/// Typed sibling of [`set_body_external_torque`](Self::set_body_external_torque).
/// The `Torque<BodyFrame<SelfRef>>` argument's phantom enforces at
/// compile time that the value is expressed in the body frame.
pub fn set_body_external_torque_typed(
&mut self,
idx: usize,
torque: astrodyn::Torque<astrodyn::BodyFrame<astrodyn::SelfRef>>,
) {
self.set_body_external_torque(idx, torque.raw_si());
}
/// Set the externally applied force in the body's structural frame
/// (N).
///
/// Mirrors JEOD's `Force` model
/// (`models/dynamics/dyn_body/include/force.hh`): the force vector
/// is expressed in the structural frame of the body it acts on, and
/// rotated to inertial at force-collection time using the body's
/// current attitude. This is what the Tier 3
/// `SIM_verif_attach_detach` `RUN_compute_child_derivative` Trick
/// `add_read` snippets actually toggle (`veh1.force.force = […]`
/// in `input.py`).
///
/// The previous inertial-frame
/// [`set_body_external_force`](Self::set_body_external_force) entry
/// point is preserved for callers that already produce
/// inertial-frame contributions (custom thrusters, debugging, etc.);
/// the two contribute additively at force collection.
///
/// Prefer [`set_body_external_force_struct_typed`](Self::set_body_external_force_struct_typed)
/// for the typed-input path.
pub fn set_body_external_force_struct(&mut self, idx: usize, force_struct: DVec3) {
self.bodies[idx].external_force_struct = force_struct;
}
/// Typed sibling of [`set_body_external_force_struct`](Self::set_body_external_force_struct).
/// The `Force<StructuralFrame<SelfRef>>` argument's phantom enforces
/// at compile time that the value is in the body's structural frame.
pub fn set_body_external_force_struct_typed(
&mut self,
idx: usize,
force_struct: astrodyn::Force<astrodyn::StructuralFrame<astrodyn::SelfRef>>,
) {
self.set_body_external_force_struct(idx, force_struct.raw_si());
}
/// Set the externally applied torque in the body's structural frame
/// (N·m).
///
/// Mirrors JEOD's `Torque` model. Rotated to body frame at force
/// collection via the body's structural-to-body transform; companion
/// to [`set_body_external_force_struct`](Self::set_body_external_force_struct).
///
/// Prefer [`set_body_external_torque_struct_typed`](Self::set_body_external_torque_struct_typed)
/// for the typed-input path.
pub fn set_body_external_torque_struct(&mut self, idx: usize, torque_struct: DVec3) {
self.bodies[idx].external_torque_struct = torque_struct;
}
/// Typed sibling of [`set_body_external_torque_struct`](Self::set_body_external_torque_struct).
/// The `Torque<StructuralFrame<SelfRef>>` argument's phantom enforces
/// at compile time that the value is in the body's structural frame.
pub fn set_body_external_torque_struct_typed(
&mut self,
idx: usize,
torque_struct: astrodyn::Torque<astrodyn::StructuralFrame<astrodyn::SelfRef>>,
) {
self.set_body_external_torque_struct(idx, torque_struct.raw_si());
}
/// Set a body's translational position (inertial frame, m).
///
/// Used for prescribed-motion tests where position is set externally
/// at each timestep (e.g., SIM_2A_SHADOW_CALC).
pub fn set_body_position(&mut self, idx: usize, position: DVec3) {
self.bodies[idx].trans.position = Position::<IntegrationFrame>::from_raw_si(position);
let fid = self.bodies[idx].body_frame_id;
self.frame_tree.get_mut(fid).state.trans.position = position;
}
/// Set a body's translational velocity (inertial frame, m/s).
///
/// Used for impulsive maneuvers (e.g., Apollo TLI delta-V).
pub fn set_body_velocity(&mut self, idx: usize, velocity: DVec3) {
self.bodies[idx].trans.velocity = Velocity::<IntegrationFrame>::from_raw_si(velocity);
let fid = self.bodies[idx].body_frame_id;
self.frame_tree.get_mut(fid).state.trans.velocity = velocity;
}
/// Replace a body's rotational state (attitude quaternion + body
/// angular velocity).
///
/// Companion to [`set_body_position`](Self::set_body_position) /
/// [`set_body_velocity`](Self::set_body_velocity) for tests and
/// scenarios that need to override the recipe-derived initial
/// rotational state (e.g., the `tier3_sim_ref_attach` Tier 3 test
/// initializes the SIM_ref_attach target vehicle's YPR attitude).
/// Panics if the body has no rotational state slot — call
/// [`add_body`](Self::add_body) with `VehicleConfig::rot = Some(...)`
/// to register a 6-DOF body first.
pub fn set_body_rot(&mut self, idx: usize, rot: astrodyn::RotationalState) {
assert!(
self.bodies[idx].rot.is_some(),
"set_body_rot: body {idx} is 3-DOF (no `RotationalState` slot). \
Spawn the body with `VehicleConfig::rot = Some(...)` first if \
rotational integration is needed; otherwise leave the body \
3-DOF and don't call this setter."
);
// allowed: typed↔raw kernel-boundary lift at the public API
// setter (named-method opt-in; the implicit `.into()` bypass
// was removed in #397).
self.bodies[idx].rot = Some(rot_raw_to_self_ref(&rot));
// Mirror the rotational state onto the body's frame-tree node so
// downstream consumers — `compute_relative_state` walks that
// traverse through it, or another body attaching to *this*
// body's frame — see the freshly written attitude / angular
// velocity instead of the previous step's value. JEOD's
// `RefFrameState` carries both translational and rotational
// state by definition; the per-component setters
// `set_body_position` / `set_body_velocity` already mirror their
// half, and the frame-attached integration sync in
// `propagate_frame_attached_state` mirrors both halves at the
// end of every step. Leaving `rot` out of this setter would
// silently desync the node until the next integration tick,
// producing wrong relative-state lookups against this body in
// the meantime.
let fid = self.bodies[idx].body_frame_id;
let node = self.frame_tree.get_mut(fid);
node.state.rot.q_parent_this = rot.quaternion;
// JEOD_INV: RF.04 — recompute T_parent_this from the new
// q_parent_this so callers reading either form see the same
// attitude.
node.state.rot.t_parent_this = rot.quaternion.left_quat_to_transformation();
node.state.rot.ang_vel_this = rot.ang_vel_body;
}
/// Replace a body's mass properties.
///
/// Used for discrete mass changes (e.g., post-burn fuel consumption,
/// stage separation). Recomputes `inverse_mass` and `inverse_inertia`.
///
/// **Warning:** If the body is registered in the mass tree, calling this
/// method will desynchronize the body's mass from the tree's copy. Use
/// [`sync_body_mass_from_tree`](Self::sync_body_mass_from_tree) instead
/// when the mass tree has been modified via `attach`/`detach`.
pub fn set_body_mass(&mut self, idx: usize, mut mass: MassProperties) {
mass.dirty = true;
mass.recompute_derived();
// allowed: typed↔raw kernel-boundary lift at the public API
// setter (named-method opt-in; see #397).
self.bodies[idx].mass = Some(mass_raw_to_self_ref(&mass));
}
/// Toggle a body's aerodynamic drag configuration mid-run.
///
/// `Some(cfg)` enables drag with the supplied parameters; the
/// body's atmospheric-state slot is unconditionally present and
/// the next `Simulation::step()` will fill it via the atmosphere
/// stage (gated on `body.drag.is_some()`). `None` disables drag
/// and resets the cached atmospheric state to `default()` so a
/// subsequent re-enable starts from a clean slot rather than a
/// stale density from before the toggle.
///
/// Used by Tier 3 sims that toggle the atmosphere mid-trajectory
/// (`SIM_dyncomp/RUN_attach_to_ref_frame` disables atmosphere at
/// the surface-attach windows so the MET model doesn't trip its
/// negative-altitude failure mode while the body is glued to
/// Earth.pfix at altitude=1 m). Mirrors the JEOD-side
/// `trick.exec_set_job_onoff("vehicle.atmos_state.update_state",
/// 2, False/True)` pattern, except per-body rather than
/// per-job-name.
///
/// # Panics
/// Panics if `idx` is out of range.
pub fn set_body_drag(&mut self, idx: usize, drag: Option<DragConfig>) {
assert!(
idx < self.bodies.len(),
"set_body_drag: body index {idx} out of range (have {} bodies)",
self.bodies.len()
);
if drag.is_none() {
// Reset the cached atmospheric state when drag is turned
// off so the slot doesn't leak stale density values into
// any later re-enable cycle. The atmosphere-evaluation
// pass is already gated on `body.drag.is_some()`, so the
// slot's contents are inert while drag is off — clearing
// is purely hygienic, mirroring the pre-migration
// `atmospheric_state = None` behavior.
self.bodies[idx].atmospheric_state = astrodyn::AtmosphereState::default();
}
self.bodies[idx].drag = drag;
}
/// Sync a body's mass properties from the mass tree's composite.
///
/// After modifying the mass tree via direct `tree.attach` / `tree.detach`
/// calls (i.e., obtained via `sim.mass_tree.as_mut()`), call this to
/// update the body's mass from the tree's composite properties.
///
/// This method is the **documented sync point** for the
/// `tree.attach`/`tree.detach` + `sync_body_mass_from_tree` path, which
/// is the lower-level alternative to the high-level
/// [`attach`](Self::attach) / [`detach`](Self::detach) /
/// [`detach_subtree`](Self::detach_subtree) /
/// [`attach_subtree_aligned`](Self::attach_subtree_aligned) methods.
/// JEOD's `dyn_body_attach.cc::reset_integrators()` (lines 860, 871)
/// and `dyn_body_detach.cc:271-273` reset multi-step integrator
/// (Gauss-Jackson, ABM4) predictor/corrector history on every topology
/// change; this method mirrors that behavior so the lower-level path
/// stays IG.37-safe by construction. Without this, a Gauss-Jackson or
/// ABM4 caller using `tree.attach` + `sync_body_mass_from_tree` would
/// silently propagate stale predictor history across the topology
/// change, producing wrong physics with no panic.
///
/// Single-step integrators (RK4, RKF4(5)) carry no per-step history
/// and are no-ops in the reset, so applying the reset unconditionally
/// here is safe regardless of the body's chosen integrator.
///
/// # Sync every affected body, not just the mutated node
///
/// `MassTree::attach`/`detach` recomputes composite mass properties
/// up the parent's full ancestor chain to the root. Callers using the
/// low-level path **must** invoke `sync_body_mass_from_tree` once for
/// **every** Simulation body whose composite was touched — that is,
/// the directly mutated child *plus every ancestor of the (former)
/// parent that is registered as a Simulation body*. Syncing only the
/// child or only the immediate parent leaves higher ancestors with
/// stale composite mass and stale multi-step integrator history,
/// silently producing wrong physics on the next `step()`. The
/// high-level [`attach`](Self::attach) / [`detach`](Self::detach) /
/// [`detach_subtree`](Self::detach_subtree) /
/// [`attach_subtree_aligned`](Self::attach_subtree_aligned) methods
/// already do this ancestor walk for you (see
/// `simulation/mass_tree.rs` `affected_ids` collection); this section
/// applies only when callers bypass them.
///
/// # Panics
/// Panics if the body is not registered in the mass tree.
// JEOD_INV: IG.37 — multi-step integrator history must be reset on topology change
pub fn sync_body_mass_from_tree(&mut self, idx: usize) {
let id = self.bodies[idx]
.mass_body_id
.expect("sync_body_mass_from_tree requires body registered in mass tree");
let tree = self
.mass_tree
.as_ref()
.expect("sync_body_mass_from_tree requires a mass tree");
let mut composite = tree.get(id).composite_properties;
composite.dirty = true;
composite.recompute_derived();
// allowed: typed↔raw kernel-boundary lift from the mass tree's
// raw composite (named-method opt-in; see #397).
self.bodies[idx].mass = Some(mass_raw_to_self_ref(&composite));
// ── IG.37: mark + reset the body's multi-step integrator history.
// The two-step pattern (mark dirty, then reset) is deliberate —
// it mirrors the high-level attach/detach methods so a future
// refactor that drops the reset would leave the dirty flag set
// and trigger the IG.37 panic on the next `integrate()` call.
// JEOD's `dyn_body_attach.cc::reset_integrators()` (lines 860,
// 871) and `dyn_body_detach.cc:271-273` are the corresponding
// JEOD sites.
let body = &mut self.bodies[idx];
if let Some(ref mut gj) = body.gj_state {
gj.mark_topology_dirty();
}
if let Some(ref mut abm) = body.abm4_state {
abm.mark_topology_dirty();
}
astrodyn::reset_integrators(
body.gj_state.as_mut().map(|s| s.inner_mut()),
body.abm4_state.as_mut().map(|s| s.inner_mut()),
body.lsode_state.as_mut().map(|s| s.inner_mut()),
);
}
/// Clear the kinematic-only flag on a body, returning ownership of
/// its trans/rot to the integrator.
///
/// `Simulation::detach` already clears this flag automatically on
/// the freshly-detached child (a kinematic child without a parent
/// would panic on the next `step()` in `propagate_kinematic_state`,
/// so detach is the single fail-loud entry point). This method
/// remains for the rarer case where a caller wants to revoke the
/// kinematic-only assignment without changing the tree topology
/// — e.g. swapping a fully-integrated child in place of a
/// kinematic one mid-mission.
///
/// No-op if the flag is already clear. Does not validate
/// mass-tree topology; this method is purely a flag flip.
pub fn clear_kinematic_only(&mut self, idx: usize) {
self.bodies[idx].kinematic_only = false;
}
/// Flag a body as a kinematic child of its mass-tree parent.
///
/// After this call, the body's `trans` + `rot` are derived each
/// [`step`](Self::step) by
/// [`propagate_state_via_storage`](astrodyn::propagate_state_via_storage)
/// from the parent's freshly-derived state composed with the
/// link's `MassChildOf` rotation + offset (mirrors JEOD's
/// `DynBody::propagate_state_from_structure`). The integrator on
/// this body is **skipped** — only the tree root integrates per
/// `JEOD_INV: DB.17`.
///
/// # Panics
/// * The body is not registered in the mass tree (call
/// [`add_body_to_tree`](Self::add_body_to_tree) first).
/// * The body resolves to a tree root (kinematic-only bodies must
/// be non-root — call [`attach`](Self::attach) first).
/// * The body has no [`RotationalState`](astrodyn::RotationalState):
/// kinematic propagation derives both `trans` and `rot`, so
/// 3-DOF bodies cannot be kinematic children.
// JEOD_INV: DB.17 — only the root's state is integrated; non-root state is kinematic-derived
pub fn mark_kinematic_only(&mut self, idx: usize) {
let body = &self.bodies[idx];
let id = body.mass_body_id.unwrap_or_else(|| {
panic!(
"mark_kinematic_only: SimBody {idx} is not in the mass tree. \
Call `add_body_to_tree({idx}, ...)` and `attach({idx}, parent_idx, ...)` first."
)
});
let tree = self
.mass_tree
.as_ref()
.expect("mark_kinematic_only: no mass tree configured");
assert!(
tree.parent(id).is_some(),
"mark_kinematic_only: SimBody {idx} (mass_body_id {id:?}) is a tree root. \
Kinematic-only bodies must have a parent — call \
`attach({idx}, parent_idx, offset, t_parent_child)` first."
);
assert!(
body.rot.is_some(),
"mark_kinematic_only: SimBody {idx} has no RotationalState. \
Kinematic propagation derives both trans and rot; 3-DOF bodies cannot \
be kinematic children. Set `VehicleConfig::rot = Some(...)` when \
constructing the body."
);
self.bodies[idx].kinematic_only = true;
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::SimulationBuilderExt;
use astrodyn::recipes::Mission;
use astrodyn::RotationalState;
use astrodyn::{
default_leap_second_table, ContactMaterial, JeodQuat, SimulationTime, SphericalTerrain,
};
use std::sync::Arc;
fn empty_sim() -> Simulation {
// TAI = 0 is pre-1972, which the leap-second table panics on by
// default (#485 H2). Tests using a synthetic zero epoch must opt in
// to JEOD-faithful clamp behavior so the table-OOR panic doesn't
// pre-empt the contact-pair `has_stepped` assertion these tests
// actually want to verify.
let time = SimulationTime::new(
0.0,
default_leap_second_table().with_clamp_out_of_range(true),
);
Simulation::new(time, 1.0)
}
fn dummy_material() -> ContactMaterial {
ContactMaterial::jeod_spring(1.0, 1.0, 0.5)
}
#[test]
#[should_panic(expected = "must precede the first `step()`")]
fn register_contact_pair_after_step_panics() {
let mut sim = empty_sim();
sim.has_stepped = true;
let mat = dummy_material();
let facet = ContactFacet::point(DVec3::ZERO, 1.0, mat);
sim.register_contact_pair(0, facet, 1, facet);
}
#[test]
#[should_panic(expected = "must precede the first `step()`")]
fn register_ground_contact_pair_after_step_panics() {
let mut sim = empty_sim();
sim.has_stepped = true;
let mat = dummy_material();
let veh = ContactFacet::point(DVec3::ZERO, 1.0, mat);
let ground = GroundFacet::new(Arc::new(SphericalTerrain::new(6_378_137.0)), 0.0, mat);
sim.register_ground_contact_pair(0, veh, ground, 0);
}
/// Contact pair bodies must be distinct (JEOD `unique_pair`
/// invariant in `contact.cc`). Hand the same body index for both
/// halves of the pair; the body-count and material-equality
/// checks both pass when `body_a == body_b` with one body
/// registered, so the next assert is the unique-pair one.
#[test]
#[should_panic(expected = "body A and body B must be distinct")]
fn in_30_panics_on_same_body_a_b() {
// JEOD_INV: IN.30 — contact pair bodies must be distinct
let mut sim = Mission::iss_leo_drag()
.into_builder()
.build()
.expect("Mission::iss_leo_drag must validate");
// Add a second body so the body-range asserts pass and we
// reach the `body_a != body_b` check.
let extra = Mission::iss_leo_drag()
.into_builder()
.build()
.expect("Mission::iss_leo_drag must validate")
.bodies
.remove(0);
sim.bodies.push(extra);
let mat = dummy_material();
let facet = ContactFacet::point(DVec3::ZERO, 1.0, mat);
// Same index on both sides → unique_pair violation.
sim.register_contact_pair(0, facet, 0, facet);
}
/// The contact-coupled integration path requires RK4 on every
/// body in the sim because contact forces are recomputed at each
/// stage from the intermediate states — and only RK4's stage
/// pattern is supported. Swap one body's integrator to a
/// non-RK4 type after registering a contact pair, then `step()`
/// to drive the assertion.
#[test]
#[should_panic(expected = "contact-coupled path")]
fn in_31_panics_on_non_rk4_body_in_contact_coupled_path() {
use astrodyn::IntegratorType;
// JEOD_INV: IN.31 — contact-coupled path requires RK4 on all bodies
let mut sim = Mission::iss_leo_drag()
.into_builder()
.build()
.expect("Mission::iss_leo_drag must validate");
// Need a second body so a contact pair is well-formed
// (`body_a != body_b`). Take another iss_leo_drag-built body
// and push it onto our existing sim's body list.
let extra = Mission::iss_leo_drag()
.into_builder()
.build()
.expect("Mission::iss_leo_drag must validate")
.bodies
.remove(0);
sim.bodies.push(extra);
let mat = dummy_material();
let facet = ContactFacet::point(DVec3::ZERO, 1.0, mat);
sim.register_contact_pair(0, facet, 1, facet);
// Switch body 0's integrator to a non-RK4 type so the
// coupled-path RK4 assertion fires on the first `step()`.
sim.bodies[0].integrator = IntegratorType::Rkf45;
// Single step is enough to enter `integrate_bodies_contact_coupled`.
let _ = sim.step();
}
/// Only active `GroundFacet`s may register. JEOD's
/// `check_contact_ground` silently skips inactive ground facets;
/// our Fail Loudly policy rejects them at registration so a
/// misconfigured surface model can't silently drop its
/// contribution.
#[test]
#[should_panic(expected = "ground_facet.active must be true")]
fn in_35_panics_on_inactive_ground_facet_at_registration() {
// JEOD_INV: IN.35 — only active GroundFacets may register
let mut sim = Mission::iss_leo_drag()
.into_builder()
.build()
.expect("Mission::iss_leo_drag must validate");
let mat = dummy_material();
let veh = ContactFacet::point(DVec3::ZERO, 1.0, mat);
// Bypass `GroundFacet::new` (which forces `active = true`)
// by direct field construction so we can drive the
// registration-site assertion.
let ground = GroundFacet {
terrain: Arc::new(SphericalTerrain::new(6_378_137.0)),
alt_offset: 0.0,
material: mat,
active: false,
};
sim.register_ground_contact_pair(0, veh, ground, 0);
}
/// `set_body_rot` must mirror the new attitude / angular velocity
/// onto the body's frame-tree node, in the same way
/// `set_body_position` / `set_body_velocity` mirror their halves.
/// Otherwise frame-tree consumers (e.g. `compute_relative_state`
/// walks that traverse through this node, or another body attaching
/// to *this* body's frame) would silently observe the previous
/// quaternion / ω until the next integration tick re-syncs the
/// node — producing wrong relative-state lookups in between.
#[test]
fn set_body_rot_syncs_frame_tree_node() {
// 6-DOF body so the body has a `rot` slot at all.
let mut sim = Mission::iss_leo_drag()
.into_builder()
.build()
.expect("Mission::iss_leo_drag must validate");
// Build a non-identity attitude + non-zero angular velocity so a
// missed sync (leaving the node at the previous step's value)
// would show up as a numerically distinguishable drift between
// the body's quaternion and the frame node's quaternion.
let new_quat =
JeodQuat::left_quat_from_eigen_rotation(0.7, DVec3::new(1.0, 2.0, 3.0).normalize());
let new_ang_vel = DVec3::new(0.01, -0.02, 0.03);
let new_rot = RotationalState {
quaternion: new_quat,
ang_vel_body: new_ang_vel,
};
sim.set_body_rot(0, new_rot);
let body = &sim.bodies[0];
let body_frame_id = body.body_frame_id;
let node_state = sim.frame_tree().get(body_frame_id).state;
assert!(
(node_state.rot.q_parent_this.scalar() - new_quat.scalar()).abs() < 1e-12
&& (node_state.rot.q_parent_this.vector() - new_quat.vector()).length() < 1e-12,
"frame-tree node q_parent_this {:?} desync from set_body_rot input {:?}",
node_state.rot.q_parent_this,
new_quat
);
let t_expected = new_quat.left_quat_to_transformation();
for col in 0..3 {
assert!(
(node_state.rot.t_parent_this.col(col) - t_expected.col(col)).length() < 1e-12,
"frame-tree node t_parent_this column {col} desync from quaternion-derived T"
);
}
assert!(
(node_state.rot.ang_vel_this - new_ang_vel).length() < 1e-12,
"frame-tree node ang_vel_this {:?} desync from set_body_rot input {:?}",
node_state.rot.ang_vel_this,
new_ang_vel
);
// Confirm the body slot itself was also updated.
let body_rot = sim.bodies[0]
.rot
.expect("iss_leo_drag is 6-DOF — body must carry rot");
assert_eq!(body_rot.q_inertial_body.to_jeod_quat(), new_quat);
assert_eq!(body_rot.ang_vel_body.raw_si(), new_ang_vel);
}
}