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)
521 lines
32 KiB
XML
521 lines
32 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_1_1mapping" kind="namespace" language="C++">
|
|
<compoundname>serif::mapping</compoundname>
|
|
<innerclass refid="structserif_1_1mapping_1_1_compactification_point_data" prot="public">serif::mapping::CompactificationPointData</innerclass>
|
|
<innerclass refid="structserif_1_1mapping_1_1_d_m_fixed_mesh_geometry" prot="public">serif::mapping::DMFixedMeshGeometry</innerclass>
|
|
<innerclass refid="structserif_1_1mapping_1_1_d_m_reference_displacement_sample" prot="public">serif::mapping::DMReferenceDisplacementSample</innerclass>
|
|
<innerclass refid="classserif_1_1mapping_1_1_d_m_workspace" prot="public">serif::mapping::DMWorkspace</innerclass>
|
|
<innerclass refid="classserif_1_1mapping_1_1_domain_mapper" prot="public">serif::mapping::DomainMapper</innerclass>
|
|
<innerclass refid="classserif_1_1mapping_1_1_element_compactification_data" prot="public">serif::mapping::ElementCompactificationData</innerclass>
|
|
<innerclass refid="classserif_1_1mapping_1_1_element_displacement_data" prot="public">serif::mapping::ElementDisplacementData</innerclass>
|
|
<innerclass refid="structserif_1_1mapping_1_1_element_mapping_data" prot="public">serif::mapping::ElementMappingData</innerclass>
|
|
<innerclass refid="structserif_1_1mapping_1_1_face_mapping_context" prot="public">serif::mapping::FaceMappingContext</innerclass>
|
|
<innerclass refid="structserif_1_1mapping_1_1_face_mapping_variation" prot="public">serif::mapping::FaceMappingVariation</innerclass>
|
|
<innerclass refid="structserif_1_1mapping_1_1_face_quadrature_context" prot="public">serif::mapping::FaceQuadratureContext</innerclass>
|
|
<innerclass refid="classserif_1_1mapping_1_1_grid_function_mapping_evaluator" prot="public">serif::mapping::GridFunctionMappingEvaluator</innerclass>
|
|
<innerclass refid="structserif_1_1mapping_1_1_mapping_point_context" prot="public">serif::mapping::MappingPointContext</innerclass>
|
|
<innerclass refid="structserif_1_1mapping_1_1_mapping_point_variation" prot="public">serif::mapping::MappingPointVariation</innerclass>
|
|
<innerclass refid="classserif_1_1mapping_1_1_volume_mapping_cache" prot="public">serif::mapping::VolumeMappingCache</innerclass>
|
|
<innerclass refid="structserif_1_1mapping_1_1_volume_mapping_context" prot="public">serif::mapping::VolumeMappingContext</innerclass>
|
|
<innerclass refid="structserif_1_1mapping_1_1_volume_mapping_variation" prot="public">serif::mapping::VolumeMappingVariation</innerclass>
|
|
<innerclass refid="structserif_1_1mapping_1_1_volume_quadrature_context" prot="public">serif::mapping::VolumeQuadratureContext</innerclass>
|
|
<innernamespace refid="namespaceserif_1_1mapping_1_1compactification">serif::mapping::compactification</innernamespace>
|
|
<sectiondef kind="enum">
|
|
<memberdef kind="enum" id="namespaceserif_1_1mapping_1ab6598ecc4776dc488540df0614e1e560" prot="public" static="no" strong="yes">
|
|
<type>uint8_t</type>
|
|
<name>FaceElementSide</name>
|
|
<qualifiedname>serif::mapping::FaceElementSide</qualifiedname>
|
|
<enumvalue id="namespaceserif_1_1mapping_1ab6598ecc4776dc488540df0614e1e560a589425fc56eb03218b1af97890453405" prot="public">
|
|
<name>ELEMENT_1</name>
|
|
<briefdescription>
|
|
<para>Represents the first side of a face element. </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1mapping_1ab6598ecc4776dc488540df0614e1e560ac9c067c94697dcb6cd7511c238bfe20c" prot="public">
|
|
<name>ELEMENT_2</name>
|
|
<briefdescription>
|
|
<para>Represents the second side of a face element. </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<briefdescription>
|
|
<para>An enumeration representing the side of a face element, either ELEMENT_1 or ELEMENT_2. There is no inherent ordering to these; however, broadly I have been thinking about ELEMENT_1 as the "inner" side and ELEMENT_2 as the "outer" side. </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/backend/mfem/mapping/data.hpp" line="36" column="5" bodyfile="src/include/serif/backend/mfem/mapping/data.hpp" bodystart="36" bodyend="39"/>
|
|
</memberdef>
|
|
<memberdef kind="enum" id="namespaceserif_1_1mapping_1a4d8ed5ebf76c79667efd6777f3ee3b97" prot="public" static="no" strong="yes">
|
|
<type>uint16_t</type>
|
|
<name>MappingStatus</name>
|
|
<qualifiedname>serif::mapping::MappingStatus</qualifiedname>
|
|
<enumvalue id="namespaceserif_1_1mapping_1a4d8ed5ebf76c79667efd6777f3ee3b97ac9f1a6384b1c466d4612f513bd8e13ea" prot="public">
|
|
<name>VALID</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1mapping_1a4d8ed5ebf76c79667efd6777f3ee3b97a6c849957a6a4a88b7fb6fcb716d651f1" prot="public">
|
|
<name>INVALID_DIMENSION</name>
|
|
<initializer>= 400</initializer>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1mapping_1a4d8ed5ebf76c79667efd6777f3ee3b97a58690190e68105ca9d4c573f113ced94" prot="public">
|
|
<name>NON_FINITE_MAPPING_INPUT</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1mapping_1a4d8ed5ebf76c79667efd6777f3ee3b97a664863abf724900cacb79236732b0d24" prot="public">
|
|
<name>INVALID_REFERENCE_RADIUS</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1mapping_1a4d8ed5ebf76c79667efd6777f3ee3b97a64cde656c0dea359e0e048c5b1a45020" prot="public">
|
|
<name>AT_COMPACTIFIED_INFINITY</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1mapping_1a4d8ed5ebf76c79667efd6777f3ee3b97a46b382cdaef0bff17df6f22ed6ac0c80" prot="public">
|
|
<name>OUTSIDE_REFERENCE_DOMAIN</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1mapping_1a4d8ed5ebf76c79667efd6777f3ee3b97aed5aaccb3615a644e604d2867cb722a5" prot="public">
|
|
<name>NON_FINITE_MAPPING_RESULT</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1mapping_1a4d8ed5ebf76c79667efd6777f3ee3b97a8046940b838d63b536825ef425a6de82" prot="public">
|
|
<name>NON_POSITIVE_DETERMINATE</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/backend/mfem/mapping/status.hpp" line="12" column="5" bodyfile="src/include/serif/backend/mfem/mapping/status.hpp" bodystart="12" bodyend="24"/>
|
|
</memberdef>
|
|
</sectiondef>
|
|
<sectiondef kind="var">
|
|
<memberdef kind="variable" id="namespaceserif_1_1mapping_1acc09e8994ba97d5248f33505c75aa9f4" prot="public" static="yes" mutable="no">
|
|
<type>auto</type>
|
|
<definition>auto serif::mapping::MappingStatus_enum_string_map</definition>
|
|
<argsstring></argsstring>
|
|
<name>MappingStatus_enum_string_map</name>
|
|
<qualifiedname>serif::mapping::MappingStatus_enum_string_map</qualifiedname>
|
|
<initializer>= <ref refid="namespaceserif_1_1meta_1a228074fe1d60918db17444e31b601c2f" kindref="member">meta::enum_to_enum_string_map</ref><<ref refid="namespaceserif_1_1mapping_1a4d8ed5ebf76c79667efd6777f3ee3b97" kindref="member">MappingStatus</ref>>()</initializer>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/backend/mfem/mapping/status.hpp" line="26" column="17" bodyfile="src/include/serif/backend/mfem/mapping/status.hpp" bodystart="26" bodyend="-1"/>
|
|
</memberdef>
|
|
<memberdef kind="variable" id="namespaceserif_1_1mapping_1a6a788fb1187f102ca7fdfd1a7cc9f6fd" prot="public" static="yes" mutable="no">
|
|
<type>auto</type>
|
|
<definition>auto serif::mapping::MappingStatus_string_enum_map</definition>
|
|
<argsstring></argsstring>
|
|
<name>MappingStatus_string_enum_map</name>
|
|
<qualifiedname>serif::mapping::MappingStatus_string_enum_map</qualifiedname>
|
|
<initializer>= <ref refid="namespaceserif_1_1meta_1a27a478b13abbbddd3b16dce448ce87fa" kindref="member">meta::enum_to_string_enum_map</ref><<ref refid="namespaceserif_1_1mapping_1a4d8ed5ebf76c79667efd6777f3ee3b97" kindref="member">MappingStatus</ref>>()</initializer>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/backend/mfem/mapping/status.hpp" line="27" column="17" bodyfile="src/include/serif/backend/mfem/mapping/status.hpp" bodystart="27" bodyend="-1"/>
|
|
</memberdef>
|
|
<memberdef kind="variable" id="namespaceserif_1_1mapping_1ad623f50e4d9c962ea8fdfff2ee9488ad" prot="public" static="yes" mutable="no">
|
|
<type>auto</type>
|
|
<definition>auto serif::mapping::MappingStatus_SERiFErrorCode_map</definition>
|
|
<argsstring></argsstring>
|
|
<name>MappingStatus_SERiFErrorCode_map</name>
|
|
<qualifiedname>serif::mapping::MappingStatus_SERiFErrorCode_map</qualifiedname>
|
|
<initializer>= <ref refid="namespaceserif_1_1mapping_1a0a8fb135cd55270d8d4be849e7379b5b" kindref="member">make_MappingStatus_SERiFErrorCode_map</ref>()</initializer>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/backend/mfem/mapping/status.hpp" line="55" column="17" bodyfile="src/include/serif/backend/mfem/mapping/status.hpp" bodystart="55" bodyend="-1"/>
|
|
</memberdef>
|
|
<memberdef kind="variable" id="namespaceserif_1_1mapping_1a0a0a50f0b194b72a0d98768bfb9a0855" prot="public" static="yes" mutable="no">
|
|
<type>auto</type>
|
|
<definition>auto serif::mapping::SERiFErrorCode_MappingStatus_map</definition>
|
|
<argsstring></argsstring>
|
|
<name>SERiFErrorCode_MappingStatus_map</name>
|
|
<qualifiedname>serif::mapping::SERiFErrorCode_MappingStatus_map</qualifiedname>
|
|
<initializer>= <ref refid="namespaceserif_1_1mapping_1a649692e7f44a43da4d06fef545915cf5" kindref="member">make_SERIFErrorCode_MappingStatus_map</ref>()</initializer>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/backend/mfem/mapping/status.hpp" line="56" column="17" bodyfile="src/include/serif/backend/mfem/mapping/status.hpp" bodystart="56" bodyend="-1"/>
|
|
</memberdef>
|
|
</sectiondef>
|
|
<sectiondef kind="func">
|
|
<memberdef kind="function" id="namespaceserif_1_1mapping_1a89488756ce19ff5351dfbeb4235849c3" prot="public" static="no" nodiscard="yes" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<type><ref refid="classserif_1_1mapping_1_1_element_displacement_data" kindref="compound">ElementDisplacementData</ref></type>
|
|
<definition>ElementDisplacementData serif::mapping::element_displacement_data_from_element_vdofs</definition>
|
|
<argsstring>(const mfem::FiniteElement &element, mfem::Vector &displacement_dofs)</argsstring>
|
|
<name>element_displacement_data_from_element_vdofs</name>
|
|
<qualifiedname>serif::mapping::element_displacement_data_from_element_vdofs</qualifiedname>
|
|
<param>
|
|
<type>const mfem::FiniteElement &</type>
|
|
<declname>element</declname>
|
|
</param>
|
|
<param>
|
|
<type>mfem::Vector &</type>
|
|
<declname>displacement_dofs</declname>
|
|
</param>
|
|
<briefdescription>
|
|
<para>Creates an <ref refid="classserif_1_1mapping_1_1_element_displacement_data" kindref="compound">ElementDisplacementData</ref> object from a finite element and a vector of displacement degrees of freedom. </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
<para><parameterlist kind="param"><parameteritem>
|
|
<parameternamelist>
|
|
<parametername>element</parametername>
|
|
</parameternamelist>
|
|
<parameterdescription>
|
|
<para>The finite element associated with the displacement data. </para>
|
|
</parameterdescription>
|
|
</parameteritem>
|
|
<parameteritem>
|
|
<parameternamelist>
|
|
<parametername>displacement_dofs</parametername>
|
|
</parameternamelist>
|
|
<parameterdescription>
|
|
<para>The vector containing the displacement degrees of freedom. </para>
|
|
</parameterdescription>
|
|
</parameteritem>
|
|
</parameterlist>
|
|
<simplesect kind="return"><para>An <ref refid="classserif_1_1mapping_1_1_element_displacement_data" kindref="compound">ElementDisplacementData</ref> object constructed from the provided finite element and displacement degrees of freedom.</para>
|
|
</simplesect>
|
|
<simplesect kind="note"><para>This is just a convenience function which calls the constructor for <ref refid="classserif_1_1mapping_1_1_element_displacement_data" kindref="compound">ElementDisplacementData</ref>. </para>
|
|
</simplesect>
|
|
</para>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/lib/serif/backend/mfem/mapping/data.cpp" line="54" column="29" bodyfile="src/lib/serif/backend/mfem/mapping/data.cpp" bodystart="54" bodyend="56" declfile="src/include/serif/backend/mfem/mapping/data.hpp" declline="114" declcolumn="30"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="namespaceserif_1_1mapping_1a8935271a2117c2232be8306651d5ce9f" prot="public" static="no" nodiscard="yes" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<type>std::expected< <ref refid="structserif_1_1mapping_1_1_d_m_fixed_mesh_geometry" kindref="compound">DMFixedMeshGeometry</ref>, <ref refid="namespaceserif_1_1mapping_1a4d8ed5ebf76c79667efd6777f3ee3b97" kindref="member">MappingStatus</ref> ></type>
|
|
<definition>std::expected< DMFixedMeshGeometry, MappingStatus > serif::mapping::sample_fixed_mesh_geometry</definition>
|
|
<argsstring>(mfem::ElementTransformation &transformation, const mfem::IntegrationPoint &point)</argsstring>
|
|
<name>sample_fixed_mesh_geometry</name>
|
|
<qualifiedname>serif::mapping::sample_fixed_mesh_geometry</qualifiedname>
|
|
<param>
|
|
<type>mfem::ElementTransformation &</type>
|
|
<declname>transformation</declname>
|
|
</param>
|
|
<param>
|
|
<type>const mfem::IntegrationPoint &</type>
|
|
<declname>point</declname>
|
|
</param>
|
|
<briefdescription>
|
|
<para>Sample immutable mesh geometry; callers decide how long its mesh revision remains valid. </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/lib/serif/backend/mfem/mapping/domain_mapper.cpp" line="38" column="19" bodyfile="src/lib/serif/backend/mfem/mapping/domain_mapper.cpp" bodystart="38" bodyend="59" declfile="src/include/serif/backend/mfem/mapping/domain_mapper.hpp" declline="21" declcolumn="20"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="namespaceserif_1_1mapping_1a0a8fb135cd55270d8d4be849e7379b5b" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
|
|
<type>std::unordered_map< <ref refid="namespaceserif_1_1mapping_1a4d8ed5ebf76c79667efd6777f3ee3b97" kindref="member">MappingStatus</ref>, <ref refid="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346" kindref="member">utils::errors::SERiFErrorCode</ref> ></type>
|
|
<definition>std::unordered_map< MappingStatus, utils::errors::SERiFErrorCode > serif::mapping::make_MappingStatus_SERiFErrorCode_map</definition>
|
|
<argsstring>()</argsstring>
|
|
<name>make_MappingStatus_SERiFErrorCode_map</name>
|
|
<qualifiedname>serif::mapping::make_MappingStatus_SERiFErrorCode_map</qualifiedname>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/backend/mfem/mapping/status.hpp" line="29" column="31" bodyfile="src/include/serif/backend/mfem/mapping/status.hpp" bodystart="29" bodyend="38"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="namespaceserif_1_1mapping_1a649692e7f44a43da4d06fef545915cf5" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
|
|
<type>std::unordered_map< <ref refid="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346" kindref="member">utils::errors::SERiFErrorCode</ref>, <ref refid="namespaceserif_1_1mapping_1a4d8ed5ebf76c79667efd6777f3ee3b97" kindref="member">MappingStatus</ref> ></type>
|
|
<definition>std::unordered_map< utils::errors::SERiFErrorCode, MappingStatus > serif::mapping::make_SERIFErrorCode_MappingStatus_map</definition>
|
|
<argsstring>()</argsstring>
|
|
<name>make_SERIFErrorCode_MappingStatus_map</name>
|
|
<qualifiedname>serif::mapping::make_SERIFErrorCode_MappingStatus_map</qualifiedname>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/backend/mfem/mapping/status.hpp" line="40" column="31" bodyfile="src/include/serif/backend/mfem/mapping/status.hpp" bodystart="40" bodyend="50"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="namespaceserif_1_1mapping_1aa6a46b5e15195df804cff440b526b38a" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<type>void</type>
|
|
<definition>void serif::mapping::map_reference_gradient_to_physical</definition>
|
|
<argsstring>(const MappingPointContext &context, const mfem::Vector &reference_gradient, mfem::Vector &physical_gradient)</argsstring>
|
|
<name>map_reference_gradient_to_physical</name>
|
|
<qualifiedname>serif::mapping::map_reference_gradient_to_physical</qualifiedname>
|
|
<param>
|
|
<type>const <ref refid="structserif_1_1mapping_1_1_mapping_point_context" kindref="compound">MappingPointContext</ref> &</type>
|
|
<declname>context</declname>
|
|
</param>
|
|
<param>
|
|
<type>const mfem::Vector &</type>
|
|
<declname>reference_gradient</declname>
|
|
</param>
|
|
<param>
|
|
<type>mfem::Vector &</type>
|
|
<declname>physical_gradient</declname>
|
|
</param>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/lib/serif/backend/mfem/mapping/transformations.cpp" line="10" column="10" bodyfile="src/lib/serif/backend/mfem/mapping/transformations.cpp" bodystart="10" bodyend="15" declfile="src/include/serif/backend/mfem/mapping/transformations.hpp" declline="7" declcolumn="10"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="namespaceserif_1_1mapping_1a97493ae5b8a6d9025eca6fcd8b6cbdcc" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<type>void</type>
|
|
<definition>void serif::mapping::map_physical_gradient_to_reference</definition>
|
|
<argsstring>(const MappingPointContext &context, const mfem::Vector &physical_gradient, mfem::Vector &reference_gradient)</argsstring>
|
|
<name>map_physical_gradient_to_reference</name>
|
|
<qualifiedname>serif::mapping::map_physical_gradient_to_reference</qualifiedname>
|
|
<param>
|
|
<type>const <ref refid="structserif_1_1mapping_1_1_mapping_point_context" kindref="compound">MappingPointContext</ref> &</type>
|
|
<declname>context</declname>
|
|
</param>
|
|
<param>
|
|
<type>const mfem::Vector &</type>
|
|
<declname>physical_gradient</declname>
|
|
</param>
|
|
<param>
|
|
<type>mfem::Vector &</type>
|
|
<declname>reference_gradient</declname>
|
|
</param>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/lib/serif/backend/mfem/mapping/transformations.cpp" line="17" column="10" bodyfile="src/lib/serif/backend/mfem/mapping/transformations.cpp" bodystart="17" bodyend="22" declfile="src/include/serif/backend/mfem/mapping/transformations.hpp" declline="13" declcolumn="10"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="namespaceserif_1_1mapping_1ae918a917f380b8831e5778c1e42a1ae5" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<type>void</type>
|
|
<definition>void serif::mapping::map_reference_vector_gradient_to_physical</definition>
|
|
<argsstring>(const MappingPointContext &context, const mfem::DenseMatrix &reference_vector_gradient, mfem::DenseMatrix &physical_vector_gradient)</argsstring>
|
|
<name>map_reference_vector_gradient_to_physical</name>
|
|
<qualifiedname>serif::mapping::map_reference_vector_gradient_to_physical</qualifiedname>
|
|
<param>
|
|
<type>const <ref refid="structserif_1_1mapping_1_1_mapping_point_context" kindref="compound">MappingPointContext</ref> &</type>
|
|
<declname>context</declname>
|
|
</param>
|
|
<param>
|
|
<type>const mfem::DenseMatrix &</type>
|
|
<declname>reference_vector_gradient</declname>
|
|
</param>
|
|
<param>
|
|
<type>mfem::DenseMatrix &</type>
|
|
<declname>physical_vector_gradient</declname>
|
|
</param>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/lib/serif/backend/mfem/mapping/transformations.cpp" line="24" column="10" bodyfile="src/lib/serif/backend/mfem/mapping/transformations.cpp" bodystart="24" bodyend="29" declfile="src/include/serif/backend/mfem/mapping/transformations.hpp" declline="19" declcolumn="10"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="namespaceserif_1_1mapping_1a825bbcbe6b890c000b49c4c1da007b31" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<type>void</type>
|
|
<definition>void serif::mapping::map_physical_vector_gradient_to_reference</definition>
|
|
<argsstring>(const MappingPointContext &context, const mfem::DenseMatrix &physical_vector_gradient, mfem::DenseMatrix &reference_vector_gradient)</argsstring>
|
|
<name>map_physical_vector_gradient_to_reference</name>
|
|
<qualifiedname>serif::mapping::map_physical_vector_gradient_to_reference</qualifiedname>
|
|
<param>
|
|
<type>const <ref refid="structserif_1_1mapping_1_1_mapping_point_context" kindref="compound">MappingPointContext</ref> &</type>
|
|
<declname>context</declname>
|
|
</param>
|
|
<param>
|
|
<type>const mfem::DenseMatrix &</type>
|
|
<declname>physical_vector_gradient</declname>
|
|
</param>
|
|
<param>
|
|
<type>mfem::DenseMatrix &</type>
|
|
<declname>reference_vector_gradient</declname>
|
|
</param>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/lib/serif/backend/mfem/mapping/transformations.cpp" line="31" column="10" bodyfile="src/lib/serif/backend/mfem/mapping/transformations.cpp" bodystart="31" bodyend="36" declfile="src/include/serif/backend/mfem/mapping/transformations.hpp" declline="25" declcolumn="10"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="namespaceserif_1_1mapping_1abc6cb133d3e21801bb8c7a66acf0d454" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<type>void</type>
|
|
<definition>void serif::mapping::compute_scalar_diffusion_tensor</definition>
|
|
<argsstring>(const MappingPointContext &context, mfem::DenseMatrix &diffusion_tensor)</argsstring>
|
|
<name>compute_scalar_diffusion_tensor</name>
|
|
<qualifiedname>serif::mapping::compute_scalar_diffusion_tensor</qualifiedname>
|
|
<param>
|
|
<type>const <ref refid="structserif_1_1mapping_1_1_mapping_point_context" kindref="compound">MappingPointContext</ref> &</type>
|
|
<declname>context</declname>
|
|
</param>
|
|
<param>
|
|
<type>mfem::DenseMatrix &</type>
|
|
<declname>diffusion_tensor</declname>
|
|
</param>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/lib/serif/backend/mfem/mapping/transformations.cpp" line="38" column="10" bodyfile="src/lib/serif/backend/mfem/mapping/transformations.cpp" bodystart="38" bodyend="46" declfile="src/include/serif/backend/mfem/mapping/transformations.hpp" declline="31" declcolumn="10"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="namespaceserif_1_1mapping_1a844a314f5fc632100bc3c67d5a922469" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<type>void</type>
|
|
<definition>void serif::mapping::map_hcurl_field_to_physical</definition>
|
|
<argsstring>(const MappingPointContext &context, const mfem::Vector &reference_field, mfem::Vector &physical_field)</argsstring>
|
|
<name>map_hcurl_field_to_physical</name>
|
|
<qualifiedname>serif::mapping::map_hcurl_field_to_physical</qualifiedname>
|
|
<param>
|
|
<type>const <ref refid="structserif_1_1mapping_1_1_mapping_point_context" kindref="compound">MappingPointContext</ref> &</type>
|
|
<declname>context</declname>
|
|
</param>
|
|
<param>
|
|
<type>const mfem::Vector &</type>
|
|
<declname>reference_field</declname>
|
|
</param>
|
|
<param>
|
|
<type>mfem::Vector &</type>
|
|
<declname>physical_field</declname>
|
|
</param>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/lib/serif/backend/mfem/mapping/transformations.cpp" line="48" column="10" bodyfile="src/lib/serif/backend/mfem/mapping/transformations.cpp" bodystart="48" bodyend="53" declfile="src/include/serif/backend/mfem/mapping/transformations.hpp" declline="36" declcolumn="10"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="namespaceserif_1_1mapping_1a35ee8af3658ffb4da27c6dd962575b35" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<type>void</type>
|
|
<definition>void serif::mapping::map_physical_field_to_hcurl_reference</definition>
|
|
<argsstring>(const MappingPointContext &context, const mfem::Vector &physical_field, mfem::Vector &reference_field)</argsstring>
|
|
<name>map_physical_field_to_hcurl_reference</name>
|
|
<qualifiedname>serif::mapping::map_physical_field_to_hcurl_reference</qualifiedname>
|
|
<param>
|
|
<type>const <ref refid="structserif_1_1mapping_1_1_mapping_point_context" kindref="compound">MappingPointContext</ref> &</type>
|
|
<declname>context</declname>
|
|
</param>
|
|
<param>
|
|
<type>const mfem::Vector &</type>
|
|
<declname>physical_field</declname>
|
|
</param>
|
|
<param>
|
|
<type>mfem::Vector &</type>
|
|
<declname>reference_field</declname>
|
|
</param>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/lib/serif/backend/mfem/mapping/transformations.cpp" line="55" column="10" bodyfile="src/lib/serif/backend/mfem/mapping/transformations.cpp" bodystart="55" bodyend="60" declfile="src/include/serif/backend/mfem/mapping/transformations.hpp" declline="42" declcolumn="10"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="namespaceserif_1_1mapping_1abf5a228bc2d32e302fe73c7131cbc4d0" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<type>void</type>
|
|
<definition>void serif::mapping::map_hcurl_curl_to_physical</definition>
|
|
<argsstring>(const MappingPointContext &context, const mfem::Vector &reference_curl, mfem::Vector &physical_curl)</argsstring>
|
|
<name>map_hcurl_curl_to_physical</name>
|
|
<qualifiedname>serif::mapping::map_hcurl_curl_to_physical</qualifiedname>
|
|
<param>
|
|
<type>const <ref refid="structserif_1_1mapping_1_1_mapping_point_context" kindref="compound">MappingPointContext</ref> &</type>
|
|
<declname>context</declname>
|
|
</param>
|
|
<param>
|
|
<type>const mfem::Vector &</type>
|
|
<declname>reference_curl</declname>
|
|
</param>
|
|
<param>
|
|
<type>mfem::Vector &</type>
|
|
<declname>physical_curl</declname>
|
|
</param>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/lib/serif/backend/mfem/mapping/transformations.cpp" line="62" column="10" bodyfile="src/lib/serif/backend/mfem/mapping/transformations.cpp" bodystart="62" bodyend="68" declfile="src/include/serif/backend/mfem/mapping/transformations.hpp" declline="48" declcolumn="10"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="namespaceserif_1_1mapping_1aa97c5252d97464eaf482450f7cf52ebf" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<type>void</type>
|
|
<definition>void serif::mapping::map_physical_curl_to_hcurl_reference</definition>
|
|
<argsstring>(const MappingPointContext &context, const mfem::Vector &physical_curl, mfem::Vector &reference_curl)</argsstring>
|
|
<name>map_physical_curl_to_hcurl_reference</name>
|
|
<qualifiedname>serif::mapping::map_physical_curl_to_hcurl_reference</qualifiedname>
|
|
<param>
|
|
<type>const <ref refid="structserif_1_1mapping_1_1_mapping_point_context" kindref="compound">MappingPointContext</ref> &</type>
|
|
<declname>context</declname>
|
|
</param>
|
|
<param>
|
|
<type>const mfem::Vector &</type>
|
|
<declname>physical_curl</declname>
|
|
</param>
|
|
<param>
|
|
<type>mfem::Vector &</type>
|
|
<declname>reference_curl</declname>
|
|
</param>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/lib/serif/backend/mfem/mapping/transformations.cpp" line="70" column="10" bodyfile="src/lib/serif/backend/mfem/mapping/transformations.cpp" bodystart="70" bodyend="76" declfile="src/include/serif/backend/mfem/mapping/transformations.hpp" declline="54" declcolumn="10"/>
|
|
</memberdef>
|
|
</sectiondef>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<location file="src/include/serif/backend/mfem/geometry/deformation/geometry_step.hpp" line="18" column="1"/>
|
|
</compounddef>
|
|
</doxygen>
|