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)
64 lines
1.7 KiB
Groff
64 lines
1.7 KiB
Groff
.TH "src/include/serif/backend/mfem/model/equilibrium_evaluator.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/include/serif/backend/mfem/model/equilibrium_evaluator.hpp
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include <expected>\fP
|
|
.br
|
|
\fR#include <span>\fP
|
|
.br
|
|
\fR#include 'serif/backend/mfem/model/binding\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/backend/mfem/model/failure\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/backend/mfem/model/state\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/backend/mfem/model/preconditioning/computations\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/backend/mfem/shared/finite\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/utils/dependencies/computation_cache\&.hpp'\fP
|
|
.br
|
|
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "class \fBserif::model::backend::mfem::EquilibriumEvaluator< Bound, Graph, Inputs, AdditionalInputs, ResultKey, EvaluationServices, LinearServices, Observers >\fP"
|
|
.br
|
|
.RI "Evaluate explicit stellar candidates using one reusable dependency cache\&. "
|
|
.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 "template<typename Bound, typename Coefficients, typename Geometry> auto \fBserif::model::backend::mfem::detail::candidate_inputs\fP (const Bound &bound, const Coefficients &coefficients, const Geometry &geometry)"
|
|
.br
|
|
.RI "Use one shape-view input schema for both packed states and external coefficient containers\&. "
|
|
.in -1c
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|