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

67 lines
3.5 KiB
Groff
Raw Normal View History

.TH "serif::solver::seed::backend::mfem" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::solver::seed::backend::mfem
.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 \fBProjectionOptions\fP"
.br
.RI "Allow for the reference mesh's finite-order approximation to a spherical seed surface\&. "
.in -1c
.SS "Functions"
.in +1c
.ti -1c
.RI "template<typename Discretization> std::expected< \fBFittedRadialSeed\fP, std::string > \fBfit_radial_seed\fP (const Discretization &discretization, const \fBRadialSeed\fP &seed, double spherical_relative_tolerance=5\&.0e\-4)"
.br
.RI "Fit only an initial radial guess to the selected spherical reference surface\&. "
.ti -1c
.RI "template<model::StellarModelType Model, typename Discretization, typename Profile>
.br
requires (std::same_as<Profile, \fBRadialSeed\fP> || std::same_as<Profile, \fBFittedRadialSeed\fP>) && requires(const Model& model, const Discretization& discretization) { requires (!std::same_as<typename std::remove_cvref_t<decltype(\fBmodel::resolve_equilibrium_equations\fP(model))>::ShapeForce, \fBmodel::NoShapeForce\fP>); discretization\&.deformation\&.model\&.surface; discretization\&.deformation\&.reference; }auto \fBmake_polytropic_state\fP (const Model &model, const Discretization &discretization, const Profile &seed, const \fBProjectionOptions\fP options={})"
.br
.RI "Project a spherical guess into a moving model's named physical coordinates on its undeformed reference mesh\&. "
.in -1c
.SH "Function Documentation"
.PP
.SS "template<typename Discretization> std::expected< \fBFittedRadialSeed\fP, std::string > serif::solver::seed::backend::mfem::fit_radial_seed (const Discretization & discretization, const \fBRadialSeed\fP & seed, double spherical_relative_tolerance = \fR5\&.0e\-4\fP)\fR [nodiscard]\fP"
.PP
Fit only an initial radial guess to the selected spherical reference surface\&.
.PP
\fBNote\fP
.RS 4
Surface radius is the midpoint of its selected FE-coordinate extrema, as in MeanField\&. The original seed, reference mesh, EOS and target constraints are never modified\&.
.RE
.PP
.SS "template<model::StellarModelType Model, typename Discretization, typename Profile>
.br
requires (std::same_as<Profile, \fBRadialSeed\fP> || std::same_as<Profile, \fBFittedRadialSeed\fP>) && requires(const Model& model, const Discretization& discretization) { requires (!std::same_as<typename std::remove_cvref_t<decltype(\fBmodel::resolve_equilibrium_equations\fP(model))>::ShapeForce, \fBmodel::NoShapeForce\fP>); discretization\&.deformation\&.model\&.surface; discretization\&.deformation\&.reference; }auto serif::solver::seed::backend::mfem::make_polytropic_state (const Model & model, const Discretization & discretization, const Profile & seed, const \fBProjectionOptions\fP options = \fR{}\fP)\fR [nodiscard]\fP"
.PP
Project a spherical guess into a moving model's named physical coordinates on its undeformed reference mesh\&.
.PP
\fBNote\fP
.RS 4
Choose a spherical reference mesh close to the seed radius, or explicitly fit the initial guess first\&. Shape starts at zero; the scalar formulation's surface level starts at -GM/R\&. The selected zero-pressure polytropic field trace is enforced exactly\&. It does not change the EOS, fit the mesh, or certify a discrete equilibrium\&. The vacuum limits assume radial compactification, as used by the stellar Kelvin map\&.
.RE
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.