Files
MeanField_SERiF/docs/man/man3/serif_discretization_quadrature_QuadratureManifestOptions.3
Emily Boudreaux 6b57738330 docs(docs): built docs
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)
2026-11-09 14:09:44 -05:00

49 lines
1.8 KiB
Groff

.TH "serif::discretization::quadrature::QuadratureManifestOptions" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::discretization::quadrature::QuadratureManifestOptions \- A struct to hold the options for the quadrature manifest\&. This contains flags for enabling the manifest, including repeated queries, and an optional output file\&.
.SH SYNOPSIS
.br
.PP
.PP
\fR#include <rules\&.hpp>\fP
.SS "Public Attributes"
.in +1c
.ti -1c
.RI "bool \fBenabled\fP = false"
.br
.RI "A flag indicating whether the quadrature manifest is enabled\&. "
.ti -1c
.RI "bool \fBinclude_repeated_queries\fP = false"
.br
.RI "A flag indicating whether to include repeated queries in the quadrature manifest\&. "
.ti -1c
.RI "std::optional< std::string > \fBoutput_file\fP"
.br
.RI "An optional output file for the quadrature manifest\&. If this is set, the manifest will be written to the specified file\&. "
.in -1c
.SH "Detailed Description"
.PP
A struct to hold the options for the quadrature manifest\&. This contains flags for enabling the manifest, including repeated queries, and an optional output file\&.
.SH "Member Data Documentation"
.PP
.SS "bool serif::discretization::quadrature::QuadratureManifestOptions::enabled = false"
.PP
A flag indicating whether the quadrature manifest is enabled\&.
.SS "bool serif::discretization::quadrature::QuadratureManifestOptions::include_repeated_queries = false"
.PP
A flag indicating whether to include repeated queries in the quadrature manifest\&.
.SS "std::optional<std::string> serif::discretization::quadrature::QuadratureManifestOptions::output_file"
.PP
An optional output file for the quadrature manifest\&. If this is set, the manifest will be written to the specified file\&.
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.