Emily Boudreaux
6b57738330
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)
53 lines
2.2 KiB
Groff
53 lines
2.2 KiB
Groff
.TH "serif::solver::SolverOptions< Metric, Strategies, LinearSolver >" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::solver::SolverOptions< Metric, Strategies, LinearSolver > \- Select numerical policies while keeping equilibrium physics in the model\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <options\&.hpp>\fP
|
|
.SS "Public Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "\fBNewton\fP \fBmethod\fP {}"
|
|
.br
|
|
.ti -1c
|
|
.RI "LinearSolver \fBlinear_solver\fP {}"
|
|
.br
|
|
.ti -1c
|
|
.RI "\fBBacktracking\fP \fBline_search\fP {}"
|
|
.br
|
|
.ti -1c
|
|
.RI "Metric \fBmetric\fP {}"
|
|
.br
|
|
.ti -1c
|
|
.RI "Strategies \fBstrategies\fP {}"
|
|
.br
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
|
|
.SS "template<typename Metric = NormalizedResidualMetric, typename Strategies = StandardNewton, typename LinearSolver = linear::FGMRES>
|
|
.br
|
|
struct serif::solver::SolverOptions< Metric, Strategies, LinearSolver >"Select numerical policies while keeping equilibrium physics in the model\&.
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "template<typename Metric = NormalizedResidualMetric, typename Strategies = StandardNewton, typename LinearSolver = linear::FGMRES> \fBBacktracking\fP \fBserif::solver::SolverOptions\fP< Metric, Strategies, LinearSolver >::line_search {}"
|
|
|
|
.SS "template<typename Metric = NormalizedResidualMetric, typename Strategies = StandardNewton, typename LinearSolver = linear::FGMRES> LinearSolver \fBserif::solver::SolverOptions\fP< Metric, Strategies, LinearSolver >::linear_solver {}"
|
|
|
|
.SS "template<typename Metric = NormalizedResidualMetric, typename Strategies = StandardNewton, typename LinearSolver = linear::FGMRES> \fBNewton\fP \fBserif::solver::SolverOptions\fP< Metric, Strategies, LinearSolver >::method {}"
|
|
|
|
.SS "template<typename Metric = NormalizedResidualMetric, typename Strategies = StandardNewton, typename LinearSolver = linear::FGMRES> Metric \fBserif::solver::SolverOptions\fP< Metric, Strategies, LinearSolver >::metric {}"
|
|
|
|
.SS "template<typename Metric = NormalizedResidualMetric, typename Strategies = StandardNewton, typename LinearSolver = linear::FGMRES> Strategies \fBserif::solver::SolverOptions\fP< Metric, Strategies, LinearSolver >::strategies {}"
|
|
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|