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)
77 lines
3.2 KiB
Groff
77 lines
3.2 KiB
Groff
.TH "src/include/serif/backend/mfem/geometry/surface/boundary_inputs.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/include/serif/backend/mfem/geometry/surface/boundary_inputs.hpp
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include 'serif/backend/mfem/discretization/coefficient_tracking\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/backend/mfem/geometry/surface/boundary_data\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/geometry/surface/samples\&.hpp'\fP
|
|
.br
|
|
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "struct \fBserif::geometry::surface::backend::mfem::keys::BoundaryDiscretization\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::geometry::surface::backend::mfem::keys::BoundarySamples< Term >\fP"
|
|
.br
|
|
.RI "Keep sampled boundary state distinct from volume coefficient sources for the same term\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::geometry::surface::backend::mfem::detail::BoundaryTracking\fP"
|
|
.br
|
|
.RI "Shared traces have stable identity; validation catches changes outside the coefficient vectors\&. "
|
|
.in -1c
|
|
.SS "Namespaces"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "namespace \fBserif\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::geometry\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::geometry::surface\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::geometry::surface::backend\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::geometry::surface::backend::mfem\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::geometry::surface::backend::mfem::keys\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::geometry::surface::backend::mfem::detail\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "template<typename Boundary, typename EOSResource> auto \fBserif::geometry::surface::backend::mfem::make_pressure_boundary_metadata\fP (std::shared_ptr< const Boundary > boundary, EOSResource equation_of_state, \fBIsobaricSurface\fP condition)"
|
|
.br
|
|
.RI "Share boundary metadata with a model's common coefficient context\&. "
|
|
.ti -1c
|
|
.RI "template<typename Boundary, typename EOSResource, typename Coefficients, typename\&.\&.\&. Terms> auto \fBserif::geometry::surface::backend::mfem::detail::pressure_boundary_inputs\fP (std::shared_ptr< const Boundary > boundary, EOSResource equation_of_state, \fBIsobaricSurface\fP condition, const Coefficients &coefficients, \fButils::dependencies::KeyList\fP< Terms\&.\&.\&. >)"
|
|
.br
|
|
.RI "Preserve standard coefficient keys and policies in a standalone boundary context\&. "
|
|
.ti -1c
|
|
.RI "template<typename Boundary, utils::dependencies::IsResource EOSResource, utils::dependencies::IsDependencyContext Coefficients>
|
|
.br
|
|
requires std::same_as<typename EOSResource::Key, \fBsurface::keys::EquationOfState\fP> && std::same_as<std::remove_cvref_t<typename EOSResource::Target>, typename Boundary::Formulation::EquationOfState> && utils::dependencies::SatisfiesKeyList<typename Coefficients::Bindings, typename Boundary::Formulation::StateTerms>auto \fBserif::geometry::surface::backend::mfem::make_pressure_boundary_inputs\fP (std::shared_ptr< const Boundary > boundary, EOSResource equation_of_state, \fBIsobaricSurface\fP condition, const Coefficients &coefficients)"
|
|
.br
|
|
.RI "Bind the physical condition, explicitly tracked EOS, and borrowed field coefficients without evaluating them\&. "
|
|
.in -1c
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|