Emily Boudreaux
6b57738330
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)
103 lines
6.0 KiB
XML
103 lines
6.0 KiB
XML
<?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="namespaceserif" kind="namespace" language="C++">
|
|
<compoundname>serif</compoundname>
|
|
<innernamespace refid="namespaceserif_1_1backend">serif::backend</innernamespace>
|
|
<innernamespace refid="namespaceserif_1_1compile__time__checks">serif::compile_time_checks</innernamespace>
|
|
<innernamespace refid="namespaceserif_1_1dimensions">serif::dimensions</innernamespace>
|
|
<innernamespace refid="namespaceserif_1_1discretization">serif::discretization</innernamespace>
|
|
<innernamespace refid="namespaceserif_1_1eos">serif::eos</innernamespace>
|
|
<innernamespace refid="namespaceserif_1_1equations">serif::equations</innernamespace>
|
|
<innernamespace refid="namespaceserif_1_1geometry">serif::geometry</innernamespace>
|
|
<innernamespace refid="namespaceserif_1_1mapping">serif::mapping</innernamespace>
|
|
<innernamespace refid="namespaceserif_1_1meta">serif::meta</innernamespace>
|
|
<innernamespace refid="namespaceserif_1_1model">serif::model</innernamespace>
|
|
<innernamespace refid="namespaceserif_1_1operators">serif::operators</innernamespace>
|
|
<innernamespace refid="namespaceserif_1_1solver">serif::solver</innernamespace>
|
|
<innernamespace refid="namespaceserif_1_1utils">serif::utils</innernamespace>
|
|
<sectiondef kind="typedef">
|
|
<memberdef kind="typedef" id="namespaceserif_1ab7690da8665e9d9bd2fa8e8534cd6e57" prot="public" static="no">
|
|
<type><ref refid="namespaceserif_1_1backend_1_1mfem_1afdd4d9966e5040b2de0684e018dce66e" kindref="member">backend::mfem::Vector</ref></type>
|
|
<definition>using serif::Vector = backend::mfem::Vector</definition>
|
|
<argsstring></argsstring>
|
|
<name>Vector</name>
|
|
<qualifiedname>serif::Vector</qualifiedname>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/types.hpp" line="7" column="5" bodyfile="src/include/serif/types.hpp" bodystart="7" bodyend="-1"/>
|
|
</memberdef>
|
|
<memberdef kind="typedef" id="namespaceserif_1a2d701ec924ef77ca55c63361e80bc19d" prot="public" static="no">
|
|
<type><ref refid="namespaceserif_1_1backend_1_1mfem_1a074a5dd97af4c4276d0f42e21075a135" kindref="member">backend::mfem::DenseMatrix</ref></type>
|
|
<definition>using serif::DenseMatrix = backend::mfem::DenseMatrix</definition>
|
|
<argsstring></argsstring>
|
|
<name>DenseMatrix</name>
|
|
<qualifiedname>serif::DenseMatrix</qualifiedname>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/types.hpp" line="8" column="5" bodyfile="src/include/serif/types.hpp" bodystart="8" bodyend="-1"/>
|
|
</memberdef>
|
|
<memberdef kind="typedef" id="namespaceserif_1a90679f321c52b8a722250593c545d1c0" prot="public" static="no">
|
|
<type><ref refid="namespaceserif_1_1backend_1_1mfem_1a5f09505621d66ad460626d5a868c9e21" kindref="member">backend::mfem::SparseMatrix</ref></type>
|
|
<definition>using serif::SparseMatrix = backend::mfem::SparseMatrix</definition>
|
|
<argsstring></argsstring>
|
|
<name>SparseMatrix</name>
|
|
<qualifiedname>serif::SparseMatrix</qualifiedname>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/types.hpp" line="9" column="5" bodyfile="src/include/serif/types.hpp" bodystart="9" bodyend="-1"/>
|
|
</memberdef>
|
|
<memberdef kind="typedef" id="namespaceserif_1ab1840b03c7cbd4fa5b1dd32f73e53089" prot="public" static="no">
|
|
<type><ref refid="namespaceserif_1_1backend_1_1mfem_1aa6d65d6620b55f916624192885696d27" kindref="member">backend::mfem::LinearOperator</ref></type>
|
|
<definition>using serif::LinearOperator = backend::mfem::LinearOperator</definition>
|
|
<argsstring></argsstring>
|
|
<name>LinearOperator</name>
|
|
<qualifiedname>serif::LinearOperator</qualifiedname>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/types.hpp" line="10" column="5" bodyfile="src/include/serif/types.hpp" bodystart="10" bodyend="-1"/>
|
|
</memberdef>
|
|
</sectiondef>
|
|
<sectiondef kind="func">
|
|
<memberdef kind="function" id="namespaceserif_1a31cb75e36c6ad0a21557f789d67229f1" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<type>void</type>
|
|
<definition>void serif::backend::mfem::initialize</definition>
|
|
<argsstring>()</argsstring>
|
|
<name>initialize</name>
|
|
<qualifiedname>serif::initialize</qualifiedname>
|
|
<briefdescription>
|
|
<para>Initialize the selected numerical runtime once, before application work begins. </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
<para><simplesect kind="note"><para>Call on the main thread. An existing MPI session remains externally owned; a session started here is finalized by MFEM at process exit. Serial builds need no initialization. </para>
|
|
</simplesect>
|
|
</para>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/runtime.hpp" line="6" column="5" bodyfile="src/lib/serif/backend/mfem/runtime.cpp" bodystart="7" bodyend="17"/>
|
|
</memberdef>
|
|
</sectiondef>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<location file="src/compile_time_checks/serif/dimensions/catalogue_meanfield.cpp" line="5" column="1"/>
|
|
</compounddef>
|
|
</doxygen>
|