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)
49 lines
2.2 KiB
Groff
49 lines
2.2 KiB
Groff
.TH "src/include/serif/model/finite_elements.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/include/serif/model/finite_elements.hpp
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include 'serif/backend/mfem/model/finite_elements\&.hpp'\fP
|
|
.br
|
|
|
|
.SS "Namespaces"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "namespace \fBserif\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::model\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::geometry\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::geometry::deformation\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "template<typename Owner, utils::dependencies::IsDependencyContext Bindings> auto \fBserif::model::make_stellar_discretization\fP (std::shared_ptr< Owner > owner, Bindings bindings, const ::mfem::GridFunction &compactification, const \fBmapping::DomainMapper\fP &mapper)"
|
|
.br
|
|
.RI "Retain the supplied resource owner without copying finite-element spaces or changing their addresses\&. "
|
|
.ti -1c
|
|
.RI "template<typename Owner, typename Bindings, typename DomainModel> auto \fBserif::model::with_deformation\fP (StellarDiscretization< Owner, Bindings > discretization, DomainModel model, \fBgeometry::deformation::backend::mfem::ReferenceDiscretization\fP reference)"
|
|
.br
|
|
.RI "Add an explicit deformation prescription without changing the physical equation definition\&. "
|
|
.ti -1c
|
|
.RI "template<discretization::domain::schema::IsSchema Schema = discretization::domain::schema::CoreEnvelopeVacuumDomainSchema>
|
|
.br
|
|
requires (Schema::template contains_domain<\fBdiscretization::domain::StellarDomains\fP>() && Schema::template contains_domain<\fBdiscretization::domain::VacuumDomain\fP>() && Schema::template contains_boundary<\fBdiscretization::domain::StellarSurfaceBoundary\fP>() && Schema::template contains_boundary<\fBdiscretization::domain::InfinitySurfaceBoundary\fP>())ReferenceDiscretization \fBserif::geometry::deformation::deformation_discretization\fP (const ::mfem::FiniteElementSpace &scalar_space, const ::mfem::FiniteElementSpace &displacement_space, ::mfem::Mesh &logical_mesh)"
|
|
.br
|
|
.RI "Resolve physical domain names through the schema rather than hard-coded MFEM attributes\&. "
|
|
.in -1c
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|