Files
MeanField_SERiF/docs/man/man3/geometry_derivatives.hpp.3
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

61 lines
2.1 KiB
Groff

.TH "src/include/serif/backend/mfem/operators/geometry_derivatives.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include/serif/backend/mfem/operators/geometry_derivatives.hpp
.SH SYNOPSIS
.br
.PP
\fR#include <array>\fP
.br
\fR#include <cmath>\fP
.br
\fR#include <expected>\fP
.br
\fR#include 'serif/backend/mfem/operators/element_data\&.hpp'\fP
.br
\fR#include 'serif/backend/mfem/operators/operand_evaluation\&.hpp'\fP
.br
\fR#include 'serif/backend/mfem/operators/rejection\&.hpp'\fP
.br
\fR#include 'serif/backend/mfem/operators/workspace\&.hpp'\fP
.br
\fR#include 'serif/operators/plan\&.hpp'\fP
.br
\fR#include 'serif/backend/mfem/mapping/domain_mapper\&.hpp'\fP
.br
\fR#include 'serif/backend/mfem/shared/parallel\&.hpp'\fP
.br
.SS "Namespaces"
.in +1c
.ti -1c
.RI "namespace \fBserif\fP"
.br
.ti -1c
.RI "namespace \fBserif::operators\fP"
.br
.ti -1c
.RI "namespace \fBserif::operators::backend\fP"
.br
.ti -1c
.RI "namespace \fBserif::operators::backend::mfem\fP"
.br
.in -1c
.SS "Functions"
.in +1c
.ti -1c
.RI "template<VolumeEquation Equation, typename Contribution> auto \fBserif::operators::backend::mfem::geometry_integrand_variation\fP (const \fBElementData\fP< \fBEquationPlan\fP< Equation >::operand_count > &data, int point, const \fBmapping::VolumeMappingContext\fP &context, const \fBmapping::VolumeMappingVariation\fP &variation)"
.br
.RI "Differentiate the weighted physics through position, operand mappings and the volume measure\&. "
.ti -1c
.RI "template<VolumeEquation Equation, typename Contribution> std::expected<::mfem::DenseMatrix, \fBPreparationRejection\fP > \fBserif::operators::backend::mfem::element_geometry_derivatives\fP (const \fBElementData\fP< \fBEquationPlan\fP< Equation >::operand_count > &data, const \fBdiscretization::backend::mfem::DofMap\fP &displacement_binding, const ::mfem::FiniteElementSpace &compactification_space, const \fBmapping::DomainMapper\fP &mapper, \fBWorkspace\fP &workspace)"
.br
.RI "Differentiate one weighted integrand with respect to local displacement values and gradients\&. "
.in -1c
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.