9 tetrahedron_properties,
15 import qualified Data.Vector as V (
20 import Numeric.LinearAlgebra hiding (i, scale)
21 import Prelude hiding (LT)
22 import Test.Framework (Test, testGroup)
23 import Test.Framework.Providers.HUnit (testCase)
24 import Test.Framework.Providers.QuickCheck2 (testProperty)
26 import Test.QuickCheck (Arbitrary(..), Gen, Property, (==>))
29 import Comparisons ((~=), nearly_ge)
31 import Misc (factorial)
34 import ThreeDimensional
37 Tetrahedron { fv :: FunctionValues,
42 precomputed_volume :: Double
47 instance Arbitrary Tetrahedron where
49 rnd_v0 <- arbitrary :: Gen Point
50 rnd_v1 <- arbitrary :: Gen Point
51 rnd_v2 <- arbitrary :: Gen Point
52 rnd_v3 <- arbitrary :: Gen Point
53 rnd_fv <- arbitrary :: Gen FunctionValues
55 -- We can't assign an incorrect precomputed volume,
56 -- so we have to calculate the correct one here.
57 let t' = Tetrahedron rnd_fv rnd_v0 rnd_v1 rnd_v2 rnd_v3 0
59 return (Tetrahedron rnd_fv rnd_v0 rnd_v1 rnd_v2 rnd_v3 vol)
62 instance Show Tetrahedron where
63 show t = "Tetrahedron:\n" ++
64 " fv: " ++ (show (fv t)) ++ "\n" ++
65 " v0: " ++ (show (v0 t)) ++ "\n" ++
66 " v1: " ++ (show (v1 t)) ++ "\n" ++
67 " v2: " ++ (show (v2 t)) ++ "\n" ++
68 " v3: " ++ (show (v3 t)) ++ "\n"
71 instance ThreeDimensional Tetrahedron where
72 center (Tetrahedron _ v0' v1' v2' v3' _) =
73 (v0' + v1' + v2' + v3') `scale` (1/4)
76 b0_unscaled `nearly_ge` 0 &&
77 b1_unscaled `nearly_ge` 0 &&
78 b2_unscaled `nearly_ge` 0 &&
79 b3_unscaled `nearly_ge` 0
81 -- Drop the useless division and volume calculation that we
82 -- would do if we used the regular b0,..b3 functions.
84 b0_unscaled = volume inner_tetrahedron
85 where inner_tetrahedron = t { v0 = p }
88 b1_unscaled = volume inner_tetrahedron
89 where inner_tetrahedron = t { v1 = p }
92 b2_unscaled = volume inner_tetrahedron
93 where inner_tetrahedron = t { v2 = p }
96 b3_unscaled = volume inner_tetrahedron
97 where inner_tetrahedron = t { v3 = p }
100 polynomial :: Tetrahedron -> (RealFunction Point)
102 V.sum $ V.singleton ((c t 0 0 0 3) `cmult` (beta t 0 0 0 3)) `V.snoc`
103 ((c t 0 0 1 2) `cmult` (beta t 0 0 1 2)) `V.snoc`
104 ((c t 0 0 2 1) `cmult` (beta t 0 0 2 1)) `V.snoc`
105 ((c t 0 0 3 0) `cmult` (beta t 0 0 3 0)) `V.snoc`
106 ((c t 0 1 0 2) `cmult` (beta t 0 1 0 2)) `V.snoc`
107 ((c t 0 1 1 1) `cmult` (beta t 0 1 1 1)) `V.snoc`
108 ((c t 0 1 2 0) `cmult` (beta t 0 1 2 0)) `V.snoc`
109 ((c t 0 2 0 1) `cmult` (beta t 0 2 0 1)) `V.snoc`
110 ((c t 0 2 1 0) `cmult` (beta t 0 2 1 0)) `V.snoc`
111 ((c t 0 3 0 0) `cmult` (beta t 0 3 0 0)) `V.snoc`
112 ((c t 1 0 0 2) `cmult` (beta t 1 0 0 2)) `V.snoc`
113 ((c t 1 0 1 1) `cmult` (beta t 1 0 1 1)) `V.snoc`
114 ((c t 1 0 2 0) `cmult` (beta t 1 0 2 0)) `V.snoc`
115 ((c t 1 1 0 1) `cmult` (beta t 1 1 0 1)) `V.snoc`
116 ((c t 1 1 1 0) `cmult` (beta t 1 1 1 0)) `V.snoc`
117 ((c t 1 2 0 0) `cmult` (beta t 1 2 0 0)) `V.snoc`
118 ((c t 2 0 0 1) `cmult` (beta t 2 0 0 1)) `V.snoc`
119 ((c t 2 0 1 0) `cmult` (beta t 2 0 1 0)) `V.snoc`
120 ((c t 2 1 0 0) `cmult` (beta t 2 1 0 0)) `V.snoc`
121 ((c t 3 0 0 0) `cmult` (beta t 3 0 0 0))
124 -- | Returns the domain point of t with indices i,j,k,l.
125 -- Simply an alias for the domain_point function.
126 xi :: Tetrahedron -> Int -> Int -> Int -> Int -> Point
129 -- | Returns the domain point of t with indices i,j,k,l.
130 domain_point :: Tetrahedron -> Int -> Int -> Int -> Int -> Point
131 domain_point t i j k l
132 | i + j + k + l == 3 = weighted_sum `scale` (1/3)
133 | otherwise = error "domain point index out of bounds"
135 v0' = (v0 t) `scale` (fromIntegral i)
136 v1' = (v1 t) `scale` (fromIntegral j)
137 v2' = (v2 t) `scale` (fromIntegral k)
138 v3' = (v3 t) `scale` (fromIntegral l)
139 weighted_sum = v0' + v1' + v2' + v3'
142 -- | The Bernstein polynomial on t with indices i,j,k,l. Denoted by a
143 -- capital 'B' in the Sorokina/Zeilfelder paper.
144 beta :: Tetrahedron -> Int -> Int -> Int -> Int -> (RealFunction Point)
146 | (i + j + k + l == 3) =
147 coefficient `cmult` (b0_term * b1_term * b2_term * b3_term)
148 | otherwise = error "basis function index out of bounds"
150 denominator = (factorial i)*(factorial j)*(factorial k)*(factorial l)
151 coefficient = 6 / (fromIntegral denominator)
152 b0_term = (b0 t) `fexp` i
153 b1_term = (b1 t) `fexp` j
154 b2_term = (b2 t) `fexp` k
155 b3_term = (b3 t) `fexp` l
158 -- | The coefficient function. c t i j k l returns the coefficient
159 -- c_ijkl with respect to the tetrahedron t. The definition uses
160 -- pattern matching to mimic the definitions given in Sorokina and
161 -- Zeilfelder, pp. 84-86. If incorrect indices are supplied, the
162 -- function will simply error.
163 c :: Tetrahedron -> Int -> Int -> Int -> Int -> Double
164 c t 0 0 3 0 = eval (fv t) $
165 (1/8) * (I + F + L + T + LT + FL + FT + FLT)
167 c t 0 0 0 3 = eval (fv t) $
168 (1/8) * (I + F + R + T + RT + FR + FT + FRT)
170 c t 0 0 2 1 = eval (fv t) $
171 (5/24)*(I + F + T + FT) +
172 (1/24)*(L + FL + LT + FLT)
174 c t 0 0 1 2 = eval (fv t) $
175 (5/24)*(I + F + T + FT) +
176 (1/24)*(R + FR + RT + FRT)
178 c t 0 1 2 0 = eval (fv t) $
180 (1/8)*(L + T + FL + FT) +
183 c t 0 1 0 2 = eval (fv t) $
185 (1/8)*(R + T + FR + FT) +
188 c t 0 1 1 1 = eval (fv t) $
191 (1/32)*(L + R + FL + FR) +
192 (1/96)*(LT + RT + FLT + FRT)
194 c t 0 2 1 0 = eval (fv t) $
196 (17/192)*(L + T + FL + FT) +
198 (1/64)*(R + D + FR + FD) +
199 (1/192)*(RT + LD + FRT + FLD)
201 c t 0 2 0 1 = eval (fv t) $
203 (17/192)*(R + T + FR + FT) +
205 (1/64)*(L + D + FL + FD) +
206 (1/192)*(RD + LT + FLT + FRD)
208 c t 0 3 0 0 = eval (fv t) $
210 (5/96)*(L + R + T + D + FL + FR + FT + FD) +
211 (1/192)*(RT + RD + LT + LD + FRT + FRD + FLT + FLD)
213 c t 1 0 2 0 = eval (fv t) $
216 (1/12)*(LT + FL + FT)
218 c t 1 0 0 2 = eval (fv t) $
221 (1/12)*(RT + FR + FT)
223 c t 1 0 1 1 = eval (fv t) $
228 (1/48)*(LT + RT + FL + FR)
230 c t 1 1 1 0 = eval (fv t) $
235 (1/48)*(D + R + LT) +
236 (1/96)*(FD + LD + RT + FR)
238 c t 1 1 0 1 = eval (fv t) $
243 (1/48)*(D + L + RT) +
244 (1/96)*(FD + LT + RD + FL)
246 c t 1 2 0 0 = eval (fv t) $
249 (7/96)*(L + R + T + D) +
250 (1/32)*(FL + FR + FT + FD) +
251 (1/96)*(RT + RD + LT + LD)
253 c t 2 0 1 0 = eval (fv t) $
256 (1/48)*(R + D + B + LT + FL + FT) +
257 (1/96)*(RT + BT + FR + FD + LD + BL)
259 c t 2 0 0 1 = eval (fv t) $
262 (1/48)*(L + D + B + RT + FR + FT) +
263 (1/96)*(LT + BT + FL + FD + RD + BR)
265 c t 2 1 0 0 = eval (fv t) $
267 (1/12)*(T + R + L + D) +
268 (1/64)*(FT + FR + FL + FD) +
271 (1/96)*(RT + LD + LT + RD) +
272 (1/192)*(BT + BR + BL + BD)
274 c t 3 0 0 0 = eval (fv t) $
276 (1/12)*(T + F + L + R + D + B) +
277 (1/96)*(LT + FL + FT + RT + BT + FR) +
278 (1/96)*(FD + LD + BD + BR + RD + BL)
280 c _ _ _ _ _ = error "coefficient index out of bounds"
284 -- | The matrix used in the tetrahedron volume calculation as given in
285 -- Lai & Schumaker, Definition 15.4, page 436.
286 vol_matrix :: Tetrahedron -> Matrix Double
287 vol_matrix t = (4><4)
298 -- | Computed using the formula from Lai & Schumaker, Definition 15.4,
300 volume :: Tetrahedron -> Double
302 | (v0 t) == (v1 t) = 0
303 | (v0 t) == (v2 t) = 0
304 | (v0 t) == (v3 t) = 0
305 | (v1 t) == (v2 t) = 0
306 | (v1 t) == (v3 t) = 0
307 | (v2 t) == (v3 t) = 0
308 | otherwise = (1/6)*(det (vol_matrix t))
311 -- | The barycentric coordinates of a point with respect to v0.
312 b0 :: Tetrahedron -> (RealFunction Point)
313 b0 t point = (volume inner_tetrahedron) / (precomputed_volume t)
315 inner_tetrahedron = t { v0 = point }
318 -- | The barycentric coordinates of a point with respect to v1.
319 b1 :: Tetrahedron -> (RealFunction Point)
320 b1 t point = (volume inner_tetrahedron) / (precomputed_volume t)
322 inner_tetrahedron = t { v1 = point }
325 -- | The barycentric coordinates of a point with respect to v2.
326 b2 :: Tetrahedron -> (RealFunction Point)
327 b2 t point = (volume inner_tetrahedron) / (precomputed_volume t)
329 inner_tetrahedron = t { v2 = point }
332 -- | The barycentric coordinates of a point with respect to v3.
333 b3 :: Tetrahedron -> (RealFunction Point)
334 b3 t point = (volume inner_tetrahedron) / (precomputed_volume t)
336 inner_tetrahedron = t { v3 = point }
344 -- | Check the volume of a particular tetrahedron (computed by hand)
345 -- and whether or not it contains a specific point chosen to be
346 -- outside of it. Its vertices are in clockwise order, so the volume
347 -- should be negative.
348 tetrahedron1_geometry_tests :: Test.Framework.Test
349 tetrahedron1_geometry_tests =
350 testGroup "tetrahedron1 geometry"
351 [ testCase "volume1" volume1,
352 testCase "doesn't contain point1" doesnt_contain_point1]
358 t = Tetrahedron { v0 = p0,
363 precomputed_volume = 0 }
367 assertEqual "volume is correct" True (vol ~= (-1/3))
371 doesnt_contain_point1 :: Assertion
372 doesnt_contain_point1 =
373 assertEqual "doesn't contain an exterior point" False contained
375 exterior_point = (5, 2, -9.0212)
376 contained = contains_point t exterior_point
379 -- | Check the volume of a particular tetrahedron (computed by hand)
380 -- and whether or not it contains a specific point chosen to be
381 -- inside of it. Its vertices are in counter-clockwise order, so the
382 -- volume should be positive.
383 tetrahedron2_geometry_tests :: Test.Framework.Test
384 tetrahedron2_geometry_tests =
385 testGroup "tetrahedron2 geometry"
386 [ testCase "volume1" volume1,
387 testCase "contains point1" contains_point1]
393 t = Tetrahedron { v0 = p0,
398 precomputed_volume = 0 }
401 volume1 = assertEqual "volume1 is correct" True (vol ~= (1/3))
405 contains_point1 :: Assertion
406 contains_point1 = assertEqual "contains an inner point" True contained
408 inner_point = (1, 0, 0.5)
409 contained = contains_point t inner_point
412 -- | Ensure that tetrahedra do not contain a particular point chosen to
413 -- be outside of them.
414 containment_tests :: Test.Framework.Test
416 testGroup "containment tests"
417 [ testCase "doesn't contain point2" doesnt_contain_point2,
418 testCase "doesn't contain point3" doesnt_contain_point3,
419 testCase "doesn't contain point4" doesnt_contain_point4,
420 testCase "doesn't contain point5" doesnt_contain_point5]
424 exterior_point = (0, 0, 0)
426 doesnt_contain_point2 :: Assertion
427 doesnt_contain_point2 =
428 assertEqual "doesn't contain an exterior point" False contained
432 t = Tetrahedron { v0 = p0,
437 precomputed_volume = 0 }
438 contained = contains_point t exterior_point
441 doesnt_contain_point3 :: Assertion
442 doesnt_contain_point3 =
443 assertEqual "doesn't contain an exterior point" False contained
447 t = Tetrahedron { v0 = p0,
452 precomputed_volume = 0 }
453 contained = contains_point t exterior_point
456 doesnt_contain_point4 :: Assertion
457 doesnt_contain_point4 =
458 assertEqual "doesn't contain an exterior point" False contained
462 t = Tetrahedron { v0 = p0,
467 precomputed_volume = 0 }
468 contained = contains_point t exterior_point
471 doesnt_contain_point5 :: Assertion
472 doesnt_contain_point5 =
473 assertEqual "doesn't contain an exterior point" False contained
477 t = Tetrahedron { v0 = p0,
482 precomputed_volume = 0 }
483 contained = contains_point t exterior_point
486 -- | The barycentric coordinate of v0 with respect to itself should
488 prop_b0_v0_always_unity :: Tetrahedron -> Property
489 prop_b0_v0_always_unity t =
490 (volume t) > 0 ==> (b0 t) (v0 t) ~= 1.0
492 -- | The barycentric coordinate of v1 with respect to v0 should
494 prop_b0_v1_always_zero :: Tetrahedron -> Property
495 prop_b0_v1_always_zero t =
496 (volume t) > 0 ==> (b0 t) (v1 t) ~= 0
498 -- | The barycentric coordinate of v2 with respect to v0 should
500 prop_b0_v2_always_zero :: Tetrahedron -> Property
501 prop_b0_v2_always_zero t =
502 (volume t) > 0 ==> (b0 t) (v2 t) ~= 0
504 -- | The barycentric coordinate of v3 with respect to v0 should
506 prop_b0_v3_always_zero :: Tetrahedron -> Property
507 prop_b0_v3_always_zero t =
508 (volume t) > 0 ==> (b0 t) (v3 t) ~= 0
510 -- | The barycentric coordinate of v1 with respect to itself should
512 prop_b1_v1_always_unity :: Tetrahedron -> Property
513 prop_b1_v1_always_unity t =
514 (volume t) > 0 ==> (b1 t) (v1 t) ~= 1.0
516 -- | The barycentric coordinate of v0 with respect to v1 should
518 prop_b1_v0_always_zero :: Tetrahedron -> Property
519 prop_b1_v0_always_zero t =
520 (volume t) > 0 ==> (b1 t) (v0 t) ~= 0
522 -- | The barycentric coordinate of v2 with respect to v1 should
524 prop_b1_v2_always_zero :: Tetrahedron -> Property
525 prop_b1_v2_always_zero t =
526 (volume t) > 0 ==> (b1 t) (v2 t) ~= 0
528 -- | The barycentric coordinate of v3 with respect to v1 should
530 prop_b1_v3_always_zero :: Tetrahedron -> Property
531 prop_b1_v3_always_zero t =
532 (volume t) > 0 ==> (b1 t) (v3 t) ~= 0
534 -- | The barycentric coordinate of v2 with respect to itself should
536 prop_b2_v2_always_unity :: Tetrahedron -> Property
537 prop_b2_v2_always_unity t =
538 (volume t) > 0 ==> (b2 t) (v2 t) ~= 1.0
540 -- | The barycentric coordinate of v0 with respect to v2 should
542 prop_b2_v0_always_zero :: Tetrahedron -> Property
543 prop_b2_v0_always_zero t =
544 (volume t) > 0 ==> (b2 t) (v0 t) ~= 0
546 -- | The barycentric coordinate of v1 with respect to v2 should
548 prop_b2_v1_always_zero :: Tetrahedron -> Property
549 prop_b2_v1_always_zero t =
550 (volume t) > 0 ==> (b2 t) (v1 t) ~= 0
552 -- | The barycentric coordinate of v3 with respect to v2 should
554 prop_b2_v3_always_zero :: Tetrahedron -> Property
555 prop_b2_v3_always_zero t =
556 (volume t) > 0 ==> (b2 t) (v3 t) ~= 0
558 -- | The barycentric coordinate of v3 with respect to itself should
560 prop_b3_v3_always_unity :: Tetrahedron -> Property
561 prop_b3_v3_always_unity t =
562 (volume t) > 0 ==> (b3 t) (v3 t) ~= 1.0
564 -- | The barycentric coordinate of v0 with respect to v3 should
566 prop_b3_v0_always_zero :: Tetrahedron -> Property
567 prop_b3_v0_always_zero t =
568 (volume t) > 0 ==> (b3 t) (v0 t) ~= 0
570 -- | The barycentric coordinate of v1 with respect to v3 should
572 prop_b3_v1_always_zero :: Tetrahedron -> Property
573 prop_b3_v1_always_zero t =
574 (volume t) > 0 ==> (b3 t) (v1 t) ~= 0
576 -- | The barycentric coordinate of v2 with respect to v3 should
578 prop_b3_v2_always_zero :: Tetrahedron -> Property
579 prop_b3_v2_always_zero t =
580 (volume t) > 0 ==> (b3 t) (v2 t) ~= 0
583 -- | Used for convenience in the next few tests; not a test itself.
584 p :: Tetrahedron -> Int -> Int -> Int -> Int -> Double
585 p t i j k l = (polynomial t) (xi t i j k l)
587 -- | Given in Sorokina and Zeilfelder, p. 78.
588 prop_c3000_identity :: Tetrahedron -> Property
589 prop_c3000_identity t =
591 c t 3 0 0 0 ~= p t 3 0 0 0
593 -- | Given in Sorokina and Zeilfelder, p. 78.
594 prop_c2100_identity :: Tetrahedron -> Property
595 prop_c2100_identity t =
597 c t 2 1 0 0 ~= (term1 - term2 + term3 - term4)
599 term1 = (1/3)*(p t 0 3 0 0)
600 term2 = (5/6)*(p t 3 0 0 0)
601 term3 = 3*(p t 2 1 0 0)
602 term4 = (3/2)*(p t 1 2 0 0)
604 -- | Given in Sorokina and Zeilfelder, p. 78.
605 prop_c1110_identity :: Tetrahedron -> Property
606 prop_c1110_identity t =
608 c t 1 1 1 0 ~= (term1 + term2 - term3 - term4)
610 term1 = (1/3)*((p t 3 0 0 0) + (p t 0 3 0 0) + (p t 0 0 3 0))
611 term2 = (9/2)*(p t 1 1 1 0)
612 term3 = (3/4)*((p t 2 1 0 0) + (p t 1 2 0 0) + (p t 2 0 1 0))
613 term4 = (3/4)*((p t 1 0 2 0) + (p t 0 2 1 0) + (p t 0 1 2 0))
616 prop_swapping_vertices_doesnt_affect_coefficients1 :: Tetrahedron -> Bool
617 prop_swapping_vertices_doesnt_affect_coefficients1 t =
618 c t 0 0 1 2 == c t' 0 0 1 2
620 t' = t { v0 = (v1 t), v1 = (v0 t) }
622 prop_swapping_vertices_doesnt_affect_coefficients2 :: Tetrahedron -> Bool
623 prop_swapping_vertices_doesnt_affect_coefficients2 t =
624 c t 0 1 1 1 == c t' 0 1 1 1
626 t' = t { v2 = (v3 t), v3 = (v2 t) }
628 prop_swapping_vertices_doesnt_affect_coefficients3 :: Tetrahedron -> Bool
629 prop_swapping_vertices_doesnt_affect_coefficients3 t =
630 c t 2 1 0 0 == c t' 2 1 0 0
632 t' = t { v2 = (v3 t), v3 = (v2 t) }
634 prop_swapping_vertices_doesnt_affect_coefficients4 :: Tetrahedron -> Bool
635 prop_swapping_vertices_doesnt_affect_coefficients4 t =
636 c t 2 0 0 1 == c t' 2 0 0 1
638 t' = t { v0 = (v3 t), v3 = (v0 t) }
643 tetrahedron_tests :: Test.Framework.Test
645 testGroup "Tetrahedron Tests" [
646 tetrahedron1_geometry_tests,
647 tetrahedron2_geometry_tests,
652 p78_24_properties :: Test.Framework.Test
654 testGroup "p. 78, Section (2.4) Properties" [
655 testProperty "c3000 identity" prop_c3000_identity,
656 testProperty "c2100 identity" prop_c2100_identity,
657 testProperty "c1110 identity" prop_c1110_identity]
660 tetrahedron_properties :: Test.Framework.Test
661 tetrahedron_properties =
662 testGroup "Tetrahedron Properties" [
664 testProperty "b0_v0_always_unity" prop_b0_v0_always_unity,
665 testProperty "b0_v1_always_zero" prop_b0_v1_always_zero,
666 testProperty "b0_v2_always_zero" prop_b0_v2_always_zero,
667 testProperty "b0_v3_always_zero" prop_b0_v3_always_zero,
668 testProperty "b1_v1_always_unity" prop_b1_v1_always_unity,
669 testProperty "b1_v0_always_zero" prop_b1_v0_always_zero,
670 testProperty "b1_v2_always_zero" prop_b1_v2_always_zero,
671 testProperty "b1_v3_always_zero" prop_b1_v3_always_zero,
672 testProperty "b2_v2_always_unity" prop_b2_v2_always_unity,
673 testProperty "b2_v0_always_zero" prop_b2_v0_always_zero,
674 testProperty "b2_v1_always_zero" prop_b2_v1_always_zero,
675 testProperty "b2_v3_always_zero" prop_b2_v3_always_zero,
676 testProperty "b3_v3_always_unity" prop_b3_v3_always_unity,
677 testProperty "b3_v0_always_zero" prop_b3_v0_always_zero,
678 testProperty "b3_v1_always_zero" prop_b3_v1_always_zero,
679 testProperty "b3_v2_always_zero" prop_b3_v2_always_zero,
680 testProperty "swapping_vertices_doesnt_affect_coefficients1" $
681 prop_swapping_vertices_doesnt_affect_coefficients1,
682 testProperty "swapping_vertices_doesnt_affect_coefficients2" $
683 prop_swapping_vertices_doesnt_affect_coefficients2,
684 testProperty "swapping_vertices_doesnt_affect_coefficients3" $
685 prop_swapping_vertices_doesnt_affect_coefficients3,
686 testProperty "swapping_vertices_doesnt_affect_coefficients4" $
687 prop_swapping_vertices_doesnt_affect_coefficients4 ]