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)
95 lines
4.2 KiB
Groff
95 lines
4.2 KiB
Groff
.TH "serif::model::backend::mfem::PhysicalSystem" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::model::backend::mfem::PhysicalSystem \- Own one evaluated residual and Jacobian, retaining the discretization owner used by every child action\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <system\&.hpp>\fP
|
|
.SS "Public Member Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "\fBPhysicalSystem\fP (int residual_size, int state_size, std::vector< \fBResidualContribution\fP > residuals, std::vector< \fBJacobianContribution\fP > \fBjacobian\fP, std::vector< \fBRowReplacement\fP > replacements={}, std::shared_ptr< const void > owner={}, std::optional< std::vector< \fBJacobianContribution\fP > > complete_actions={})"
|
|
.br
|
|
.RI "Validate coordinate bounds and row ownership without assuming a square system\&. "
|
|
.ti -1c
|
|
.RI "const std::vector< double > & \fBresidual\fP () const noexcept"
|
|
.br
|
|
.RI "Read the frozen physical residual in the declared residual order\&. "
|
|
.ti -1c
|
|
.RI "const \fBLinearizedBlock\fP & \fBjacobian\fP () const noexcept"
|
|
.br
|
|
.RI "Access both directions of this frozen physical Jacobian\&. "
|
|
.ti -1c
|
|
.RI "\fBLinearizedBlock\fP \fBblock\fP (int row_offset, int row_size, int column_offset, int column_size) const"
|
|
.br
|
|
.RI "Select a physical coupling without applying unrelated equations; the result retains this snapshot and its owner\&. "
|
|
.ti -1c
|
|
.RI "\fBLinearizedBlock\fP \fBblock\fP (std::span< const \fBCoordinateRange\fP > rows, std::span< const \fBCoordinateRange\fP > columns) const"
|
|
.br
|
|
.RI "Concatenate selected equation and state ranges in their supplied order, retaining this evaluated system\&. "
|
|
.in -1c
|
|
.SS "Private Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "std::shared_ptr< const \fBdetail::SystemData\fP > \fBm_data\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "std::vector< double > \fBm_residual\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "\fBLinearizedBlock\fP \fBm_jacobian\fP"
|
|
.br
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
Own one evaluated residual and Jacobian, retaining the discretization owner used by every child action\&.
|
|
.SH "Constructor & Destructor Documentation"
|
|
.PP
|
|
.SS "serif::model::backend::mfem::PhysicalSystem::PhysicalSystem (int residual_size, int state_size, std::vector< \fBResidualContribution\fP > residuals, std::vector< \fBJacobianContribution\fP > jacobian, std::vector< \fBRowReplacement\fP > replacements = \fR{}\fP, std::shared_ptr< const void > owner = \fR{}\fP, std::optional< std::vector< \fBJacobianContribution\fP > > complete_actions = \fR{}\fP)"
|
|
|
|
.PP
|
|
Validate coordinate bounds and row ownership without assuming a square system\&.
|
|
.PP
|
|
\fBNote\fP
|
|
.RS 4
|
|
Optional complete actions must represent the same ordinary Jacobian as the blocks\&. They accelerate whole-system products; block selection and assembly keep using the physical blocks\&.
|
|
.RE
|
|
.PP
|
|
|
|
.SH "Member Function Documentation"
|
|
.PP
|
|
.SS "\fBLinearizedBlock\fP serif::model::backend::mfem::PhysicalSystem::block (int row_offset, int row_size, int column_offset, int column_size) const\fR [nodiscard]\fP"
|
|
|
|
.PP
|
|
Select a physical coupling without applying unrelated equations; the result retains this snapshot and its owner\&.
|
|
.SS "\fBLinearizedBlock\fP serif::model::backend::mfem::PhysicalSystem::block (std::span< const \fBCoordinateRange\fP > rows, std::span< const \fBCoordinateRange\fP > columns) const\fR [nodiscard]\fP"
|
|
|
|
.PP
|
|
Concatenate selected equation and state ranges in their supplied order, retaining this evaluated system\&.
|
|
.SS "const \fBLinearizedBlock\fP & serif::model::backend::mfem::PhysicalSystem::jacobian () const\fR [nodiscard]\fP, \fR [noexcept]\fP"
|
|
|
|
.PP
|
|
Access both directions of this frozen physical Jacobian\&.
|
|
.SS "const std::vector< double > & serif::model::backend::mfem::PhysicalSystem::residual () const\fR [nodiscard]\fP, \fR [noexcept]\fP"
|
|
|
|
.PP
|
|
Read the frozen physical residual in the declared residual order\&.
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "std::shared_ptr<const \fBdetail::SystemData\fP> serif::model::backend::mfem::PhysicalSystem::m_data\fR [private]\fP"
|
|
|
|
.SS "\fBLinearizedBlock\fP serif::model::backend::mfem::PhysicalSystem::m_jacobian\fR [private]\fP"
|
|
|
|
.SS "std::vector<double> serif::model::backend::mfem::PhysicalSystem::m_residual\fR [private]\fP"
|
|
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|