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)
158 lines
7.8 KiB
Groff
158 lines
7.8 KiB
Groff
.TH "serif::model::computations" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::model::computations
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.SS "Namespaces"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "namespace \fBdetail\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "struct \fBContributions\fP"
|
|
.br
|
|
.RI "Ordinary equations, point constraints and row replacements share one small assembly result\&. "
|
|
.ti -1c
|
|
.RI "struct \fBInteriorContribution\fP"
|
|
.br
|
|
.RI "One equation's accepted contribution to the complete physical system\&. "
|
|
.ti -1c
|
|
.RI "struct \fBPotentialInfinityContribution\fP"
|
|
.br
|
|
.RI "The zero potential trace at compactified infinity, independent of the stellar isobar\&. "
|
|
.ti -1c
|
|
.RI "struct \fBPressureBoundaryContribution\fP"
|
|
.br
|
|
.RI "The complete isobaric replacement applied after ordinary and generated equation contributions\&. "
|
|
.ti -1c
|
|
.RI "struct \fBScalarResidualRow\fP"
|
|
.br
|
|
.RI "One global scalar equation's accepted derivative in complete physical state coordinates\&. "
|
|
.ti -1c
|
|
.RI "struct \fBShapeContribution\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBShapeDerivatives\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "template<typename Equation, typename Schema, typename Layout> \fBContributions\fP \fBvolume_contribution\fP (std::shared_ptr< const \fBoperators::backend::mfem::VolumeData\fP< Equation, Schema > > accepted, const Layout &layout, std::optional< \fBbackend::mfem::ColumnContribution\fP > geometry={})"
|
|
.br
|
|
.RI "Assemble field and optional geometry columns from the same retained volume result\&. "
|
|
.ti -1c
|
|
.RI "template<typename Equation, typename Layout> auto \fBinterior_contribution\fP (Layout layout)"
|
|
.br
|
|
.RI "Declare one owning contribution per equation; shape coordinates add one explicit shared prerequisite\&. "
|
|
.ti -1c
|
|
.RI "template<typename Equation, typename Layout> auto \fBinterior_computations\fP (const Layout &layout)"
|
|
.br
|
|
.RI "Scalar equations publish a reusable functional before joining ordinary system assembly\&. "
|
|
.ti -1c
|
|
.RI "template<typename Block, discretization::blocks::SystemLayoutType Layout> auto \fBphysical_block\fP (const Layout &layout)"
|
|
.br
|
|
.RI "Publish a requested physical block from the same physical root used for residual and Jacobian actions\&. "
|
|
.ti -1c
|
|
.RI "template<discretization::blocks::SystemLayoutType Layout, typename\&.\&.\&. Blocks> auto \fBmake_physical_block_computations\fP (const Layout &layout, \fButils::dependencies::KeyList\fP< Blocks\&.\&.\&. >)"
|
|
.br
|
|
.RI "Supply precisely the requested physical couplings to existing preconditioner computations\&. "
|
|
.ti -1c
|
|
.RI "template<typename Layout, typename Binding> auto \fBpotential_infinity_contribution\fP (Layout layout, const Binding &binding)"
|
|
.br
|
|
.RI "Replace only the compactified-infinity potential rows by the zero physical trace\&. "
|
|
.ti -1c
|
|
.RI "template<geometry::surface::backend::mfem::PressureBoundaryFormulation Formulation, discretization::blocks::SystemLayoutType Layout>
|
|
.br
|
|
requires utils::dependencies::ContainsKey<typename Formulation::CarrierTerm, typename Layout::Residuals>auto \fBpressure_boundary_contribution\fP (Layout layout)"
|
|
.br
|
|
.RI "Publish accepted pressure rows and their solved-field derivatives in system coordinates\&. "
|
|
.ti -1c
|
|
.RI "template<typename Equation, typename Layout>
|
|
.br
|
|
requires discretization::blocks::GlobalScalarTerm<typename Equation::Test>auto \fBscalar_residual_row\fP (Layout layout)"
|
|
.br
|
|
.RI "Rebuild a scalar functional only when its physical equation or shape derivative changes\&. "
|
|
.ti -1c
|
|
.RI "auto \fBshape_derivatives\fP (const \fBdiscretization::backend::mfem::DofMap\fP &binding)"
|
|
.br
|
|
.RI "Prepare the projected shape derivative once per evaluated geometry, retaining its computed owner\&. "
|
|
.ti -1c
|
|
.RI "template<discretization::blocks::SystemLayoutType Layout> auto \fBmake_solver_layout_computations\fP (const Layout &layout)"
|
|
.br
|
|
.RI "Give normalization and preconditioning one producer for their shared coordinate layout\&. "
|
|
.ti -1c
|
|
.RI "template<typename Layout> auto \fBsurface_potential_contribution\fP (\fBequations::SurfacePotentialBalance\fP equation, Layout layout)"
|
|
.br
|
|
.RI "Replace the volume force pullback by scalar effective-potential moments on the same surface\&. "
|
|
.in -1c
|
|
.SH "Function Documentation"
|
|
.PP
|
|
.SS "template<typename Equation, typename Layout> auto serif::model::computations::interior_computations (const Layout & layout)\fR [nodiscard]\fP"
|
|
|
|
.PP
|
|
Scalar equations publish a reusable functional before joining ordinary system assembly\&.
|
|
.SS "template<typename Equation, typename Layout> auto serif::model::computations::interior_contribution (Layout layout)\fR [nodiscard]\fP"
|
|
|
|
.PP
|
|
Declare one owning contribution per equation; shape coordinates add one explicit shared prerequisite\&.
|
|
.SS "template<discretization::blocks::SystemLayoutType Layout, typename\&.\&.\&. Blocks> auto serif::model::computations::make_physical_block_computations (const Layout & layout, \fButils::dependencies::KeyList\fP< Blocks\&.\&.\&. > )\fR [nodiscard]\fP"
|
|
|
|
.PP
|
|
Supply precisely the requested physical couplings to existing preconditioner computations\&.
|
|
.SS "template<discretization::blocks::SystemLayoutType Layout> auto serif::model::computations::make_solver_layout_computations (const Layout & layout)\fR [nodiscard]\fP"
|
|
|
|
.PP
|
|
Give normalization and preconditioning one producer for their shared coordinate layout\&.
|
|
.SS "template<typename Block, discretization::blocks::SystemLayoutType Layout> auto serif::model::computations::physical_block (const Layout & layout)\fR [nodiscard]\fP"
|
|
|
|
.PP
|
|
Publish a requested physical block from the same physical root used for residual and Jacobian actions\&.
|
|
.SS "template<typename Layout, typename Binding> auto serif::model::computations::potential_infinity_contribution (Layout layout, const Binding & binding)\fR [nodiscard]\fP"
|
|
|
|
.PP
|
|
Replace only the compactified-infinity potential rows by the zero physical trace\&.
|
|
.SS "template<geometry::surface::backend::mfem::PressureBoundaryFormulation Formulation, discretization::blocks::SystemLayoutType Layout>
|
|
.br
|
|
requires utils::dependencies::ContainsKey<typename Formulation::CarrierTerm, typename Layout::Residuals>auto serif::model::computations::pressure_boundary_contribution (Layout layout)\fR [nodiscard]\fP"
|
|
|
|
.PP
|
|
Publish accepted pressure rows and their solved-field derivatives in system coordinates\&.
|
|
.PP
|
|
\fBNote\fP
|
|
.RS 4
|
|
Prescribed EOS inputs still participate in surface evaluation, but have no Newton column\&. The compiled surface formulation selects its physical carrier; no enthalpy assumption enters assembly\&.
|
|
.RE
|
|
.PP
|
|
|
|
.SS "template<typename Equation, typename Layout>
|
|
.br
|
|
requires discretization::blocks::GlobalScalarTerm<typename Equation::Test>auto serif::model::computations::scalar_residual_row (Layout layout)\fR [nodiscard]\fP"
|
|
|
|
.PP
|
|
Rebuild a scalar functional only when its physical equation or shape derivative changes\&.
|
|
.SS "auto serif::model::computations::shape_derivatives (const \fBdiscretization::backend::mfem::DofMap\fP & binding)\fR [inline]\fP, \fR [nodiscard]\fP"
|
|
|
|
.PP
|
|
Prepare the projected shape derivative once per evaluated geometry, retaining its computed owner\&.
|
|
.SS "template<typename Layout> auto serif::model::computations::surface_potential_contribution (\fBequations::SurfacePotentialBalance\fP equation, Layout layout)\fR [nodiscard]\fP"
|
|
|
|
.PP
|
|
Replace the volume force pullback by scalar effective-potential moments on the same surface\&.
|
|
.SS "template<typename Equation, typename Schema, typename Layout> \fBContributions\fP serif::model::computations::volume_contribution (std::shared_ptr< const \fBoperators::backend::mfem::VolumeData\fP< Equation, Schema > > accepted, const Layout & layout, std::optional< \fBbackend::mfem::ColumnContribution\fP > geometry = \fR{}\fP)\fR [nodiscard]\fP"
|
|
|
|
.PP
|
|
Assemble field and optional geometry columns from the same retained volume result\&.
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|