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)
48 lines
2.4 KiB
Groff
48 lines
2.4 KiB
Groff
.TH "serif::model::DiscretizationOptions< Model, FiniteElements, Normalization, Preconditioner >" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::model::DiscretizationOptions< Model, FiniteElements, Normalization, Preconditioner > \- Select a descriptive star, its existing finite-element resources, and its numerical coordinates\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <configured_discretization\&.hpp>\fP
|
|
.SS "Public Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "Model \fBmodel\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "FiniteElements \fBfinite_elements\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "Normalization \fBnormalization\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "Preconditioner \fBpreconditioner\fP"
|
|
.br
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
|
|
.SS "template<StellarModelType Model, typename FiniteElements, typename Normalization = solver::normalization::NormalizationOptions<>, typename Preconditioner = preconditioning::None>
|
|
.br
|
|
struct serif::model::DiscretizationOptions< Model, FiniteElements, Normalization, Preconditioner >"Select a descriptive star, its existing finite-element resources, and its numerical coordinates\&.
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "template<StellarModelType Model, typename FiniteElements, typename Normalization = solver::normalization::NormalizationOptions<>, typename Preconditioner = preconditioning::None> FiniteElements \fBserif::model::DiscretizationOptions\fP< Model, FiniteElements, Normalization, Preconditioner >::finite_elements"
|
|
|
|
.SS "template<StellarModelType Model, typename FiniteElements, typename Normalization = solver::normalization::NormalizationOptions<>, typename Preconditioner = preconditioning::None> Model \fBserif::model::DiscretizationOptions\fP< Model, FiniteElements, Normalization, Preconditioner >::model"
|
|
|
|
.SS "template<StellarModelType Model, typename FiniteElements, typename Normalization = solver::normalization::NormalizationOptions<>, typename Preconditioner = preconditioning::None> Normalization \fBserif::model::DiscretizationOptions\fP< Model, FiniteElements, Normalization, Preconditioner >::normalization"
|
|
|
|
.SS "template<StellarModelType Model, typename FiniteElements, typename Normalization = solver::normalization::NormalizationOptions<>, typename Preconditioner = preconditioning::None> Preconditioner \fBserif::model::DiscretizationOptions\fP< Model, FiniteElements, Normalization, Preconditioner >::preconditioner"
|
|
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|