Files
MeanField_SERiF/docs/html/catalog_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

122 lines
17 KiB
Plaintext

<map id="src/include/serif/eos/relations/catalog.hpp" name="src/include/serif/eos/relations/catalog.hpp">
<area shape="rect" id="Node000001" title="File containing the Relation and RelationCatalog structs. These structs are used to represent relatio..." alt="" coords="3440,5,3586,46"/>
<area shape="rect" id="Node000002" href="$eos_2relations_2relations_8hpp.html" title="File containing the thermodynamic relations used in the eos module. These relations are used to compu..." alt="" coords="3357,271,3509,312"/>
<area shape="poly" id="edge1_Node000001_Node000002" title=" " alt="" coords="3502,59,3491,95,3440,273,3436,269,3486,93,3498,62"/>
<area shape="rect" id="Node000086" href="$eos_2relations_2traits_8hpp.html" title="File containing traits for the eos relations module. These traits are used to determine if a type is ..." alt="" coords="3501,94,3639,135"/>
<area shape="poly" id="edge65_Node000001_Node000086" title=" " alt="" coords="3535,56,3560,94,3555,93,3533,61"/>
<area shape="rect" id="Node000003" href="$eos_2models_2concepts_8hpp.html" title="File containing concepts for the eos module. These concepts are used to constrain template parameters..." alt="" coords="3549,360,3698,401"/>
<area shape="poly" id="edge2_Node000002_Node000003" title=" " alt="" coords="3490,316,3583,360,3578,359,3490,321"/>
<area shape="rect" id="Node000008" href="$barotropic__density_8hpp.html" title=" " alt="" coords="2701,537,2874,578"/>
<area shape="poly" id="edge64_Node000002_Node000008" title=" " alt="" coords="3373,318,2836,539,2835,534,3368,319"/>
<area shape="rect" id="Node000072" href="$eos_2models_2polytropic_8hpp.html" title="File containing the Polytropic equation of state." alt="" coords="2026,537,2178,578"/>
<area shape="poly" id="edge31_Node000002_Node000072" title=" " alt="" coords="3338,312,2179,544,2178,539,3344,311"/>
<area shape="rect" id="Node000004" href="$consumers__meanfield_8cpp.html" title=" " alt="" coords="3508,634,3739,674"/>
<area shape="poly" id="edge3_Node000003_Node000004" title=" " alt="" coords="3625,415,3626,634,3621,631,3622,418"/>
<area shape="rect" id="Node000005" href="$traits_8cpp.html" title=" " alt="" coords="4011,634,4190,674"/>
<area shape="poly" id="edge4_Node000003_Node000005" title=" " alt="" coords="3708,403,3774,426,3847,455,3923,492,3994,535,4023,558,4049,584,4089,634,4084,632,4045,588,4020,562,3991,540,3920,496,3845,460,3772,431,3707,409"/>
<area shape="rect" id="Node000006" href="$eos_2evaluation_8hpp.html" title="File containing the evaluate and partial_derivative functions. These functions are used to evaluate r..." alt="" coords="3389,449,3527,489"/>
<area shape="poly" id="edge5_Node000003_Node000006" title=" " alt="" coords="3575,407,3496,451,3495,446,3570,409"/>
<area shape="rect" id="Node000050" href="$geometry_2surface_2detail_2relations_8hpp.html" title=" " alt="" coords="4232,449,4413,489"/>
<area shape="poly" id="edge24_Node000003_Node000050" title=" " alt="" coords="3713,390,4234,456,4228,457,3713,395"/>
<area shape="rect" id="Node000007" href="$evaluation_8cpp.html" title=" " alt="" coords="3315,634,3484,674"/>
<area shape="poly" id="edge6_Node000006_Node000007" title=" " alt="" coords="3449,502,3407,635,3404,631,3445,506"/>
<area shape="poly" id="edge7_Node000006_Node000008" title=" " alt="" coords="3371,482,2875,548,2874,543,3377,481"/>
<area shape="rect" id="Node000028" href="$geometry_2surface_2detail_2evaluation_8hpp.html" title=" " alt="" coords="3992,730,4183,770"/>
<area shape="poly" id="edge19_Node000006_Node000028" title=" " alt="" coords="3542,481,3632,499,3737,528,3847,569,3900,595,3950,624,3967,637,3978,650,4001,680,4062,730,4057,728,3998,684,3973,654,3963,641,3947,628,3897,599,3844,574,3735,533,3630,504,3542,486"/>
<area shape="rect" id="Node000009" href="$barotropic__density_8cpp.html" title=" " alt="" coords="2896,626,3066,682"/>
<area shape="poly" id="edge8_Node000008_Node000009" title=" " alt="" coords="2842,582,2928,626,2922,625,2841,588"/>
<area shape="rect" id="Node000010" href="$density__primal_8cpp.html" title=" " alt="" coords="3089,634,3291,674"/>
<area shape="poly" id="edge9_Node000008_Node000010" title=" " alt="" coords="2888,579,3079,623,3110,633,3105,633,3078,629,2888,585"/>
<area shape="rect" id="Node000011" href="$execution__validation_8cpp.html" title=" " alt="" coords="1707,626,1876,682"/>
<area shape="poly" id="edge10_Node000008_Node000011" title=" " alt="" coords="2683,561,2531,568,2332,579,2111,598,1889,629,1877,631,1876,626,1888,623,2110,593,2331,573,2531,562,2688,560"/>
<area shape="rect" id="Node000012" href="$normalization_8cpp.html" title=" " alt="" coords="1900,634,2096,674"/>
<area shape="poly" id="edge11_Node000008_Node000012" title=" " alt="" coords="2683,565,2423,588,2265,606,2108,629,2074,635,2073,630,2107,623,2265,600,2423,583,2688,564"/>
<area shape="rect" id="Node000013" href="$compile__time__checks_2serif_2model_2validation_8cpp.html" title=" " alt="" coords="2120,634,2293,674"/>
<area shape="poly" id="edge12_Node000008_Node000013" title=" " alt="" coords="2683,570,2508,595,2305,629,2275,635,2274,630,2304,623,2507,589,2688,569"/>
<area shape="rect" id="Node000014" href="$coordinate__identity__meanfield_8cpp.html" title=" " alt="" coords="2507,626,2679,682"/>
<area shape="poly" id="edge13_Node000008_Node000014" title=" " alt="" coords="2736,584,2650,628,2648,623,2731,586"/>
<area shape="rect" id="Node000015" href="$operators_2plan_8cpp.html" title=" " alt="" coords="2703,634,2872,674"/>
<area shape="poly" id="edge14_Node000008_Node000015" title=" " alt="" coords="2789,592,2790,635,2785,631,2786,596"/>
<area shape="rect" id="Node000016" href="$backend_2mfem_2serialize_2top_8hpp.html" title=" " alt="" coords="2316,634,2483,674"/>
<area shape="poly" id="edge15_Node000008_Node000016" title=" " alt="" coords="2688,580,2495,629,2469,635,2468,630,2494,623,2683,581"/>
<area shape="rect" id="Node000018" href="$equations_2equations_8hpp.html" title="File containing the equations module. This module contains the equations used in the SERiF framework." alt="" coords="3764,634,3937,674"/>
<area shape="poly" id="edge17_Node000008_Node000018" title=" " alt="" coords="2889,557,3055,561,3270,572,3511,591,3633,606,3752,623,3787,633,3782,633,3751,629,3632,611,3510,597,3270,577,3055,566,2890,562"/>
<area shape="rect" id="Node000017" href="$backend_2mfem_2serialize_2top_8cpp.html" title=" " alt="" coords="2321,730,2478,770"/>
<area shape="poly" id="edge16_Node000016_Node000017" title=" " alt="" coords="2401,688,2402,731,2397,728,2398,692"/>
<area shape="rect" id="Node000019" href="$utils_2serialize_2equations_8hpp.html" title=" " alt="" coords="3212,730,3371,770"/>
<area shape="poly" id="edge18_Node000018_Node000019" title=" " alt="" coords="3769,678,3752,684,3547,720,3371,743,3371,737,3546,714,3751,679,3764,679"/>
<area shape="rect" id="Node000029" href="$batches_8hpp.html" title=" " alt="" coords="3898,818,4077,859"/>
<area shape="poly" id="edge20_Node000028_Node000029" title=" " alt="" coords="4056,780,4011,820,4009,815,4051,782"/>
<area shape="rect" id="Node000049" href="$geometry_2surface_2evaluation_8hpp.html" title=" " alt="" coords="4100,818,4272,859"/>
<area shape="poly" id="edge21_Node000028_Node000049" title=" " alt="" coords="4122,778,4166,819,4161,817,4120,783"/>
<area shape="rect" id="Node000047" href="$surface_8hpp.html" title="Isobaric conditions, EOS&#45;selected formulations, and reusable boundary calculations." alt="" coords="4100,907,4272,948"/>
<area shape="poly" id="edge22_Node000049_Node000047" title=" " alt="" coords="4188,873,4188,908,4184,905,4184,876"/>
<area shape="rect" id="Node000048" href="$surface_8cpp.html" title=" " alt="" coords="2483,996,2663,1036"/>
<area shape="poly" id="edge23_Node000047_Node000048" title=" " alt="" coords="4087,934,2664,1012,2663,1007,4082,934"/>
<area shape="rect" id="Node000051" href="$compilation_8hpp.html" title=" " alt="" coords="4338,537,4509,578"/>
<area shape="poly" id="edge25_Node000050_Node000051" title=" " alt="" coords="4358,497,4403,538,4398,536,4356,502"/>
<area shape="poly" id="edge30_Node000051_Node000047" title=" " alt="" coords="4422,592,4415,637,4401,683,4377,738,4354,779,4326,817,4285,861,4255,887,4222,909,4221,904,4251,883,4282,857,4322,813,4350,776,4372,735,4396,681,4410,636,4418,595"/>
<area shape="rect" id="Node000052" href="$boundary__data_8hpp.html" title=" " alt="" coords="4460,626,4627,682"/>
<area shape="poly" id="edge26_Node000051_Node000052" title=" " alt="" coords="4461,585,4511,626,4506,625,4459,590"/>
<area shape="rect" id="Node000058" href="$automatic__relations_8hpp.html" title=" " alt="" coords="4651,626,4822,682"/>
<area shape="poly" id="edge27_Node000051_Node000058" title=" " alt="" coords="4504,580,4654,627,4648,627,4503,585"/>
<area shape="rect" id="Node000069" href="$surface_2linearization_8hpp.html" title=" " alt="" coords="4215,634,4386,674"/>
<area shape="poly" id="edge28_Node000051_Node000069" title=" " alt="" coords="4388,587,4327,636,4325,631,4384,589"/>
<area shape="poly" id="edge29_Node000069_Node000028" title=" " alt="" coords="4245,680,4133,732,4131,727,4240,681"/>
<area shape="poly" id="edge32_Node000072_Node000004" title=" " alt="" coords="2194,560,2906,590,3280,608,3497,623,3542,633,3536,633,3497,629,3280,613,2906,595,2194,565"/>
<area shape="poly" id="edge34_Node000072_Node000005" title=" " alt="" coords="2193,559,3173,592,3688,611,3949,623,4013,635,4008,635,3949,629,3688,616,3173,598,2193,565"/>
<area shape="poly" id="edge33_Node000072_Node000007" title=" " alt="" coords="2194,559,2760,581,3074,600,3205,611,3304,623,3339,633,3333,633,3303,629,3204,616,3074,605,2759,586,2194,564"/>
<area shape="poly" id="edge37_Node000072_Node000009" title=" " alt="" coords="2194,559,2329,565,2502,576,2694,595,2885,623,2898,628,2893,628,2884,629,2693,601,2502,582,2329,570,2194,564"/>
<area shape="poly" id="edge38_Node000072_Node000010" title=" " alt="" coords="2193,558,2360,563,2580,573,2828,593,3079,623,3117,633,3112,633,3078,629,2828,598,2580,579,2360,568,2194,563"/>
<area shape="poly" id="edge39_Node000072_Node000011" title=" " alt="" coords="2025,582,1877,629,1876,624,2020,584"/>
<area shape="poly" id="edge41_Node000072_Node000012" title=" " alt="" coords="2072,587,2021,636,2018,631,2067,590"/>
<area shape="poly" id="edge42_Node000072_Node000013" title=" " alt="" coords="2136,586,2187,634,2182,632,2134,591"/>
<area shape="poly" id="edge43_Node000072_Node000014" title=" " alt="" coords="2194,570,2336,593,2495,623,2509,629,2504,629,2494,629,2335,598,2194,575"/>
<area shape="poly" id="edge44_Node000072_Node000015" title=" " alt="" coords="2194,562,2421,583,2557,601,2692,623,2724,633,2719,633,2691,629,2556,606,2421,589,2194,568"/>
<area shape="poly" id="edge46_Node000072_Node000016" title=" " alt="" coords="2179,580,2340,633,2335,633,2178,586"/>
<area shape="poly" id="edge35_Node000072_Node000048" title=" " alt="" coords="2007,559,1778,564,1492,573,1356,582,1238,593,1149,609,1119,618,1101,628,1080,654,1074,680,1077,749,1077,840,1080,852,1088,863,1123,886,1177,906,1249,924,1336,940,1435,954,1657,976,1895,992,2126,1002,2485,1014,2480,1014,2126,1007,1894,997,1657,981,1434,959,1335,945,1248,929,1176,911,1120,891,1085,867,1075,854,1072,840,1072,749,1068,680,1075,652,1098,624,1117,613,1148,604,1237,588,1355,576,1492,568,1778,559,2013,559"/>
<area shape="rect" id="Node000032" href="$surface__boundary_8cpp.html" title=" " alt="" coords="867,626,1036,682"/>
<area shape="poly" id="edge36_Node000072_Node000032" title=" " alt="" coords="2008,560,1834,565,1596,575,1327,595,1190,610,1056,629,1037,632,1036,627,1055,623,1189,605,1326,590,1596,570,1833,560,2013,559"/>
<area shape="rect" id="Node000064" href="$compile__time__checks_2serif_2model_2finite__elements_8cpp.html" title=" " alt="" coords="1111,634,1317,674"/>
<area shape="poly" id="edge40_Node000072_Node000064" title=" " alt="" coords="2008,563,1707,585,1518,603,1329,629,1293,636,1292,630,1328,623,1518,598,1706,580,2013,562"/>
<area shape="rect" id="Node000073" href="$solver_2normalization_2plan_8cpp.html" title=" " alt="" coords="1341,626,1511,682"/>
<area shape="poly" id="edge45_Node000072_Node000073" title=" " alt="" coords="2008,566,1788,589,1656,607,1524,629,1513,631,1511,626,1523,623,1655,601,1788,584,2013,565"/>
<area shape="rect" id="Node000074" href="$stellar__parameters_8hpp.html" title=" " alt="" coords="290,634,522,674"/>
<area shape="poly" id="edge47_Node000072_Node000074" title=" " alt="" coords="2008,562,1429,582,1033,601,630,629,523,640,521,635,630,623,1033,596,1429,577,2013,560"/>
<area shape="rect" id="Node000078" href="$polytrope_8hpp.html" title=" " alt="" coords="573,730,725,770"/>
<area shape="poly" id="edge52_Node000072_Node000078" title=" " alt="" coords="2008,561,1679,569,1246,581,861,601,734,614,695,621,676,628,659,650,651,677,648,705,649,731,644,728,643,705,646,676,655,648,673,624,693,616,733,608,861,595,1246,576,1679,564,2013,560"/>
<area shape="rect" id="Node000084" href="$physics_8hpp.html" title=" " alt="" coords="1535,634,1682,674"/>
<area shape="poly" id="edge60_Node000072_Node000084" title=" " alt="" coords="2008,571,1862,595,1695,629,1669,635,1668,630,1694,623,1861,590,2013,570"/>
<area shape="rect" id="Node000085" href="$polytropic_8cpp.html" title=" " alt="" coords="687,634,843,674"/>
<area shape="poly" id="edge63_Node000072_Node000085" title=" " alt="" coords="2008,562,1423,584,1094,603,958,615,855,629,825,635,823,630,854,623,957,610,1093,598,1422,579,2013,560"/>
<area shape="rect" id="Node000075" href="$solver_2continuation_2polytropic_8hpp.html" title=" " alt="" coords="225,730,406,770"/>
<area shape="poly" id="edge48_Node000074_Node000075" title=" " alt="" coords="379,684,336,731,332,727,375,687"/>
<area shape="rect" id="Node000076" href="$continuation_8cpp.html" title=" " alt="" coords="5,818,194,859"/>
<area shape="poly" id="edge49_Node000075_Node000076" title=" " alt="" coords="251,779,150,820,147,815,254,774"/>
<area shape="rect" id="Node000077" href="$continuation_8hpp.html" title=" " alt="" coords="218,818,413,859"/>
<area shape="poly" id="edge50_Node000075_Node000077" title=" " alt="" coords="317,784,318,819,313,817,314,788"/>
<area shape="rect" id="Node000042" href="$solver_2solver_8hpp.html" title=" " alt="" coords="294,907,446,948"/>
<area shape="poly" id="edge51_Node000077_Node000042" title=" " alt="" coords="337,870,360,907,355,906,335,875"/>
<area shape="poly" id="edge58_Node000078_Node000042" title=" " alt="" coords="562,777,520,797,477,821,450,841,425,865,387,909,383,904,421,861,447,837,474,816,518,792,567,775"/>
<area shape="rect" id="Node000079" href="$public__contracts_8cpp.html" title=" " alt="" coords="664,818,877,859"/>
<area shape="poly" id="edge53_Node000078_Node000079" title=" " alt="" coords="689,777,745,818,740,818,688,782"/>
<area shape="rect" id="Node000080" href="$solver_2seed_2fitted_8hpp.html" title=" " alt="" coords="487,818,640,859"/>
<area shape="poly" id="edge54_Node000078_Node000080" title=" " alt="" coords="621,780,584,820,581,816,617,783"/>
<area shape="rect" id="Node000083" href="$polytrope_8cpp.html" title=" " alt="" coords="901,818,1036,859"/>
<area shape="poly" id="edge59_Node000078_Node000083" title=" " alt="" coords="736,772,903,819,898,819,736,777"/>
<area shape="poly" id="edge56_Node000080_Node000042" title=" " alt="" coords="508,865,415,909,413,904,503,867"/>
<area shape="rect" id="Node000081" href="$backend_2mfem_2solver_2seed_2fitted_8hpp.html" title=" " alt="" coords="470,907,657,948"/>
<area shape="poly" id="edge55_Node000080_Node000081" title=" " alt="" coords="565,873,566,908,561,905,562,877"/>
<area shape="rect" id="Node000082" href="$fitted_8cpp.html" title=" " alt="" coords="681,907,806,948"/>
<area shape="poly" id="edge57_Node000080_Node000082" title=" " alt="" coords="619,863,705,907,700,906,618,869"/>
<area shape="poly" id="edge62_Node000084_Node000019" title=" " alt="" coords="1680,676,1695,679,1790,689,1952,699,2396,718,3215,746,3209,747,2396,723,1952,704,1790,694,1694,684,1680,681"/>
<area shape="rect" id="Node000021" href="$serialize_2discretization_8hpp.html" title=" " alt="" coords="1501,730,1717,770"/>
<area shape="poly" id="edge61_Node000084_Node000021" title=" " alt="" coords="1611,688,1611,731,1607,728,1607,692"/>
<area shape="rect" id="Node000087" href="$eos_2relations_2concepts_8hpp.html" title="File containing concepts for the eos relations module. These concepts are used to constrain template ..." alt="" coords="3511,183,3667,223"/>
<area shape="poly" id="edge66_Node000086_Node000087" title=" " alt="" coords="3579,148,3587,184,3582,181,3576,152"/>
<area shape="rect" id="Node000088" href="$eos_2models_2traits_8hpp.html" title="File containing the traits for the eos module. These traits are used to determine if a type is an equ..." alt="" coords="3554,271,3693,312"/>
<area shape="poly" id="edge67_Node000087_Node000088" title=" " alt="" coords="3604,235,3618,272,3613,270,3601,240"/>
<area shape="poly" id="edge69_Node000088_Node000003" title=" " alt="" coords="3625,326,3626,361,3621,358,3622,330"/>
<area shape="poly" id="edge68_Node000088_Node000005" title=" " alt="" coords="3688,316,3765,351,3856,400,3951,462,3995,497,4036,536,4056,559,4073,585,4096,634,4091,632,4068,588,4052,562,4032,539,3992,501,3947,466,3854,405,3763,356,3687,321"/>
</map>