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)
74 lines
2.7 KiB
Groff
74 lines
2.7 KiB
Groff
.TH "src/include/serif/model/computations/point_constraints.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/include/serif/model/computations/point_constraints.hpp
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include <limits>\fP
|
|
.br
|
|
\fR#include <memory>\fP
|
|
.br
|
|
\fR#include <tuple>\fP
|
|
.br
|
|
\fR#include <type_traits>\fP
|
|
.br
|
|
\fR#include <utility>\fP
|
|
.br
|
|
\fR#include <vector>\fP
|
|
.br
|
|
\fR#include 'serif/discretization/blocks/system_layout\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/model/computations/interior\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/operators/backend/mfem/linearized_block\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/operators/backend/mfem/nodal_computations\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/operators/backend/mfem/point_border\&.hpp'\fP
|
|
.br
|
|
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "struct \fBserif::model::computations::PointConstraintContribution< Scope >\fP"
|
|
.br
|
|
.RI "Identify an affine point constraint independently of its carrier equation\&. "
|
|
.in -1c
|
|
.SS "Namespaces"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "namespace \fBserif\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::model\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::model::computations\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "template<operators::backend::mfem::AffinePointEquation Equation, typename Discretization> auto \fBserif::model::computations::point_constraint_discretization\fP (const Equation &, const Discretization &discretization)"
|
|
.br
|
|
.RI "Select the declared physical point using the model's existing carrier and border bindings\&. "
|
|
.ti -1c
|
|
.RI "template<typename Scope, typename Equation, typename Schema, discretization::blocks::SystemLayoutType Layout> auto \fBserif::model::computations::point_constraint_contribution\fP (Layout layout)"
|
|
.br
|
|
.RI "Convert one accepted affine point border into physical residual and sparse off-diagonal blocks\&. "
|
|
.ti -1c
|
|
.RI "template<typename Scope = void, operators::backend::mfem::AffinePointEquation Equation, typename Schema, discretization::blocks::SystemLayoutType Layout>
|
|
.br
|
|
requires utils::dependencies::ContainsKey<typename Equation::Test, typename Layout::Values> && utils::dependencies::ContainsKey<typename Equation::Test, typename Layout::Residuals> && utils::dependencies::ContainsKey<typename Equation::Border, typename Layout::Values> && utils::dependencies::ContainsKey<typename Equation::Border, typename Layout::Residuals>auto \fBserif::model::computations::make_point_constraint_computations\fP (Equation equation, const \fBoperators::backend::mfem::PointBorderDiscretization\fP< Equation, Schema > &discretization, Layout layout)"
|
|
.br
|
|
.RI "Add the existing nodal stages and their contribution to the model's one dependency graph\&. "
|
|
.in -1c
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|