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)
65 lines
2.6 KiB
Groff
65 lines
2.6 KiB
Groff
.TH "serif::solver::backend::mfem" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::solver::backend::mfem
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.SS "Namespaces"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "namespace \fBdetail\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "class \fBStellarProblem\fP"
|
|
.br
|
|
.RI "Adapt existing stellar preparation to \fBNewton\fP without giving acceptance to the model\&. "
|
|
.in -1c
|
|
.SS "Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "template<typename Binding> auto \fBbinding_identity\fP (const Binding &binding)"
|
|
.br
|
|
.RI "Capture the physical interpretation of a reduced coefficient block, not merely its size\&. "
|
|
.ti -1c
|
|
.RI "template<typename FiniteElements> auto \fBbinding_identities\fP (const FiniteElements &finite_elements)"
|
|
.br
|
|
.RI "Inspect every registered binding, including prescribed fields outside the state vector\&. "
|
|
.ti -1c
|
|
.RI "template<typename FiniteElements> auto \fBphysical_transfer_guard\fP (const FiniteElements &finite_elements)"
|
|
.br
|
|
.RI "Retain the original physical resources and reject reinterpretation between continuation stages\&. "
|
|
.ti -1c
|
|
.RI "auto \fBmake_observed_stellar_problem\fP (auto configuration, const auto &state, const auto &strategies, \fBoperators::backend::mfem::VolumeOptions\fP volume_options, auto prescribed, auto observer_factory, const auto &\&.\&.\&. geometry)"
|
|
.br
|
|
.RI "Construct one evaluator/cache and bind fixed or moving geometry for an equilibrium solve\&. "
|
|
.in -1c
|
|
.SH "Function Documentation"
|
|
.PP
|
|
.SS "template<typename FiniteElements> auto serif::solver::backend::mfem::binding_identities (const FiniteElements & finite_elements)\fR [nodiscard]\fP"
|
|
|
|
.PP
|
|
Inspect every registered binding, including prescribed fields outside the state vector\&.
|
|
.SS "template<typename Binding> auto serif::solver::backend::mfem::binding_identity (const Binding & binding)\fR [nodiscard]\fP"
|
|
|
|
.PP
|
|
Capture the physical interpretation of a reduced coefficient block, not merely its size\&.
|
|
.SS "auto serif::solver::backend::mfem::make_observed_stellar_problem (auto configuration, const auto & state, const auto & strategies, \fBoperators::backend::mfem::VolumeOptions\fP volume_options, auto prescribed, auto observer_factory, const auto &\&.\&.\&. geometry)\fR [nodiscard]\fP"
|
|
|
|
.PP
|
|
Construct one evaluator/cache and bind fixed or moving geometry for an equilibrium solve\&.
|
|
.SS "template<typename FiniteElements> auto serif::solver::backend::mfem::physical_transfer_guard (const FiniteElements & finite_elements)\fR [nodiscard]\fP"
|
|
|
|
.PP
|
|
Retain the original physical resources and reject reinterpretation between continuation stages\&.
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|