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

85 lines
2.3 KiB
Groff
Raw Normal View History

.TH "serif::solver::SolveDiagnostics" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::solver::SolveDiagnostics \- Bounded work totals; accepted physical snapshots are stored separately from diagnostics\&.
.SH SYNOPSIS
.br
.PP
.PP
\fR#include <result\&.hpp>\fP
.SS "Public Attributes"
.in +1c
.ti -1c
.RI "int \fBattempted_iterations\fP {0}"
.br
.ti -1c
.RI "int \fBaccepted_iterations\fP {0}"
.br
.ti -1c
.RI "int \fBline_search_trials\fP {0}"
.br
.ti -1c
.RI "int \fBrejected_trials\fP {0}"
.br
.ti -1c
.RI "int \fBgeometry_limited_iterations\fP {0}"
.br
.ti -1c
.RI "int \fBtotal_linear_iterations\fP {0}"
.br
.ti -1c
.RI "std::optional< double > \fBinitial_residual_norm\fP"
.br
.ti -1c
.RI "std::optional< double > \fBfinal_residual_norm\fP"
.br
.ti -1c
.RI "std::optional< double > \fBconvergence_threshold\fP"
.br
.ti -1c
.RI "std::optional< \fBlinear::Report\fP > \fBlast_linear_solve\fP"
.br
.ti -1c
.RI "std::optional< \fBgeometry::deformation::GeometryStepLimit\fP > \fBlast_geometry_preflight\fP"
.br
.ti -1c
.RI "double \fBlast_accepted_step\fP {0\&.0}"
.br
.in -1c
.SH "Detailed Description"
.PP
Bounded work totals; accepted physical snapshots are stored separately from diagnostics\&.
.SH "Member Data Documentation"
.PP
.SS "int serif::solver::SolveDiagnostics::accepted_iterations {0}"
.SS "int serif::solver::SolveDiagnostics::attempted_iterations {0}"
.SS "std::optional<double> serif::solver::SolveDiagnostics::convergence_threshold"
.SS "std::optional<double> serif::solver::SolveDiagnostics::final_residual_norm"
.SS "int serif::solver::SolveDiagnostics::geometry_limited_iterations {0}"
.SS "std::optional<double> serif::solver::SolveDiagnostics::initial_residual_norm"
.SS "double serif::solver::SolveDiagnostics::last_accepted_step {0\&.0}"
.SS "std::optional<\fBgeometry::deformation::GeometryStepLimit\fP> serif::solver::SolveDiagnostics::last_geometry_preflight"
.SS "std::optional<\fBlinear::Report\fP> serif::solver::SolveDiagnostics::last_linear_solve"
.SS "int serif::solver::SolveDiagnostics::line_search_trials {0}"
.SS "int serif::solver::SolveDiagnostics::rejected_trials {0}"
.SS "int serif::solver::SolveDiagnostics::total_linear_iterations {0}"
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.