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)
51 lines
2.3 KiB
Groff
51 lines
2.3 KiB
Groff
.TH "src/include/serif/operators/backend/mfem/point_border.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/include/serif/operators/backend/mfem/point_border.hpp
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include 'serif/operators/backend/mfem/nodal_rows\&.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<AffinePointEquation EquationT, discretization::domain::schema::IsSchema SchemaT> void \fBserif::operators::backend::mfem::validate_point_border_outputs\fP (const \fBPointBorderData\fP< EquationT, SchemaT > &data, const \fB::mfem::Vector\fP &carrier, const \fB::mfem::Vector\fP &phase)"
|
|
.br
|
|
.RI "Point borders accept one carrier vector and one global scalar output\&. "
|
|
.ti -1c
|
|
.RI "template<AffinePointEquation EquationT, discretization::domain::schema::IsSchema SchemaT> void \fBserif::operators::backend::mfem::add_point_border_residual\fP (const \fBPointBorderData\fP< EquationT, SchemaT > &data, \fB::mfem::Vector\fP &carrier, \fB::mfem::Vector\fP &phase)"
|
|
.br
|
|
.RI "Add the accepted border force to the carrier and set the scalar phase residual\&. "
|
|
.ti -1c
|
|
.RI "template<AffinePointEquation EquationT, discretization::domain::schema::IsSchema SchemaT, typename CoefficientsT> void \fBserif::operators::backend::mfem::apply_point_border_jacobian\fP (const \fBPointBorderData\fP< EquationT, SchemaT > &data, const CoefficientsT &direction, \fB::mfem::Vector\fP &carrier, \fB::mfem::Vector\fP &phase)"
|
|
.br
|
|
.RI "Apply the two off-diagonal Jacobian blocks of an affine scalar point border\&. "
|
|
.ti -1c
|
|
.RI "template<AffinePointEquation EquationT, discretization::domain::schema::IsSchema SchemaT> void \fBserif::operators::backend::mfem::apply_point_border_jacobian_transpose\fP (const \fBPointBorderData\fP< EquationT, SchemaT > &data, const \fB::mfem::Vector\fP &carrier_dual, const \fB::mfem::Vector\fP &phase_dual, \fB::mfem::Vector\fP &carrier_result, \fB::mfem::Vector\fP &border_result)"
|
|
.br
|
|
.RI "Add the coordinate transpose of both border blocks to their coefficient duals\&. "
|
|
.in -1c
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|