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)
87 lines
4.3 KiB
Groff
87 lines
4.3 KiB
Groff
.TH "src/include/serif/backend/mfem/geometry/surface/boundary_rows.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/include/serif/backend/mfem/geometry/surface/boundary_rows.hpp
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include 'serif/utils/error/nonfinite\&.hpp'\fP
|
|
.br
|
|
\fR#include <cmath>\fP
|
|
.br
|
|
\fR#include <vector>\fP
|
|
.br
|
|
\fR#include 'serif/backend/mfem/geometry/surface/boundary_data\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/geometry/surface/linearization\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/backend/mfem/shared/finite\&.hpp'\fP
|
|
.br
|
|
|
|
.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::detail\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "template<typename Boundary> void \fBserif::geometry::surface::backend::mfem::detail::validate_boundary_output\fP (const Boundary &boundary, const ::mfem::Vector &result)"
|
|
.br
|
|
.RI "Check that an action uses the current discretization and the complete residual space\&. "
|
|
.ti -1c
|
|
.RI "template<typename Boundary, typename Linearizations> void \fBserif::geometry::surface::backend::mfem::detail::validate_boundary_samples\fP (const Boundary &boundary, const Linearizations &linearizations)"
|
|
.br
|
|
.RI "The accepted graph result contains one local equation for each ordered boundary node\&. "
|
|
.ti -1c
|
|
.RI "template<typename Boundary> void \fBserif::geometry::surface::backend::mfem::detail::replace_boundary_rows\fP (const Boundary &boundary, const ::mfem::Vector &values, ::mfem::Vector &result)"
|
|
.br
|
|
.RI "Publish a complete finite action only after all input directions have been read\&. "
|
|
.ti -1c
|
|
.RI "template<typename Boundary, typename Linearizations, typename Directions, typename\&.\&.\&. Terms> ::mfem::Vector \fBserif::geometry::surface::backend::mfem::detail::boundary_jacobian_action\fP (const Boundary &boundary, const Linearizations &linearizations, const Directions &directions, \fButils::dependencies::KeyList\fP< Terms\&.\&.\&. >)"
|
|
.br
|
|
.RI "Accumulate all physical couplings using the same traces that supplied the EOS state\&. "
|
|
.ti -1c
|
|
.RI "template<PressureBoundaryFormulation Formulation, typename Traces> void \fBserif::geometry::surface::backend::mfem::apply_residual_rows\fP (const \fBPressureBoundary\fP< Formulation, Traces > &boundary, const std::vector< \fBSurfaceLinearization\fP< Formulation > > &linearizations, ::mfem::Vector &result)"
|
|
.br
|
|
.RI "Replace selected residual rows with a prepared isobaric equation, preserving all interior rows\&. "
|
|
.ti -1c
|
|
.RI "template<PressureBoundaryFormulation Formulation, typename Traces, utils::dependencies::IsDependencyContext Directions>
|
|
.br
|
|
requires utils::dependencies::SatisfiesKeyList<typename Directions::Bindings, typename Formulation::StateTerms>void \fBserif::geometry::surface::backend::mfem::apply_jacobian_rows\fP (const \fBPressureBoundary\fP< Formulation, Traces > &boundary, const std::vector< \fBSurfaceLinearization\fP< Formulation > > &linearizations, const Directions &directions, ::mfem::Vector &result)"
|
|
.br
|
|
.RI "Replace full Jacobian rows, including every EOS input; directions may alias the output\&. "
|
|
.ti -1c
|
|
.RI "template<PressureBoundaryFormulation Formulation, typename Traces> void \fBserif::geometry::surface::backend::mfem::mask_residual_dual\fP (const \fBPressureBoundary\fP< Formulation, Traces > &boundary, const ::mfem::Vector &dual, ::mfem::Vector &volume_dual)"
|
|
.br
|
|
.RI "Remove the replaced rows before applying the volume Jacobian transpose\&. "
|
|
.ti -1c
|
|
.RI "template<typename Term, PressureBoundaryFormulation Formulation, typename Traces>
|
|
.br
|
|
requires utils::dependencies::BindingsWithBinding<typename Traces::Bindings, Term>void \fBserif::geometry::surface::backend::mfem::add_jacobian_transpose_rows\fP (const \fBPressureBoundary\fP< Formulation, Traces > &boundary, const std::vector< \fBSurfaceLinearization\fP< Formulation > > &linearizations, const ::mfem::Vector &dual, ::mfem::Vector &result)"
|
|
.br
|
|
.RI "Add one physical term's constrained-row transpose to its existing volume contribution\&. "
|
|
.in -1c
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|