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

138 lines
5.4 KiB
Groff
Raw Normal View History

.TH "serif::discretization::backend::mfem::ReconstructionPlan" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::discretization::backend::mfem::ReconstructionPlan \- Immutable reconstruction selected on material-side surface elements and validated against their interfaces\&.
.SH SYNOPSIS
.br
.PP
.PP
\fR#include <reconstruction\&.hpp>\fP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBReconstructionPlan\fP (const \fBDofMap\fP &binding, int \fBboundary_attribute\fP, std::shared_ptr< const \fBreconstruction::RadialProfile\fP > \fBprofile\fP)"
.br
.RI "Bind a radial profile to one named boundary, rejecting incompatible element and constraint layouts\&. "
.ti -1c
.RI "void \fBvalidate_binding\fP (const \fBDofMap\fP &binding) const"
.br
.RI "Prevent attaching a resolved element selection to a different finite-element space\&. "
.ti -1c
.RI "const \fBElementReconstruction\fP * \fBelement\fP (int index) const"
.br
.RI "Return no adapter on ordinary interior elements\&. "
.ti -1c
.RI "const \fBreconstruction::RadialProfile\fP & \fBprofile\fP () const noexcept"
.br
.RI "Return the profile retained by accepted operators and state readers\&. "
.ti -1c
.RI "int \fBboundary_attribute\fP () const noexcept"
.br
.RI "Return the surface label needed to reproduce this plan on archive restoration\&. "
.ti -1c
.RI "int \fBintegration_order_increment\fP () const noexcept"
.br
.RI "Overintegrate fractional radial powers; verify convergence when choosing a new profile\&. "
.in -1c
.SS "Private Member Functions"
.in +1c
.ti -1c
.RI "void \fBvalidate_interfaces\fP (const \fBDofMap\fP &binding) const"
.br
.RI "Require existing constrained coefficients to represent continuous reconstructed traces\&. "
.in -1c
.SS "Private Attributes"
.in +1c
.ti -1c
.RI "const ::mfem::FiniteElementSpace * \fBm_space\fP"
.br
.ti -1c
.RI "long \fBm_space_sequence\fP"
.br
.ti -1c
.RI "long \fBm_mesh_sequence\fP"
.br
.ti -1c
.RI "std::vector< int > \fBm_domain_attributes\fP"
.br
.ti -1c
.RI "std::vector< int > \fBm_boundary_attributes\fP"
.br
.ti -1c
.RI "std::vector< int > \fBm_element_support\fP"
.br
.ti -1c
.RI "int \fBm_boundary_attribute\fP"
.br
.ti -1c
.RI "std::shared_ptr< const \fBreconstruction::RadialProfile\fP > \fBm_profile\fP"
.br
.ti -1c
.RI "std::vector< \fBElementReconstruction\fP > \fBm_elements\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
Immutable reconstruction selected on material-side surface elements and validated against their interfaces\&.
.SH "Constructor & Destructor Documentation"
.PP
.SS "serif::discretization::backend::mfem::ReconstructionPlan::ReconstructionPlan (const \fBDofMap\fP & binding, int boundary_attribute, std::shared_ptr< const \fBreconstruction::RadialProfile\fP > profile)"
.PP
Bind a radial profile to one named boundary, rejecting incompatible element and constraint layouts\&.
.SH "Member Function Documentation"
.PP
.SS "int serif::discretization::backend::mfem::ReconstructionPlan::boundary_attribute () const\fR [inline]\fP, \fR [nodiscard]\fP, \fR [noexcept]\fP"
.PP
Return the surface label needed to reproduce this plan on archive restoration\&.
.SS "const \fBElementReconstruction\fP * serif::discretization::backend::mfem::ReconstructionPlan::element (int index) const\fR [nodiscard]\fP"
.PP
Return no adapter on ordinary interior elements\&.
.SS "int serif::discretization::backend::mfem::ReconstructionPlan::integration_order_increment () const\fR [inline]\fP, \fR [nodiscard]\fP, \fR [noexcept]\fP"
.PP
Overintegrate fractional radial powers; verify convergence when choosing a new profile\&.
.SS "const \fBreconstruction::RadialProfile\fP & serif::discretization::backend::mfem::ReconstructionPlan::profile () const\fR [inline]\fP, \fR [nodiscard]\fP, \fR [noexcept]\fP"
.PP
Return the profile retained by accepted operators and state readers\&.
.SS "void serif::discretization::backend::mfem::ReconstructionPlan::validate_binding (const \fBDofMap\fP & binding) const"
.PP
Prevent attaching a resolved element selection to a different finite-element space\&.
.SS "void serif::discretization::backend::mfem::ReconstructionPlan::validate_interfaces (const \fBDofMap\fP & binding) const\fR [private]\fP"
.PP
Require existing constrained coefficients to represent continuous reconstructed traces\&.
.SH "Member Data Documentation"
.PP
.SS "int serif::discretization::backend::mfem::ReconstructionPlan::m_boundary_attribute\fR [private]\fP"
.SS "std::vector<int> serif::discretization::backend::mfem::ReconstructionPlan::m_boundary_attributes\fR [private]\fP"
.SS "std::vector<int> serif::discretization::backend::mfem::ReconstructionPlan::m_domain_attributes\fR [private]\fP"
.SS "std::vector<int> serif::discretization::backend::mfem::ReconstructionPlan::m_element_support\fR [private]\fP"
.SS "std::vector<\fBElementReconstruction\fP> serif::discretization::backend::mfem::ReconstructionPlan::m_elements\fR [private]\fP"
.SS "long serif::discretization::backend::mfem::ReconstructionPlan::m_mesh_sequence\fR [private]\fP"
.SS "std::shared_ptr<const \fBreconstruction::RadialProfile\fP> serif::discretization::backend::mfem::ReconstructionPlan::m_profile\fR [private]\fP"
.SS "const ::mfem::FiniteElementSpace* serif::discretization::backend::mfem::ReconstructionPlan::m_space\fR [private]\fP"
.SS "long serif::discretization::backend::mfem::ReconstructionPlan::m_space_sequence\fR [private]\fP"
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.