tboudreaux/MeanField_SERiF
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
main
MeanField_SERiF/docs/xml/surface_8hpp.xml
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

603 lines
22 KiB
XML
Raw Permalink Blame History

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.13.2" xml:lang="en-US">
<compounddef id="surface_8hpp" kind="file" language="C++">
<compoundname>surface.hpp</compoundname>
<includes refid="compilation_8hpp" local="yes">serif/geometry/surface/compilation.hpp</includes>
<includes refid="geometry_2surface_2computations_8hpp" local="yes">serif/geometry/surface/computations.hpp</includes>
<includes refid="geometry_2surface_2evaluation_8hpp" local="yes">serif/geometry/surface/evaluation.hpp</includes>
<includedby refid="surface_8cpp" local="yes">src/compile_time_checks/serif/geometry/surface.cpp</includedby>
<incdepgraph>
<node id="12">
<label>serif/dimensions/dimensions.hpp</label>
<link refid="dimensions_8hpp"/>
<childnode refid="11" relation="include">
</childnode>
<childnode refid="13" relation="include">
</childnode>
</node>
<node id="37">
<label>serif/dimensions/partial.hpp</label>
<link refid="partial_8hpp"/>
<childnode refid="13" relation="include">
</childnode>
<childnode refid="17" relation="include">
</childnode>
</node>
<node id="13">
<label>serif/dimensions/quantities.hpp</label>
<link refid="quantities_8hpp"/>
<childnode refid="5" relation="include">
</childnode>
<childnode refid="14" relation="include">
</childnode>
<childnode refid="15" relation="include">
</childnode>
<childnode refid="4" relation="include">
</childnode>
<childnode refid="16" relation="include">
</childnode>
<childnode refid="17" relation="include">
</childnode>
</node>
<node id="49">
<label>serif/dimensions/type_alias.hpp</label>
<link refid="type__alias_8hpp"/>
<childnode refid="13" relation="include">
</childnode>
<childnode refid="12" relation="include">
</childnode>
</node>
<node id="18">
<label>serif/discretization/blocks/base.hpp</label>
<link refid="base_8hpp"/>
</node>
<node id="9">
<label>serif/discretization/blocks/concepts.hpp</label>
<link refid="discretization_2blocks_2concepts_8hpp"/>
<childnode refid="10" relation="include">
</childnode>
</node>
<node id="10">
<label>serif/discretization/blocks/fields.hpp</label>
<link refid="fields_8hpp"/>
<childnode refid="7" relation="include">
</childnode>
<childnode refid="11" relation="include">
</childnode>
<childnode refid="12" relation="include">
</childnode>
<childnode refid="18" relation="include">
</childnode>
<childnode refid="19" relation="include">
</childnode>
<childnode refid="24" relation="include">
</childnode>
<childnode refid="30" relation="include">
</childnode>
<childnode refid="31" relation="include">
</childnode>
<childnode refid="32" relation="include">
</childnode>
</node>
<node id="8">
<label>serif/discretization/blocks/traits.hpp</label>
<link refid="discretization_2blocks_2traits_8hpp"/>
<childnode refid="5" relation="include">
</childnode>
<childnode refid="9" relation="include">
</childnode>
</node>
<node id="24">
<label>serif/discretization/domain/concepts.hpp</label>
<link refid="discretization_2domain_2concepts_8hpp"/>
<childnode refid="25" relation="include">
</childnode>
<childnode refid="11" relation="include">
</childnode>
<childnode refid="26" relation="include">
</childnode>
<childnode refid="7" relation="include">
</childnode>
<childnode refid="20" relation="include">
</childnode>
<childnode refid="27" relation="include">
</childnode>
<childnode refid="28" relation="include">
</childnode>
<childnode refid="16" relation="include">
</childnode>
<childnode refid="29" relation="include">
</childnode>
</node>
<node id="30">
<label>serif/discretization/domain/physical_domains.hpp</label>
<link refid="physical__domains_8hpp"/>
<childnode refid="28" relation="include">
</childnode>
<childnode refid="24" relation="include">
</childnode>
</node>
<node id="28">
<label>serif/discretization/domain/types.hpp</label>
<link refid="discretization_2domain_2types_8hpp"/>
<childnode refid="11" relation="include">
</childnode>
</node>
<node id="34">
<label>serif/discretization/forms/operands.hpp</label>
<link refid="operands_8hpp"/>
<childnode refid="15" relation="include">
</childnode>
<childnode refid="5" relation="include">
</childnode>
<childnode refid="9" relation="include">
</childnode>
</node>
<node id="6">
<label>serif/discretization/forms/value.hpp</label>
<link refid="value_8hpp"/>
<childnode refid="7" relation="include">
</childnode>
<childnode refid="5" relation="include">
</childnode>
<childnode refid="8" relation="include">
</childnode>
<childnode refid="34" relation="include">
</childnode>
</node>
<node id="19">
<label>serif/discretization/functional_space/space.hpp</label>
<link refid="space_8hpp"/>
<childnode refid="5" relation="include">
</childnode>
<childnode refid="20" relation="include">
</childnode>
<childnode refid="21" relation="include">
</childnode>
</node>
<node id="56">
<label>serif/eos/evaluation.hpp</label>
<link refid="eos_2evaluation_8hpp"/>
<childnode refid="35" relation="include">
</childnode>
</node>
<node id="35">
<label>serif/eos/models/concepts.hpp</label>
<link refid="eos_2models_2concepts_8hpp"/>
<childnode refid="36" relation="include">
</childnode>
<childnode refid="43" relation="include">
</childnode>
</node>
<node id="36">
<label>serif/eos/models/traits.hpp</label>
<link refid="eos_2models_2traits_8hpp"/>
<childnode refid="13" relation="include">
</childnode>
<childnode refid="37" relation="include">
</childnode>
<childnode refid="38" relation="include">
</childnode>
</node>
<node id="40">
<label>serif/eos/relations/catalog.hpp</label>
<link refid="catalog_8hpp"/>
<childnode refid="41" relation="include">
</childnode>
<childnode refid="29" relation="include">
</childnode>
<childnode refid="13" relation="include">
</childnode>
</node>
<node id="38">
<label>serif/eos/relations/concepts.hpp</label>
<link refid="eos_2relations_2concepts_8hpp"/>
<childnode refid="39" relation="include">
</childnode>
</node>
<node id="43">
<label>serif/eos/relations/relations.hpp</label>
<link refid="eos_2relations_2relations_8hpp"/>
<childnode refid="40" relation="include">
</childnode>
<childnode refid="12" relation="include">
</childnode>
</node>
<node id="39">
<label>serif/eos/relations/traits.hpp</label>
<link refid="eos_2relations_2traits_8hpp"/>
<childnode refid="40" relation="include">
</childnode>
</node>
<node id="59">
<label>serif/equations/point.hpp</label>
<link refid="point_8hpp"/>
<childnode refid="7" relation="include">
</childnode>
<childnode refid="15" relation="include">
</childnode>
<childnode refid="25" relation="include">
</childnode>
<childnode refid="4" relation="include">
</childnode>
<childnode refid="5" relation="include">
</childnode>
<childnode refid="6" relation="include">
</childnode>
<childnode refid="31" relation="include">
</childnode>
</node>
<node id="2">
<label>serif/geometry/surface/compilation.hpp</label>
<link refid="compilation_8hpp"/>
<childnode refid="3" relation="include">
</childnode>
<childnode refid="48" relation="include">
</childnode>
</node>
<node id="50">
<label>serif/geometry/surface/computations.hpp</label>
<link refid="geometry_2surface_2computations_8hpp"/>
<childnode refid="4" relation="include">
</childnode>
<childnode refid="5" relation="include">
</childnode>
<childnode refid="51" relation="include">
</childnode>
<childnode refid="52" relation="include">
</childnode>
<childnode refid="66" relation="include">
</childnode>
</node>
<node id="52">
<label>serif/geometry/surface/detail/batches.hpp</label>
<link refid="batches_8hpp"/>
<childnode refid="7" relation="include">
</childnode>
<childnode refid="53" relation="include">
</childnode>
<childnode refid="60" relation="include">
</childnode>
</node>
<node id="53">
<label>serif/geometry/surface/detail/evaluation.hpp</label>
<link refid="geometry_2surface_2detail_2evaluation_8hpp"/>
<childnode refid="54" relation="include">
</childnode>
<childnode refid="55" relation="include">
</childnode>
<childnode refid="56" relation="include">
</childnode>
<childnode refid="57" relation="include">
</childnode>
</node>
<node id="3">
<label>serif/geometry/surface/detail/relations.hpp</label>
<link refid="geometry_2surface_2detail_2relations_8hpp"/>
<childnode refid="4" relation="include">
</childnode>
<childnode refid="5" relation="include">
</childnode>
<childnode refid="6" relation="include">
</childnode>
<childnode refid="35" relation="include">
</childnode>
<childnode refid="44" relation="include">
</childnode>
</node>
<node id="69">
<label>serif/geometry/surface/evaluation.hpp</label>
<link refid="geometry_2surface_2evaluation_8hpp"/>
<childnode refid="53" relation="include">
</childnode>
</node>
<node id="48">
<label>serif/geometry/surface/isobaric.hpp</label>
<link refid="isobaric_8hpp"/>
<childnode refid="7" relation="include">
</childnode>
<childnode refid="5" relation="include">
</childnode>
<childnode refid="12" relation="include">
</childnode>
<childnode refid="49" relation="include">
</childnode>
</node>
<node id="57">
<label>serif/geometry/surface/linearization.hpp</label>
<link refid="surface_2linearization_8hpp"/>
<childnode refid="25" relation="include">
</childnode>
<childnode refid="58" relation="include">
</childnode>
<childnode refid="11" relation="include">
</childnode>
<childnode refid="59" relation="include">
</childnode>
<childnode refid="2" relation="include">
</childnode>
</node>
<node id="60">
<label>serif/geometry/surface/samples.hpp</label>
<link refid="samples_8hpp"/>
<childnode refid="51" relation="include">
</childnode>
<childnode refid="61" relation="include">
</childnode>
<childnode refid="57" relation="include">
</childnode>
<childnode refid="62" relation="include">
</childnode>
</node>
<node id="1">
<label>src/include/serif/geometry/surface/surface.hpp</label>
<link refid="surface_8hpp"/>
<childnode refid="2" relation="include">
</childnode>
<childnode refid="50" relation="include">
</childnode>
<childnode refid="69" relation="include">
</childnode>
</node>
<node id="21">
<label>serif/meta/enums.hpp</label>
<link refid="enums_8hpp"/>
<childnode refid="22" relation="include">
</childnode>
<childnode refid="5" relation="include">
</childnode>
<childnode refid="23" relation="include">
</childnode>
</node>
<node id="32">
<label>serif/meta/names.hpp</label>
<link refid="names_8hpp"/>
<childnode refid="11" relation="include">
</childnode>
<childnode refid="33" relation="include">
</childnode>
</node>
<node id="47">
<label>serif/utils/dependencies/binding.hpp</label>
<link refid="utils_2dependencies_2binding_8hpp"/>
<childnode refid="7" relation="include">
</childnode>
<childnode refid="5" relation="include">
</childnode>
<childnode refid="42" relation="include">
</childnode>
</node>
<node id="67">
<label>serif/utils/dependencies/computation.hpp</label>
<link refid="computation_8hpp"/>
<childnode refid="15" relation="include">
</childnode>
<childnode refid="63" relation="include">
</childnode>
<childnode refid="5" relation="include">
</childnode>
<childnode refid="51" relation="include">
</childnode>
<childnode refid="46" relation="include">
</childnode>
</node>
<node id="66">
<label>serif/utils/dependencies/computation_graph.hpp</label>
<link refid="computation__graph_8hpp"/>
<childnode refid="15" relation="include">
</childnode>
<childnode refid="25" relation="include">
</childnode>
<childnode refid="4" relation="include">
</childnode>
<childnode refid="5" relation="include">
</childnode>
<childnode refid="51" relation="include">
</childnode>
<childnode refid="67" relation="include">
</childnode>
<childnode refid="44" relation="include">
</childnode>
<childnode refid="68" relation="include">
</childnode>
</node>
<node id="68">
<label>serif/utils/dependencies/detail/graph.hpp</label>
<link refid="utils_2dependencies_2detail_2graph_8hpp"/>
<childnode refid="7" relation="include">
</childnode>
<childnode refid="25" relation="include">
</childnode>
<childnode refid="45" relation="include">
</childnode>
</node>
<node id="45">
<label>serif/utils/dependencies/detail/type_lists.hpp</label>
<link refid="type__lists_8hpp"/>
<childnode refid="7" relation="include">
</childnode>
<childnode refid="25" relation="include">
</childnode>
<childnode refid="5" relation="include">
</childnode>
<childnode refid="46" relation="include">
</childnode>
</node>
<node id="46">
<label>serif/utils/dependencies/key_list.hpp</label>
<link refid="key__list_8hpp"/>
<childnode refid="5" relation="include">
</childnode>
<childnode refid="47" relation="include">
</childnode>
<childnode refid="42" relation="include">
</childnode>
<childnode refid="31" relation="include">
</childnode>
</node>
<node id="44">
<label>serif/utils/dependencies/key_list_operations.hpp</label>
<link refid="key__list__operations_8hpp"/>
<childnode refid="25" relation="include">
</childnode>
<childnode refid="5" relation="include">
</childnode>
<childnode refid="45" relation="include">
</childnode>
</node>
<node id="62">
<label>serif/utils/dependencies/resource.hpp</label>
<link refid="resource_8hpp"/>
<childnode refid="63" relation="include">
</childnode>
<childnode refid="5" relation="include">
</childnode>
<childnode refid="51" relation="include">
</childnode>
<childnode refid="64" relation="include">
</childnode>
</node>
<node id="64">
<label>serif/utils/dependencies/snapshot.hpp</label>
<link refid="snapshot_8hpp"/>
<childnode refid="15" relation="include">
</childnode>
<childnode refid="63" relation="include">
</childnode>
<childnode refid="65" relation="include">
</childnode>
<childnode refid="5" relation="include">
</childnode>
<childnode refid="51" relation="include">
</childnode>
</node>
<node id="17">
<label>serif/utils/misc/concepts/numeric.hpp</label>
<link refid="numeric_8hpp"/>
<childnode refid="15" relation="include">
</childnode>
<childnode refid="5" relation="include">
</childnode>
</node>
<node id="41">
<label>serif/utils/misc/concepts/type_uniqueness.hpp</label>
<link refid="concepts_2type__uniqueness_8hpp"/>
<childnode refid="42" relation="include">
</childnode>
</node>
<node id="16">
<label>serif/utils/misc/std_helper/cleaning.hpp</label>
<link refid="cleaning_8hpp"/>
<childnode refid="5" relation="include">
</childnode>
</node>
<node id="29">
<label>serif/utils/misc/std_helper/variadic_cleaning.hpp</label>
<link refid="variadic__cleaning_8hpp"/>
<childnode refid="25" relation="include">
</childnode>
</node>
<node id="42">
<label>serif/utils/misc/traits/type_uniqueness.hpp</label>
<link refid="traits_2type__uniqueness_8hpp"/>
<childnode refid="7" relation="include">
</childnode>
<childnode refid="16" relation="include">
</childnode>
</node>
<node id="31">
<label>serif/utils/types/type_list.hpp</label>
<link refid="type__list_8hpp"/>
</node>
<node id="7">
<label>array</label>
</node>
<node id="54">
<label>cmath</label>
</node>
<node id="14">
<label>compare</label>
</node>
<node id="15">
<label>concepts</label>
</node>
<node id="25">
<label>cstddef</label>
</node>
<node id="55">
<label>expected</label>
</node>
<node id="20">
<label>format</label>
</node>
<node id="63">
<label>functional</label>
</node>
<node id="58">
<label>limits</label>
</node>
<node id="23">
<label>magic_enum/magic_enum_all.hpp</label>
</node>
<node id="65">
<label>memory</label>
</node>
<node id="33">
<label>nameof.hpp</label>
</node>
<node id="27">
<label>numeric</label>
</node>
<node id="26">
<label>span</label>
</node>
<node id="11">
<label>string_view</label>
</node>
<node id="4">
<label>tuple</label>
</node>
<node id="5">
<label>type_traits</label>
</node>
<node id="22">
<label>unordered_map</label>
</node>
<node id="51">
<label>utility</label>
</node>
<node id="61">
<label>vector</label>
</node>
</incdepgraph>
<invincdepgraph>
<node id="2">
<label>src/compile_time_checks/serif/geometry/surface.cpp</label>
<link refid="surface_8cpp"/>
</node>
<node id="1">
<label>src/include/serif/geometry/surface/surface.hpp</label>
<link refid="surface_8hpp"/>
<childnode refid="2" relation="include">
</childnode>
</node>
</invincdepgraph>
<briefdescription>
<para>Isobaric conditions, EOS-selected formulations, and reusable boundary calculations. </para>
</briefdescription>
<detaileddescription>
<para>IsobaricSurface describes the prescribed pressure. PressureSurfaceFormulation selects one compatible EOS relation and its carrier; DirectPressureSurfaceFormulation explicitly chooses a forward pressure residual and its equation row. Neither selects a finite-element trace.</para>
<para>Use evaluate_pressure_surface for one sampled point, or make_pressure_surface_graph for an ordered batch. The latter returns an ordinary dependency graph: the caller supplies the EOS with its tracking policy, the pressure condition, and typed boundary values. Results use the same PointLinearization representation as other equations. Finite-element row enforcement remains a separate numerical capability. </para>
</detaileddescription>
<programlisting>
<codeline lineno="1"><highlight class="preprocessor">#pragma<sp/>once</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="2"><highlight class="normal"></highlight></codeline>
<codeline lineno="14"><highlight class="normal"></highlight></codeline>
<codeline lineno="15"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&quot;<ref refid="compilation_8hpp" kindref="compound">serif/geometry/surface/compilation.hpp</ref>&quot;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="16"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&quot;<ref refid="geometry_2surface_2computations_8hpp" kindref="compound">serif/geometry/surface/computations.hpp</ref>&quot;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="17"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&quot;<ref refid="geometry_2surface_2evaluation_8hpp" kindref="compound">serif/geometry/surface/evaluation.hpp</ref>&quot;</highlight><highlight class="normal"></highlight></codeline>
</programlisting>
<location file="src/include/serif/geometry/surface/surface.hpp"/>
</compounddef>
</doxygen>
Reference in New Issue View Git Blame Copy Permalink