.TH "src/include/serif/solver/seed/polytrope.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include/serif/solver/seed/polytrope.hpp
.SH SYNOPSIS
.br
.PP
\fR#include <array>\fP
.br
\fR#include <concepts>\fP
.br
\fR#include <expected>\fP
.br
\fR#include <optional>\fP
.br
\fR#include <string>\fP
.br
\fR#include 'serif/eos/models/polytropic\&.hpp'\fP
.br
\fR#include 'serif/model/stellar_model\&.hpp'\fP
.br
\fR#include 'serif/model/specifications/fixed_total_mass\&.hpp'\fP
.br
\fR#include 'serif/model/specifications/fixed_angular_momentum\&.hpp'\fP
.br
\fR#include 'serif/utils/laneemden/laneemden\&.hpp'\fP
.br

.SS "Classes"

.in +1c
.ti -1c
.RI "struct \fBserif::solver::seed::PolytropeOptions\fP"
.br
.RI "Numerical choices for an EOS-consistent spherical starting guess, separate from solver normalization\&. "
.ti -1c
.RI "struct \fBserif::solver::seed::RadialSeed\fP"
.br
.RI "Own a spherical physical profile and its first rotation estimate without changing the stellar model\&. "
.in -1c
.SS "Namespaces"

.in +1c
.ti -1c
.RI "namespace \fBserif\fP"
.br
.ti -1c
.RI "namespace \fBserif::solver\fP"
.br
.ti -1c
.RI "namespace \fBserif::solver::seed\fP"
.br
.in -1c
.SS "Functions"

.in +1c
.ti -1c
.RI "std::expected< \fBRadialSeed\fP, std::string > \fBserif::solver::seed::make_polytropic_seed\fP (const \fBeos::models::Polytrope\fP &equation_of_state, \fBdimensions::MassValue\fP mass, \fBPolytropeOptions\fP options={})"
.br
.RI "Fix the EOS K and requested mass, solving for central density when n differs from three\&. "
.ti -1c
.RI "template<model::StellarModelType Model> 
.br
requires Model::templatecontains_specification< \fBmodel::FixedTotalMass\fP > std::expected< \fBRadialSeed\fP, std::string > \fBserif::solver::seed::make_polytropic_seed\fP (const Model &model, \fBPolytropeOptions\fP options={})"
.br
.RI "Read the authoritative EOS, mass and optional rotation prescription from a model\&. "
.in -1c
.SH "Author"
.PP 
Generated automatically by Doxygen for SERiF from the source code\&.