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)
78 lines
2.3 KiB
Groff
78 lines
2.3 KiB
Groff
.TH "src/include/serif/backend/mfem/model/system.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/include/serif/backend/mfem/model/system.hpp
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include <memory>\fP
|
|
.br
|
|
\fR#include <optional>\fP
|
|
.br
|
|
\fR#include <span>\fP
|
|
.br
|
|
\fR#include <vector>\fP
|
|
.br
|
|
\fR#include 'serif/backend/mfem/operators/actions\&.hpp'\fP
|
|
.br
|
|
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "struct \fBserif::model::backend::mfem::CoordinateRange\fP"
|
|
.br
|
|
.RI "One contiguous range of equation or state coordinates in an evaluated system\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::model::backend::mfem::ResidualContribution\fP"
|
|
.br
|
|
.RI "One evaluated equation contribution in the independently ordered residual coordinates\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::model::backend::mfem::JacobianContribution\fP"
|
|
.br
|
|
.RI "One frozen physical Jacobian coupling; overlapping contributions add\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::model::backend::mfem::ColumnContribution\fP"
|
|
.br
|
|
.RI "A coupling from state coordinates into an ordered selection of replacement rows\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::model::backend::mfem::RowReplacement\fP"
|
|
.br
|
|
.RI "Replace complete equations after all ordinary and generated contributions have been added\&. "
|
|
.ti -1c
|
|
.RI "class \fBserif::model::backend::mfem::PhysicalSystem\fP"
|
|
.br
|
|
.RI "Own one evaluated residual and Jacobian, retaining the discretization owner used by every child action\&. "
|
|
.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::backend\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::model::backend::mfem\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::model::backend::mfem::detail\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "std::shared_ptr< const \fBPhysicalSystem\fP > \fBserif::model::backend::mfem::make_physical_system\fP (int residual_size, int state_size, std::vector< \fBResidualContribution\fP > residuals, std::vector< \fBJacobianContribution\fP > jacobian, std::vector< \fBRowReplacement\fP > replacements={}, std::shared_ptr< const void > owner={}, std::optional< std::vector< \fBJacobianContribution\fP > > complete_actions={})"
|
|
.br
|
|
.RI "Publish an immutable evaluated system that remains independent of later graph preparation\&. "
|
|
.in -1c
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|