Files
MeanField_SERiF/docs/html/discretization_2blocks_2concepts_8hpp__dep__incl.map
Emily Boudreaux 6b57738330 docs(docs): built docs
Note for now much of the docs is LLM written. This was done to save time and focus on code development. The docs have been LOOSLEY reviewed. However, the code itself has been either fully written by hand or fully reviewed. Therefore, the docs should at the moment be seen as a loose resource rather than authoratiative (and this is on top of the general ability for docs to drift)
2026-11-09 14:09:44 -05:00

139 lines
20 KiB
Plaintext

<map id="src/include/serif/discretization/blocks/concepts.hpp" name="src/include/serif/discretization/blocks/concepts.hpp">
<area shape="rect" id="Node000001" title="This file defines concepts for blocks in the discretization framework." alt="" coords="991,5,1186,46"/>
<area shape="rect" id="Node000002" href="$fields_8cpp.html" title=" " alt="" coords="1074,198,1244,253"/>
<area shape="poly" id="edge1_Node000001_Node000002" title=" " alt="" coords="1102,58,1152,198,1147,196,1099,63"/>
<area shape="rect" id="Node000003" href="$mfem__static__order_8hpp.html" title="File containing the mfem_form_static_order trait. This trait is used to determine the static order of..." alt="" coords="153,405,357,461"/>
<area shape="poly" id="edge2_Node000001_Node000003" title=" " alt="" coords="973,31,878,39,764,50,644,69,525,97,456,114,401,128,377,138,353,153,329,172,304,199,287,223,275,250,260,306,255,361,255,405,250,404,250,360,255,305,270,248,283,221,300,196,325,169,350,148,374,134,399,123,455,108,524,91,643,64,764,45,878,33,978,29"/>
<area shape="rect" id="Node000049" href="$blocks_8hpp.html" title=" " alt="" coords="857,205,1051,246"/>
<area shape="poly" id="edge8_Node000001_Node000049" title=" " alt="" coords="1090,60,1084,106,1077,130,1065,151,1035,184,999,207,996,202,1031,179,1061,148,1072,128,1079,105,1087,64"/>
<area shape="rect" id="Node000051" href="$discretization_2blocks_2runtime_8hpp.html" title="Runtime descriptors for fields and terms, used to project compile time types into runtime values." alt="" coords="857,102,1051,142"/>
<area shape="poly" id="edge10_Node000001_Node000051" title=" " alt="" coords="1046,56,983,103,980,99,1051,53"/>
<area shape="rect" id="Node000062" href="$discretization_2blocks_2traits_8hpp.html" title="Compile&#45;time traits for fields and terms, used to extract types and properties from template paramete..." alt="" coords="1411,102,1606,142"/>
<area shape="poly" id="edge20_Node000001_Node000062" title=" " alt="" coords="1191,47,1423,100,1418,102,1191,53"/>
<area shape="rect" id="Node000138" href="$forms_8hpp.html" title="This file defines the forms used in the discretization framework, including mass, divergence,..." alt="" coords="343,205,538,246"/>
<area shape="poly" id="edge57_Node000001_Node000138" title=" " alt="" coords="973,30,897,37,808,49,716,68,627,96,578,121,532,151,463,207,459,203,529,146,575,116,625,92,714,63,807,44,896,32,978,28"/>
<area shape="rect" id="Node000141" href="$operands_8hpp.html" title="This file defines the Operand type, which represents a term and an operation to be applied to that te..." alt="" coords="638,102,832,142"/>
<area shape="poly" id="edge68_Node000001_Node000141" title=" " alt="" coords="998,52,810,103,808,99,1002,49"/>
<area shape="rect" id="Node000143" href="$metrics_8hpp.html" title=" " alt="" coords="2969,102,3144,142"/>
<area shape="poly" id="edge75_Node000001_Node000143" title=" " alt="" coords="1201,30,2970,114,2968,119,1201,35"/>
<area shape="rect" id="Node000152" href="$default__preconditioners_8hpp.html" title=" " alt="" coords="3520,94,3673,150"/>
<area shape="poly" id="edge81_Node000001_Node000152" title=" " alt="" coords="1201,27,2015,49,2579,68,3155,91,3523,115,3517,116,3155,97,2579,73,2015,54,1201,32"/>
<area shape="rect" id="Node000004" href="$mfem__resolver_8cpp.html" title=" " alt="" coords="363,805,584,860"/>
<area shape="poly" id="edge3_Node000003_Node000004" title=" " alt="" coords="264,473,278,518,295,563,333,634,376,701,454,804,448,804,372,704,328,637,290,565,273,520,263,478"/>
<area shape="rect" id="Node000005" href="$mfem__static__order_8cpp.html" title=" " alt="" coords="5,509,228,564"/>
<area shape="poly" id="edge4_Node000003_Node000005" title=" " alt="" coords="204,472,156,510,152,506,207,468"/>
<area shape="rect" id="Node000006" href="$mfem__resolver_8hpp.html" title="File containing the MFEMResolver class. This class is used to resolve the appropriate MFEM integratio..." alt="" coords="629,701,833,757"/>
<area shape="poly" id="edge5_Node000003_Node000006" title=" " alt="" coords="276,471,309,519,350,562,417,608,490,646,563,675,631,700,626,701,561,680,488,650,414,613,347,566,305,522,276,477"/>
<area shape="poly" id="edge6_Node000006_Node000004" title=" " alt="" coords="651,762,544,807,542,801,645,763"/>
<area shape="rect" id="Node000007" href="$quadrature_8hpp.html" title=" " alt="" coords="747,812,953,853"/>
<area shape="poly" id="edge7_Node000006_Node000007" title=" " alt="" coords="775,764,830,812,824,811,773,769"/>
<area shape="rect" id="Node000050" href="$fields__meanfield_8cpp.html" title=" " alt="" coords="972,509,1141,564"/>
<area shape="poly" id="edge9_Node000049_Node000050" title=" " alt="" coords="990,254,1010,276,1026,300,1045,356,1056,413,1060,466,1060,510,1056,507,1055,467,1051,414,1040,357,1021,302,1006,279,989,259"/>
<area shape="poly" id="edge11_Node000051_Node000049" title=" " alt="" coords="955,156,956,206,951,204,953,160"/>
<area shape="rect" id="Node000052" href="$discretization_2forms_2runtime_8hpp.html" title="file defining some utilities to project form information from compile time into runtime" alt="" coords="702,412,896,453"/>
<area shape="poly" id="edge12_Node000051_Node000052" title=" " alt="" coords="901,152,874,174,846,199,826,225,813,246,796,302,794,329,796,357,800,413,795,411,791,357,789,329,791,301,808,244,822,222,843,196,871,169,905,149"/>
<area shape="poly" id="edge13_Node000052_Node000050" title=" " alt="" coords="863,456,990,508,985,508,863,462"/>
<area shape="rect" id="Node000053" href="$forms_8cpp.html" title=" " alt="" coords="361,509,530,564"/>
<area shape="poly" id="edge14_Node000052_Node000053" title=" " alt="" coords="714,459,532,513,530,508,718,457"/>
<area shape="rect" id="Node000054" href="$query_8hpp.html" title="File containing the Query struct. This struct is used to represent a quadrature query,..." alt="" coords="567,612,762,653"/>
<area shape="poly" id="edge15_Node000052_Node000054" title=" " alt="" coords="745,460,716,484,692,510,679,535,672,563,666,613,662,610,667,562,674,534,688,507,712,480,740,463"/>
<area shape="rect" id="Node000061" href="$rules_8hpp.html" title="File containing the RuleSet class and related types. The RuleSet class is used to determine the appro..." alt="" coords="702,516,896,557"/>
<area shape="poly" id="edge17_Node000052_Node000061" title=" " alt="" coords="801,467,801,517,797,514,798,471"/>
<area shape="poly" id="edge16_Node000054_Node000006" title=" " alt="" coords="688,663,714,701,709,700,686,668"/>
<area shape="poly" id="edge18_Node000061_Node000006" title=" " alt="" coords="796,570,789,612,776,654,751,703,748,699,771,652,784,611,793,574"/>
<area shape="poly" id="edge19_Node000061_Node000054" title=" " alt="" coords="762,564,694,614,691,610,757,567"/>
<area shape="poly" id="edge21_Node000062_Node000002" title=" " alt="" coords="1424,148,1245,202,1243,197,1429,146"/>
<area shape="poly" id="edge35_Node000062_Node000049" title=" " alt="" coords="1394,141,1239,168,1064,200,1033,207,1031,202,1063,195,1238,163,1399,139"/>
<area shape="rect" id="Node000063" href="$backend_2mfem_2discretization_2quadrature_2order_8hpp.html" title="File containing the resolve_operand_order function and related utilities. These are used to determine..." alt="" coords="806,301,1011,357"/>
<area shape="poly" id="edge22_Node000062_Node000063" title=" " alt="" coords="1413,148,1361,171,1309,200,1294,214,1285,228,1275,242,1258,256,1198,284,1134,304,1070,317,1012,325,1010,320,1069,312,1132,299,1196,279,1255,251,1271,238,1280,225,1290,210,1306,195,1359,166,1418,146"/>
<area shape="rect" id="Node000065" href="$term__binding_8hpp.html" title="A runtime binding between some term descriptor and its MFEM finite&#45;element space. This is used to pro..." alt="" coords="2201,198,2370,253"/>
<area shape="poly" id="edge27_Node000062_Node000065" title=" " alt="" coords="1621,135,2204,212,2198,214,1621,140"/>
<area shape="rect" id="Node000084" href="$physical__transfer_8hpp.html" title=" " alt="" coords="2602,198,2786,253"/>
<area shape="poly" id="edge33_Node000062_Node000084" title=" " alt="" coords="1621,130,2383,195,2604,216,2599,217,2383,200,1622,135"/>
<area shape="rect" id="Node000085" href="$value_8hpp.html" title="Encode compile time information about the shape (rank) and data type of the result of various Operati..." alt="" coords="1514,205,1708,246"/>
<area shape="poly" id="edge36_Node000062_Node000085" title=" " alt="" coords="1539,150,1594,205,1589,204,1538,156"/>
<area shape="rect" id="Node000137" href="$equations_2contributions_8hpp.html" title="File containing the Contribution struct. This is effectively a helper struct for authoring equations ..." alt="" coords="1590,309,1763,350"/>
<area shape="poly" id="edge48_Node000062_Node000137" title=" " alt="" coords="1621,140,1709,163,1744,178,1767,196,1775,211,1777,225,1767,255,1743,287,1713,311,1711,306,1740,283,1762,252,1771,224,1770,212,1762,199,1742,183,1708,168,1621,145"/>
<area shape="rect" id="Node000134" href="$automatic__relations_8hpp.html" title=" " alt="" coords="1834,198,2005,253"/>
<area shape="poly" id="edge52_Node000062_Node000134" title=" " alt="" coords="1604,144,1816,195,1836,202,1830,202,1815,200,1605,149"/>
<area shape="rect" id="Node000109" href="$operators_2concepts_8hpp.html" title=" " alt="" coords="1319,205,1490,246"/>
<area shape="poly" id="edge53_Node000062_Node000109" title=" " alt="" coords="1480,152,1426,207,1423,203,1476,154"/>
<area shape="poly" id="edge26_Node000063_Node000003" title=" " alt="" coords="789,351,359,418,357,413,792,347"/>
<area shape="poly" id="edge25_Node000063_Node000006" title=" " alt="" coords="919,370,927,413,930,463,926,515,911,565,885,609,851,646,814,678,779,703,777,698,811,674,848,643,881,606,906,563,920,514,924,463,922,414,917,374"/>
<area shape="poly" id="edge23_Node000063_Node000050" title=" " alt="" coords="938,367,1040,509,1035,508,936,372"/>
<area shape="rect" id="Node000064" href="$operators_2plan_8cpp.html" title=" " alt="" coords="1425,516,1594,557"/>
<area shape="poly" id="edge24_Node000063_Node000064" title=" " alt="" coords="1026,341,1193,366,1268,383,1320,403,1338,416,1348,430,1357,444,1372,459,1418,489,1467,516,1461,515,1416,494,1368,463,1353,447,1343,433,1334,420,1318,407,1266,388,1192,371,1026,346"/>
<area shape="rect" id="Node000066" href="$dof__selection_8hpp.html" title="This file contains the DofSelection which allows for the selection of a subset of DOFs from a term bi..." alt="" coords="2417,301,2584,357"/>
<area shape="poly" id="edge28_Node000065_Node000066" title=" " alt="" coords="2357,258,2445,301,2440,300,2357,263"/>
<area shape="rect" id="Node000077" href="$mass__diagonal_8hpp.html" title=" " alt="" coords="2608,301,2783,357"/>
<area shape="poly" id="edge29_Node000065_Node000077" title=" " alt="" coords="2385,248,2596,299,2610,304,2604,304,2595,304,2385,253"/>
<area shape="rect" id="Node000080" href="$term__coefficients_8hpp.html" title=" " alt="" coords="1985,301,2154,357"/>
<area shape="poly" id="edge31_Node000065_Node000080" title=" " alt="" coords="2217,259,2129,303,2127,298,2212,261"/>
<area shape="rect" id="Node000029" href="$backend_2mfem_2model_2finite__elements_8hpp.html" title=" " alt="" coords="2179,309,2393,350"/>
<area shape="poly" id="edge32_Node000065_Node000029" title=" " alt="" coords="2287,267,2288,310,2284,307,2284,271"/>
<area shape="rect" id="Node000078" href="$metric__computations_8hpp.html" title=" " alt="" coords="2774,405,2952,461"/>
<area shape="poly" id="edge30_Node000077_Node000078" title=" " alt="" coords="2754,363,2821,405,2815,404,2753,368"/>
<area shape="rect" id="Node000020" href="$solver_2continuation_2equilibrium_8hpp.html" title=" " alt="" coords="2807,309,2994,350"/>
<area shape="poly" id="edge34_Node000084_Node000020" title=" " alt="" coords="2763,258,2863,309,2858,308,2762,263"/>
<area shape="rect" id="Node000086" href="$point_8hpp.html" title="File containing the definitions of the EquationPoint and PointLinearization structs,..." alt="" coords="1392,309,1566,350"/>
<area shape="poly" id="edge37_Node000085_Node000086" title=" " alt="" coords="1576,254,1506,311,1503,306,1572,257"/>
<area shape="rect" id="Node000130" href="$rigid__rotation_8hpp.html" title="An equation implementing rigid rotation." alt="" coords="1787,309,1960,350"/>
<area shape="poly" id="edge44_Node000085_Node000130" title=" " alt="" coords="1676,249,1826,308,1820,308,1676,254"/>
<area shape="rect" id="Node000132" href="$geometry_2surface_2detail_2relations_8hpp.html" title=" " alt="" coords="1187,309,1368,350"/>
<area shape="poly" id="edge47_Node000085_Node000132" title=" " alt="" coords="1529,252,1343,311,1341,306,1534,250"/>
<area shape="poly" id="edge38_Node000086_Node000050" title=" " alt="" coords="1392,355,1381,360,1341,366,1306,368,1245,367,1217,369,1189,375,1159,387,1126,407,1104,429,1087,456,1065,510,1061,506,1082,454,1100,426,1123,403,1156,382,1187,369,1216,364,1245,362,1306,363,1341,361,1380,354,1397,353"/>
<area shape="rect" id="Node000011" href="$computation__owners_8cpp.html" title=" " alt="" coords="1382,405,1566,461"/>
<area shape="poly" id="edge39_Node000086_Node000011" title=" " alt="" coords="1479,363,1477,406,1473,403,1476,367"/>
<area shape="rect" id="Node000087" href="$angular__momentum_8hpp.html" title="File containing the angular momentum constraint equation, which enforces a global constraint on the t..." alt="" coords="1590,412,1763,453"/>
<area shape="poly" id="edge40_Node000086_Node000087" title=" " alt="" coords="1531,354,1641,412,1636,412,1530,359"/>
<area shape="rect" id="Node000096" href="$barotropic__density_8hpp.html" title=" " alt="" coords="1787,412,1960,453"/>
<area shape="poly" id="edge42_Node000086_Node000096" title=" " alt="" coords="1566,351,1578,354,1776,402,1804,412,1799,412,1775,408,1577,360,1566,357"/>
<area shape="poly" id="edge41_Node000087_Node000064" title=" " alt="" coords="1634,460,1543,518,1541,513,1629,462"/>
<area shape="poly" id="edge43_Node000096_Node000064" title=" " alt="" coords="1791,457,1581,518,1580,513,1786,458"/>
<area shape="poly" id="edge45_Node000130_Node000087" title=" " alt="" coords="1825,356,1716,414,1714,409,1820,358"/>
<area shape="poly" id="edge46_Node000130_Node000096" title=" " alt="" coords="1876,363,1876,414,1872,410,1872,367"/>
<area shape="poly" id="edge49_Node000137_Node000011" title=" " alt="" coords="1627,356,1529,407,1527,402,1622,358"/>
<area shape="poly" id="edge50_Node000137_Node000087" title=" " alt="" coords="1678,363,1679,414,1674,411,1675,367"/>
<area shape="poly" id="edge51_Node000137_Node000096" title=" " alt="" coords="1728,354,1838,412,1833,412,1728,359"/>
<area shape="rect" id="Node000114" href="$operators_2plan_8hpp.html" title=" " alt="" coords="1136,412,1308,453"/>
<area shape="poly" id="edge54_Node000109_Node000114" title=" " alt="" coords="1313,251,1227,280,1193,293,1177,303,1171,316,1169,329,1175,359,1189,387,1207,413,1202,412,1185,390,1170,361,1163,330,1166,314,1173,300,1191,288,1225,275,1318,249"/>
<area shape="poly" id="edge56_Node000114_Node000007" title=" " alt="" coords="1211,466,1188,516,1156,566,1085,645,1008,715,936,773,880,814,878,809,932,769,1004,711,1081,641,1152,563,1183,514,1206,469"/>
<area shape="poly" id="edge55_Node000114_Node000064" title=" " alt="" coords="1292,456,1457,516,1451,516,1292,461"/>
<area shape="poly" id="edge58_Node000138_Node000005" title=" " alt="" coords="362,254,308,278,248,312,190,354,165,379,143,406,130,431,122,458,118,509,113,508,117,457,125,429,138,404,161,375,187,350,245,307,306,274,365,250"/>
<area shape="poly" id="edge59_Node000138_Node000053" title=" " alt="" coords="431,258,423,302,420,359,425,416,441,509,436,508,419,417,415,359,418,301,428,263"/>
<area shape="poly" id="edge67_Node000138_Node000114" title=" " alt="" coords="517,248,663,299,728,328,757,341,795,354,884,377,976,396,1138,422,1133,423,975,401,883,383,793,360,755,346,726,333,661,304,517,254"/>
<area shape="rect" id="Node000139" href="$concept_8hpp.html" title="This file defines concepts for forms in the discretization framework." alt="" coords="433,309,627,350"/>
<area shape="poly" id="edge60_Node000138_Node000139" title=" " alt="" coords="468,255,515,308,510,309,468,260"/>
<area shape="rect" id="Node000140" href="$form__traits_8hpp.html" title="Compile&#45;time traits for forms, used to extract types and properties from template parameters." alt="" coords="483,412,678,453"/>
<area shape="poly" id="edge66_Node000138_Node000140" title=" " alt="" coords="533,248,599,272,625,285,641,300,648,315,650,330,641,361,623,390,603,414,599,410,619,387,637,359,645,330,643,316,637,303,622,290,597,277,534,253"/>
<area shape="poly" id="edge62_Node000139_Node000003" title=" " alt="" coords="461,357,330,407,327,402,464,353"/>
<area shape="poly" id="edge65_Node000139_Node000052" title=" " alt="" coords="596,353,750,411,744,413,596,358"/>
<area shape="poly" id="edge61_Node000139_Node000053" title=" " alt="" coords="502,359,487,383,474,406,457,460,450,509,445,507,452,458,469,404,482,380,499,363"/>
<area shape="poly" id="edge63_Node000139_Node000140" title=" " alt="" coords="547,361,573,412,568,412,546,366"/>
<area shape="poly" id="edge64_Node000140_Node000054" title=" " alt="" coords="596,465,659,612,654,611,593,470"/>
<area shape="poly" id="edge70_Node000141_Node000003" title=" " alt="" coords="620,133,539,143,454,157,381,175,353,187,333,199,318,229,299,285,265,405,260,403,294,284,313,227,329,196,350,182,379,170,453,151,539,138,625,130"/>
<area shape="poly" id="edge71_Node000141_Node000063" title=" " alt="" coords="762,152,847,252,888,301,883,301,842,255,761,157"/>
<area shape="poly" id="edge73_Node000141_Node000085" title=" " alt="" coords="823,143,845,147,944,160,1029,167,1173,171,1318,175,1403,182,1502,195,1540,204,1535,205,1501,200,1402,187,1318,180,1173,176,1028,173,944,166,844,152,824,148"/>
<area shape="poly" id="edge74_Node000141_Node000137" title=" " alt="" coords="822,143,845,147,907,150,1013,151,1294,150,1439,152,1569,160,1668,173,1702,183,1722,196,1731,209,1735,224,1729,255,1714,285,1695,311,1692,306,1709,282,1724,253,1729,224,1726,211,1719,200,1700,188,1667,178,1569,165,1439,158,1294,155,1013,156,907,156,844,152,823,148"/>
<area shape="poly" id="edge72_Node000141_Node000138" title=" " alt="" coords="662,149,499,207,496,202,666,146"/>
<area shape="rect" id="Node000142" href="$operands_8cpp.html" title=" " alt="" coords="561,198,730,253"/>
<area shape="poly" id="edge69_Node000141_Node000142" title=" " alt="" coords="710,152,672,199,668,195,706,156"/>
<area shape="poly" id="edge76_Node000143_Node000078" title=" " alt="" coords="3059,155,3059,201,3051,254,3036,309,3023,335,3008,359,2979,386,2945,407,2943,402,2976,382,3004,355,3019,332,3031,307,3046,253,3053,201,3056,159"/>
<area shape="rect" id="Node000144" href="$dimensionless_8hpp.html" title=" " alt="" coords="3119,205,3333,246"/>
<area shape="poly" id="edge77_Node000143_Node000144" title=" " alt="" coords="3103,148,3196,205,3191,204,3102,153"/>
<area shape="rect" id="Node000145" href="$solver_2normalization_2plan_8hpp.html" title=" " alt="" coords="3148,309,3304,350"/>
<area shape="poly" id="edge80_Node000143_Node000145" title=" " alt="" coords="3065,155,3082,205,3094,229,3109,252,3144,283,3183,309,3178,308,3141,287,3105,255,3089,232,3077,207,3062,160"/>
<area shape="poly" id="edge78_Node000144_Node000145" title=" " alt="" coords="3228,260,3228,310,3224,307,3224,264"/>
<area shape="rect" id="Node000056" href="$numerics_8hpp.html" title=" " alt="" coords="3220,412,3376,453"/>
<area shape="poly" id="edge79_Node000145_Node000056" title=" " alt="" coords="3250,360,3286,413,3282,411,3247,365"/>
<area shape="poly" id="edge86_Node000152_Node000056" title=" " alt="" coords="3508,139,3448,165,3421,180,3397,199,3372,239,3345,299,3305,414,3302,410,3340,297,3367,236,3393,196,3418,176,3446,160,3503,141"/>
<area shape="rect" id="Node000059" href="$backend__independent_8cpp.html" title=" " alt="" coords="4056,205,4262,246"/>
<area shape="poly" id="edge82_Node000152_Node000059" title=" " alt="" coords="3688,134,3855,161,4045,195,4080,205,4075,205,4044,200,3854,166,3688,139"/>
<area shape="rect" id="Node000153" href="$layout_8cpp.html" title=" " alt="" coords="3407,198,3581,253"/>
<area shape="poly" id="edge83_Node000152_Node000153" title=" " alt="" coords="3561,160,3523,199,3520,195,3556,162"/>
<area shape="rect" id="Node000018" href="$backend_2mfem_2solver_2equilibrium_8hpp.html" title=" " alt="" coords="3605,205,3793,246"/>
<area shape="poly" id="edge84_Node000152_Node000018" title=" " alt="" coords="3636,158,3682,206,3677,204,3634,163"/>
<area shape="rect" id="Node000154" href="$preconditioner_8hpp.html" title=" " alt="" coords="3817,205,4032,246"/>
<area shape="poly" id="edge85_Node000152_Node000154" title=" " alt="" coords="3688,149,3864,205,3858,205,3687,154"/>
</map>