44 lines
1.7 KiB
Groff
44 lines
1.7 KiB
Groff
|
|
.TH "src/include/serif/solver/seed/state.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
||
|
|
.ad l
|
||
|
|
.nh
|
||
|
|
.SH NAME
|
||
|
|
src/include/serif/solver/seed/state.hpp
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.br
|
||
|
|
.PP
|
||
|
|
\fR#include 'serif/backend/mfem/solver/seed/state\&.hpp'\fP
|
||
|
|
.br
|
||
|
|
\fR#include 'serif/backend/mfem/solver/seed/fitted\&.hpp'\fP
|
||
|
|
.br
|
||
|
|
|
||
|
|
.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 "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 \fBserif::solver::seed::make_polytropic_state\fP (const Model &model, const Discretization &discretization, const Profile &seed, const ProjectionOptions options={})"
|
||
|
|
.br
|
||
|
|
.RI "Project a spherical guess into a moving model's named physical coordinates on its undeformed reference mesh\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "template<typename Discretization> std::expected< \fBFittedRadialSeed\fP, std::string > \fBserif::solver::seed::fit_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\&. "
|
||
|
|
.in -1c
|
||
|
|
.SH "Author"
|
||
|
|
.PP
|
||
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|