Files
MeanField_SERiF/docs/man/man3/serif_model_backend_mfem_StellarDiscretization.3

84 lines
3.7 KiB
Groff
Raw Normal View History

.TH "serif::model::backend::mfem::StellarDiscretization< Owner, Bindings, Deformation >" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::model::backend::mfem::StellarDiscretization< Owner, Bindings, Deformation > \- Bind physical terms to existing finite-element resources with one explicit lifetime owner\&.
.SH SYNOPSIS
.br
.PP
.PP
\fR#include <discretization\&.hpp>\fP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "template<typename Term> const auto & \fBbinding\fP () const"
.br
.RI "Retrieve a physical term's existing typed finite-element binding\&. "
.ti -1c
.RI "template<typename Row> auto \fBequation_discretization\fP () const"
.br
.RI "Describe one equation's discretization using the common physical resources\&. "
.in -1c
.SS "Public Attributes"
.in +1c
.ti -1c
.RI "std::shared_ptr< const Owner > \fBowner\fP"
.br
.ti -1c
.RI "Bindings \fBterm_bindings\fP"
.br
.ti -1c
.RI "const ::mfem::GridFunction & \fBcompactification\fP"
.br
.ti -1c
.RI "const \fBmapping::DomainMapper\fP & \fBmapper\fP"
.br
.ti -1c
.RI "Deformation \fBdeformation\fP {}"
.br
.in -1c
.SH "Detailed Description"
.PP
.SS "template<typename Owner, utils::dependencies::IsDependencyContext Bindings, typename Deformation = NoDeformation>
.br
struct serif::model::backend::mfem::StellarDiscretization< Owner, Bindings, Deformation >"Bind physical terms to existing finite-element resources with one explicit lifetime owner\&.
.PP
\fBNote\fP
.RS 4
This is a numerical binding, not a stellar-model description\&. The owner must own every referenced mesh, space, binding, mapper and compactification field\&. No equation is evaluated here\&.
.RE
.PP
.SH "Member Function Documentation"
.PP
.SS "template<typename Owner, utils::dependencies::IsDependencyContext Bindings, typename Deformation = NoDeformation> template<typename Term> const auto & \fBserif::model::backend::mfem::StellarDiscretization\fP< Owner, Bindings, Deformation >::binding () const\fR [inline]\fP, \fR [nodiscard]\fP"
.PP
Retrieve a physical term's existing typed finite-element binding\&.
.SS "template<typename Owner, utils::dependencies::IsDependencyContext Bindings, typename Deformation = NoDeformation> template<typename Row> auto \fBserif::model::backend::mfem::StellarDiscretization\fP< Owner, Bindings, Deformation >::equation_discretization () const\fR [inline]\fP, \fR [nodiscard]\fP"
.PP
Describe one equation's discretization using the common physical resources\&.
.SH "Member Data Documentation"
.PP
.SS "template<typename Owner, utils::dependencies::IsDependencyContext Bindings, typename Deformation = NoDeformation> const ::mfem::GridFunction& \fBserif::model::backend::mfem::StellarDiscretization\fP< Owner, Bindings, Deformation >::compactification"
.SS "template<typename Owner, utils::dependencies::IsDependencyContext Bindings, typename Deformation = NoDeformation> Deformation \fBserif::model::backend::mfem::StellarDiscretization\fP< Owner, Bindings, Deformation >::deformation {}"
.SS "template<typename Owner, utils::dependencies::IsDependencyContext Bindings, typename Deformation = NoDeformation> const \fBmapping::DomainMapper\fP& \fBserif::model::backend::mfem::StellarDiscretization\fP< Owner, Bindings, Deformation >::mapper"
.SS "template<typename Owner, utils::dependencies::IsDependencyContext Bindings, typename Deformation = NoDeformation> std::shared_ptr<const Owner> \fBserif::model::backend::mfem::StellarDiscretization\fP< Owner, Bindings, Deformation >::owner"
.SS "template<typename Owner, utils::dependencies::IsDependencyContext Bindings, typename Deformation = NoDeformation> Bindings \fBserif::model::backend::mfem::StellarDiscretization\fP< Owner, Bindings, Deformation >::term_bindings"
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.