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)
65 lines
3.0 KiB
Groff
65 lines
3.0 KiB
Groff
.TH "src/include/serif/operators/backend/mfem/nodal_rows.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/include/serif/operators/backend/mfem/nodal_rows.hpp
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include <array>\fP
|
|
.br
|
|
\fR#include <cmath>\fP
|
|
.br
|
|
\fR#include 'serif/operators/backend/mfem/nodal_data\&.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<NodalValueEquation EquationT, discretization::domain::schema::IsSchema SchemaT> void \fBserif::operators::backend::mfem::validate_nodal_output\fP (const \fBNodalData\fP< EquationT, SchemaT > &data, const \fB::mfem::Vector\fP &result)"
|
|
.br
|
|
.RI "A frozen linearization still requires a current selection and a correctly sized output\&. "
|
|
.ti -1c
|
|
.RI "template<NodalValueEquation EquationT, discretization::domain::schema::IsSchema SchemaT> void \fBserif::operators::backend::mfem::apply_residual_rows\fP (const \fBNodalData\fP< EquationT, SchemaT > &data, \fB::mfem::Vector\fP &result)"
|
|
.br
|
|
.RI "Replace only selected entries of an assembled residual with the accepted nodal residual\&. "
|
|
.ti -1c
|
|
.RI "template<NodalValueEquation EquationT, discretization::domain::schema::IsSchema SchemaT> void \fBserif::operators::backend::mfem::apply_jacobian_rows\fP (const \fBNodalData\fP< EquationT, SchemaT > &data, const \fB::mfem::Vector\fP &direction, \fB::mfem::Vector\fP &result)"
|
|
.br
|
|
.RI "Replace complete Jacobian rows, including every unconstrained coupling at the selected rows\&. "
|
|
.ti -1c
|
|
.RI "template<NodalValueEquation EquationT, discretization::domain::schema::IsSchema SchemaT, typename CoefficientsT>
|
|
.br
|
|
requires requires(const CoefficientsT& direction) { direction\&.template get<typename EquationT::Test>(); }void \fBserif::operators::backend::mfem::apply_jacobian_rows\fP (const \fBNodalData\fP< EquationT, SchemaT > &data, const CoefficientsT &direction, \fB::mfem::Vector\fP &result)"
|
|
.br
|
|
.RI "Select the nodal direction by its physical term and verify its coefficient ordering\&. "
|
|
.ti -1c
|
|
.RI "template<NodalValueEquation EquationT, discretization::domain::schema::IsSchema SchemaT> void \fBserif::operators::backend::mfem::mask_residual_dual\fP (const \fBNodalData\fP< EquationT, SchemaT > &data, const \fB::mfem::Vector\fP &dual, \fB::mfem::Vector\fP &volume_dual)"
|
|
.br
|
|
.RI "Remove constrained rows before applying the volume Jacobian transpose\&. "
|
|
.ti -1c
|
|
.RI "template<NodalValueEquation EquationT, discretization::domain::schema::IsSchema SchemaT> void \fBserif::operators::backend::mfem::add_jacobian_transpose_rows\fP (const \fBNodalData\fP< EquationT, SchemaT > &data, const \fB::mfem::Vector\fP &dual, \fB::mfem::Vector\fP &result)"
|
|
.br
|
|
.RI "Add the constrained-row transpose after applying the volume transpose to the masked dual\&. "
|
|
.in -1c
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|