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

201 lines
14 KiB
Groff
Raw Permalink Normal View History

.TH "serif::model::backend::mfem::detail" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::model::backend::mfem::detail
.SH SYNOPSIS
.br
.PP
.SS "Classes"
.in +1c
.ti -1c
.RI "struct \fBNoAdditionalComputations\fP"
.br
.RI "Ordinary model evaluation adds no caller-selected preparation computations\&. "
.ti -1c
.RI "struct \fBPhysicalEvaluation\fP"
.br
.RI "Select physical coordinates without adding normalization graph services\&. "
.ti -1c
.RI "class \fBStateCoefficients\fP"
.br
.ti -1c
.RI "class \fBStateCoefficients< Discretization, Layout, Prescribed, utils::dependencies::KeyList< Fields\&.\&.\&. > >\fP"
.br
.RI "Borrow an owning state's fields for one synchronous equation evaluation\&. "
.ti -1c
.RI "struct \fBSystemData\fP"
.br
.RI "Retain accepted blocks and the stable external resources borrowed by those blocks\&. "
.in -1c
.SS "Concepts"
.in +1c
.ti -1c
.RI "concept \fBReconstructionSpecification\fP"
.br
.RI "Recognize a field-specific reconstruction request without prescribing its numerical form\&. "
.ti -1c
.RI "concept \fBCoefficientInput\fP"
.br
.RI "Recognize a field view by its physical identity and backend coefficient representation\&. "
.ti -1c
.RI "concept \fBPrescribedInputsFor\fP"
.br
.RI "Prescribed views must supply every unsolved input and cannot duplicate a solved coordinate\&. "
.in -1c
.SS "Functions"
.in +1c
.ti -1c
.RI "template<typename EOS> auto \fBequation_of_state_input\fP (const EOS &eos)"
.br
.RI "Track immutable physics with a policy type independent of the caller's field ordering\&. "
.ti -1c
.RI "template<typename Geometry> std::size_t \fBgeometry_size\fP (const Geometry &coefficients)"
.br
.RI "Count either backend displacement coefficients or independent surface coefficients\&. "
.ti -1c
.RI "template<geometry::deformation::DeformationMap Map> void \fBvalidate_deformation\fP (const std::shared_ptr< const \fBgeometry::deformation::DeformationLinearization\fP< Map > > &state)"
.br
.RI "Reject null accepted maps and dimensions that MFEM cannot represent\&. "
.ti -1c
.RI "void \fBrequire_deformation_action\fP (const \fBgeometry::deformation::DeformationStatus\fP &status)"
.br
.RI "Preserve the originating deformation diagnostic at the MFEM action boundary\&. "
.ti -1c
.RI "template<typename\&.\&.\&. Computations> auto \fBcomputation_keys\fP (const std::tuple< Computations\&.\&.\&. > &)"
.br
.RI "Derive requested result identities directly from the supplied computation declarations\&. "
.ti -1c
.RI "template<typename Prescribed, typename SpecificationMap, typename ExplicitZeroCouplings, typename Model, typename Discretization, typename Coefficients, typename Geometry, typename NumericalOptions = PhysicalEvaluation, typename Preconditioner = preconditioning::None, typename Services = NoAdditionalComputations, typename ObserverFactory = utils::dependencies::NoGraphObservers> auto \fBbind_evaluator\fP (std::shared_ptr< const Model > model, std::shared_ptr< const Discretization > discretization, const Coefficients &coefficients, const Geometry &geometry, \fBoperators::backend::mfem::VolumeOptions\fP options, NumericalOptions numerical_options={}, Preconditioner preconditioner={}, Services services={}, ObserverFactory observer_factory={})"
.br
.RI "Bind physics once and add only the explicitly selected numerical services\&. "
.ti -1c
.RI "template<typename Prescribed, typename SpecificationMap, typename ExplicitZeroCouplings, typename Model, typename Discretization, typename Layout, typename Geometry, typename Inputs, typename NumericalOptions = PhysicalEvaluation, typename Preconditioner = preconditioning::None, typename Services = NoAdditionalComputations, typename ObserverFactory = utils::dependencies::NoGraphObservers> auto \fBbind_state_evaluator\fP (Model model, Discretization discretization, const \fBStellarState\fP< Layout > &state, const Geometry &geometry, \fBoperators::backend::mfem::VolumeOptions\fP options, const Inputs &prescribed, NumericalOptions numerical={}, Preconditioner preconditioner={}, Services services={}, ObserverFactory observer_factory={})"
.br
.RI "Retain finite-element bindings before constructing temporary views into an owning state\&. "
.ti -1c
.RI "template<typename Bound, typename Coefficients, typename Geometry> auto \fBcandidate_inputs\fP (const Bound &bound, const Coefficients &coefficients, const Geometry &geometry)"
.br
.RI "Use one shape-view input schema for both packed states and external coefficient containers\&. "
.ti -1c
.RI "template<typename Owner, typename\&.\&.\&. Terms, ReconstructionSpecification Specification> void \fBapply_reconstruction\fP (Owner &owner, \fButils::dependencies::KeyList\fP< Terms\&.\&.\&. >, const Specification &specification)"
.br
.RI "Attach a requested numerical interpretation while the bindings still have a single mutable owner\&. "
.ti -1c
.RI "template<ReconstructionSpecification\&.\&.\&. Specifications> void \fBvalidate_reconstruction_requests\fP ()"
.br
.RI "Reject duplicate field requests before constructing any finite elements\&. "
.ti -1c
.RI "template<discretization::blocks::SpatialTerm Term> ::mfem::FiniteElementSpace & \fBterm_space\fP (\fBdiscretization::backend::mfem::Resources\fP &resources)"
.br
.RI "Construct only representations supported by TermBinding, directly from the term's compile-time descriptor\&. "
.ti -1c
.RI "template<typename\&.\&.\&. Terms, ReconstructionSpecification\&.\&.\&. Specifications> auto \fBmake_bindings\fP (const \fBStellarMeshOptions\fP &options, \fButils::dependencies::KeyList\fP< Terms\&.\&.\&. > keys, const Specifications &\&.\&.\&. specifications)"
.br
.RI "Own precisely the model's coefficients plus displacement geometry; no particular thermodynamic field is required\&. "
.ti -1c
.RI "template<typename Discretization, typename Coefficients, typename\&.\&.\&. Terms> void \fBvalidate_coefficient_owners\fP (const Discretization &discretization, const Coefficients &coefficients, \fButils::dependencies::KeyList\fP< Terms\&.\&.\&. >)"
.br
.RI "Accepted actions may borrow only bindings retained by the declared discretization owner\&. "
.ti -1c
.RI "template<typename Discretization, typename Coefficients, typename\&.\&.\&. Equations, typename\&.\&.\&. Fields> auto \fBmodel_inputs\fP (const Discretization &discretization, const Coefficients &coefficients, \fButils::types::TypeList\fP< Equations\&.\&.\&. >, \fButils::dependencies::KeyList\fP< Fields\&.\&.\&. >)"
.br
.RI "Bind common physical coefficients once and keep equation-specific metadata distinct\&. "
.ti -1c
.RI "template<typename Inputs, typename\&.\&.\&. Terms> consteval bool \fBcoefficient_inputs\fP (\fButils::dependencies::KeyList\fP< Terms\&.\&.\&. >)"
.br
.RI "Check required fields before entering evaluation, including during compile-time API detection\&. "
.ti -1c
.RI "template<typename Discretization, typename Layout, typename Prescribed> auto \fBstate_coefficients\fP (const Discretization &discretization, const \fBStellarState\fP< Layout > &state, const Prescribed &prescribed)"
.br
.RI "Keep surface coordinates in the state while exposing only ordinary fields to volume equations\&. "
.ti -1c
.RI "void \fBvalidate_range\fP (int offset, int size, int extent)"
.br
.RI "Reject invalid subranges without overflowing integer additions\&. "
.ti -1c
.RI "\fBLinearizedBlock\fP \fBselect_block\fP (std::shared_ptr< const \fBSystemData\fP > data, std::span< const \fBCoordinateRange\fP > rows, std::span< const \fBCoordinateRange\fP > columns, bool complete_action=false)"
.br
.RI "Build an independently owned selection of accepted physical couplings\&. "
.in -1c
.SH "Function Documentation"
.PP
.SS "template<typename Owner, typename\&.\&.\&. Terms, ReconstructionSpecification Specification> void serif::model::backend::mfem::detail::apply_reconstruction (Owner & owner, \fButils::dependencies::KeyList\fP< Terms\&.\&.\&. > , const Specification & specification)"
.PP
Attach a requested numerical interpretation while the bindings still have a single mutable owner\&.
.SS "template<typename Prescribed, typename SpecificationMap, typename ExplicitZeroCouplings, typename Model, typename Discretization, typename Coefficients, typename Geometry, typename NumericalOptions = PhysicalEvaluation, typename Preconditioner = preconditioning::None, typename Services = NoAdditionalComputations, typename ObserverFactory = utils::dependencies::NoGraphObservers> auto serif::model::backend::mfem::detail::bind_evaluator (std::shared_ptr< const Model > model, std::shared_ptr< const Discretization > discretization, const Coefficients & coefficients, const Geometry & geometry, \fBoperators::backend::mfem::VolumeOptions\fP options, NumericalOptions numerical_options = \fR{}\fP, Preconditioner preconditioner = \fR{}\fP, Services services = \fR{}\fP, ObserverFactory observer_factory = \fR{}\fP)\fR [nodiscard]\fP"
.PP
Bind physics once and add only the explicitly selected numerical services\&.
.SS "template<typename Prescribed, typename SpecificationMap, typename ExplicitZeroCouplings, typename Model, typename Discretization, typename Layout, typename Geometry, typename Inputs, typename NumericalOptions = PhysicalEvaluation, typename Preconditioner = preconditioning::None, typename Services = NoAdditionalComputations, typename ObserverFactory = utils::dependencies::NoGraphObservers> auto serif::model::backend::mfem::detail::bind_state_evaluator (Model model, Discretization discretization, const \fBStellarState\fP< Layout > & state, const Geometry & geometry, \fBoperators::backend::mfem::VolumeOptions\fP options, const Inputs & prescribed, NumericalOptions numerical = \fR{}\fP, Preconditioner preconditioner = \fR{}\fP, Services services = \fR{}\fP, ObserverFactory observer_factory = \fR{}\fP)\fR [nodiscard]\fP"
.PP
Retain finite-element bindings before constructing temporary views into an owning state\&.
.SS "template<typename Bound, typename Coefficients, typename Geometry> auto serif::model::backend::mfem::detail::candidate_inputs (const Bound & bound, const Coefficients & coefficients, const Geometry & geometry)\fR [nodiscard]\fP"
.PP
Use one shape-view input schema for both packed states and external coefficient containers\&.
.SS "template<typename Inputs, typename\&.\&.\&. Terms> bool serif::model::backend::mfem::detail::coefficient_inputs (\fButils::dependencies::KeyList\fP< Terms\&.\&.\&. > )\fR [nodiscard]\fP, \fR [consteval]\fP"
.PP
Check required fields before entering evaluation, including during compile-time API detection\&.
.SS "template<typename\&.\&.\&. Computations> auto serif::model::backend::mfem::detail::computation_keys (const std::tuple< Computations\&.\&.\&. > & )\fR [nodiscard]\fP"
.PP
Derive requested result identities directly from the supplied computation declarations\&.
.SS "template<typename EOS> auto serif::model::backend::mfem::detail::equation_of_state_input (const EOS & eos)\fR [nodiscard]\fP"
.PP
Track immutable physics with a policy type independent of the caller's field ordering\&.
.SS "template<typename Geometry> std::size_t serif::model::backend::mfem::detail::geometry_size (const Geometry & coefficients)\fR [nodiscard]\fP"
.PP
Count either backend displacement coefficients or independent surface coefficients\&.
.SS "template<typename\&.\&.\&. Terms, ReconstructionSpecification\&.\&.\&. Specifications> auto serif::model::backend::mfem::detail::make_bindings (const \fBStellarMeshOptions\fP & options, \fButils::dependencies::KeyList\fP< Terms\&.\&.\&. > keys, const Specifications &\&.\&.\&. specifications)\fR [nodiscard]\fP"
.PP
Own precisely the model's coefficients plus displacement geometry; no particular thermodynamic field is required\&.
.SS "template<typename Discretization, typename Coefficients, typename\&.\&.\&. Equations, typename\&.\&.\&. Fields> auto serif::model::backend::mfem::detail::model_inputs (const Discretization & discretization, const Coefficients & coefficients, \fButils::types::TypeList\fP< Equations\&.\&.\&. > , \fButils::dependencies::KeyList\fP< Fields\&.\&.\&. > )\fR [nodiscard]\fP"
.PP
Bind common physical coefficients once and keep equation-specific metadata distinct\&.
.SS "void serif::model::backend::mfem::detail::require_deformation_action (const \fBgeometry::deformation::DeformationStatus\fP & status)"
.PP
Preserve the originating deformation diagnostic at the MFEM action boundary\&.
.SS "\fBLinearizedBlock\fP serif::model::backend::mfem::detail::select_block (std::shared_ptr< const \fBSystemData\fP > data, std::span< const \fBCoordinateRange\fP > rows, std::span< const \fBCoordinateRange\fP > columns, bool complete_action = \fRfalse\fP)\fR [nodiscard]\fP"
.PP
Build an independently owned selection of accepted physical couplings\&.
.SS "template<typename Discretization, typename Layout, typename Prescribed> auto serif::model::backend::mfem::detail::state_coefficients (const Discretization & discretization, const \fBStellarState\fP< Layout > & state, const Prescribed & prescribed)\fR [nodiscard]\fP"
.PP
Keep surface coordinates in the state while exposing only ordinary fields to volume equations\&.
.SS "template<discretization::blocks::SpatialTerm Term> ::mfem::FiniteElementSpace & serif::model::backend::mfem::detail::term_space (\fBdiscretization::backend::mfem::Resources\fP & resources)\fR [nodiscard]\fP"
.PP
Construct only representations supported by TermBinding, directly from the term's compile-time descriptor\&.
.SS "template<typename Discretization, typename Coefficients, typename\&.\&.\&. Terms> void serif::model::backend::mfem::detail::validate_coefficient_owners (const Discretization & discretization, const Coefficients & coefficients, \fButils::dependencies::KeyList\fP< Terms\&.\&.\&. > )"
.PP
Accepted actions may borrow only bindings retained by the declared discretization owner\&.
.SS "template<geometry::deformation::DeformationMap Map> void serif::model::backend::mfem::detail::validate_deformation (const std::shared_ptr< const \fBgeometry::deformation::DeformationLinearization\fP< Map > > & state)"
.PP
Reject null accepted maps and dimensions that MFEM cannot represent\&.
.SS "void serif::model::backend::mfem::detail::validate_range (int offset, int size, int extent)"
.PP
Reject invalid subranges without overflowing integer additions\&.
.SS "template<ReconstructionSpecification\&.\&.\&. Specifications> void serif::model::backend::mfem::detail::validate_reconstruction_requests ()"
.PP
Reject duplicate field requests before constructing any finite elements\&.
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.