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)
76 lines
2.4 KiB
Groff
76 lines
2.4 KiB
Groff
.TH "src/include/serif/backend/mfem/model/computations/interior.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/include/serif/backend/mfem/model/computations/interior.hpp
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include <memory>\fP
|
|
.br
|
|
\fR#include <optional>\fP
|
|
.br
|
|
\fR#include <tuple>\fP
|
|
.br
|
|
\fR#include <utility>\fP
|
|
.br
|
|
\fR#include 'serif/backend/mfem/model/system\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/backend/mfem/model/volume_actions\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/backend/mfem/model/volume\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/backend/mfem/model/computations/shape_derivatives\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/backend/mfem/model/computations/scalar_row\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/backend/mfem/operators/volume_computations\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/backend/mfem/operators/volume_field_block\&.hpp'\fP
|
|
.br
|
|
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "struct \fBserif::model::computations::InteriorContribution< Row >\fP"
|
|
.br
|
|
.RI "One equation's accepted contribution to the complete physical system\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::model::computations::Contributions\fP"
|
|
.br
|
|
.RI "Ordinary equations, point constraints and row replacements share one small assembly result\&. "
|
|
.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<typename Equation, typename Schema, typename Layout> \fBContributions\fP \fBserif::model::computations::volume_contribution\fP (std::shared_ptr< const \fBoperators::backend::mfem::VolumeData\fP< Equation, Schema > > accepted, const Layout &layout, std::optional< \fBbackend::mfem::ColumnContribution\fP > geometry={})"
|
|
.br
|
|
.RI "Assemble field and optional geometry columns from the same retained volume result\&. "
|
|
.ti -1c
|
|
.RI "template<typename Equation, typename Layout> auto \fBserif::model::computations::interior_contribution\fP (Layout layout)"
|
|
.br
|
|
.RI "Declare one owning contribution per equation; shape coordinates add one explicit shared prerequisite\&. "
|
|
.ti -1c
|
|
.RI "template<typename Equation, typename Layout> auto \fBserif::model::computations::interior_computations\fP (const Layout &layout)"
|
|
.br
|
|
.RI "Scalar equations publish a reusable functional before joining ordinary system assembly\&. "
|
|
.in -1c
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|