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
3.4 KiB
Groff
78 lines
3.4 KiB
Groff
.TH "serif::model::backend::mfem::BoundModel< Model, DescriptionT, Discretization, Boundary, PlanT >" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::model::backend::mfem::BoundModel< Model, DescriptionT, Discretization, Boundary, PlanT > \- Retain physical descriptions and all numerical bindings behind one stable owner\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <binding\&.hpp>\fP
|
|
.SS "Public Types"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "using \fBDescription\fP = DescriptionT"
|
|
.br
|
|
.ti -1c
|
|
.RI "using \fBPlan\fP = PlanT"
|
|
.br
|
|
.in -1c
|
|
.SS "Public Member Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "template<typename Row> auto \fBequation_discretization\fP () const"
|
|
.br
|
|
.RI "Forward an equation binding without copying finite-element resources\&. "
|
|
.in -1c
|
|
.SS "Public Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "std::shared_ptr< const Model > \fBmodel\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "\fBDescription\fP \fBdefinition\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "std::shared_ptr< const Discretization > \fBdiscretization\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "Boundary \fBboundary\fP"
|
|
.br
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
|
|
.SS "template<typename Model, typename DescriptionT, typename Discretization, typename Boundary, typename PlanT>
|
|
.br
|
|
struct serif::model::backend::mfem::BoundModel< Model, DescriptionT, Discretization, Boundary, PlanT >"Retain physical descriptions and all numerical bindings behind one stable owner\&.
|
|
.SH "Member Typedef Documentation"
|
|
.PP
|
|
.SS "template<typename Model, typename DescriptionT, typename Discretization, typename Boundary, typename PlanT> using \fBserif::model::backend::mfem::BoundModel\fP< Model, DescriptionT, Discretization, Boundary, PlanT >::Description = DescriptionT"
|
|
|
|
.SS "template<typename Model, typename DescriptionT, typename Discretization, typename Boundary, typename PlanT> using \fBserif::model::backend::mfem::BoundModel\fP< Model, DescriptionT, Discretization, Boundary, PlanT >::Plan = PlanT"
|
|
|
|
.SH "Member Function Documentation"
|
|
.PP
|
|
.SS "template<typename Model, typename DescriptionT, typename Discretization, typename Boundary, typename PlanT> template<typename Row> auto \fBserif::model::backend::mfem::BoundModel\fP< Model, DescriptionT, Discretization, Boundary, PlanT >::equation_discretization () const\fR [inline]\fP, \fR [nodiscard]\fP"
|
|
|
|
.PP
|
|
Forward an equation binding without copying finite-element resources\&.
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "template<typename Model, typename DescriptionT, typename Discretization, typename Boundary, typename PlanT> Boundary \fBserif::model::backend::mfem::BoundModel\fP< Model, DescriptionT, Discretization, Boundary, PlanT >::boundary"
|
|
|
|
.SS "template<typename Model, typename DescriptionT, typename Discretization, typename Boundary, typename PlanT> \fBDescription\fP \fBserif::model::backend::mfem::BoundModel\fP< Model, DescriptionT, Discretization, Boundary, PlanT >::definition"
|
|
|
|
.SS "template<typename Model, typename DescriptionT, typename Discretization, typename Boundary, typename PlanT> std::shared_ptr<const Discretization> \fBserif::model::backend::mfem::BoundModel\fP< Model, DescriptionT, Discretization, Boundary, PlanT >::discretization"
|
|
|
|
.SS "template<typename Model, typename DescriptionT, typename Discretization, typename Boundary, typename PlanT> std::shared_ptr<const Model> \fBserif::model::backend::mfem::BoundModel\fP< Model, DescriptionT, Discretization, Boundary, PlanT >::model"
|
|
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|