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)
57 lines
2.0 KiB
Groff
57 lines
2.0 KiB
Groff
.TH "serif::discretization::quadrature::QuadratureValidationOptions" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::discretization::quadrature::QuadratureValidationOptions \- A struct to hold the options for quadrature validation\&. This contains flags for requiring explicit base orders and MFEM rules, rejecting negative boosts, and reporting unused overrides\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <rules\&.hpp>\fP
|
|
.SS "Public Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "bool \fBrequire_explicit_base_order\fP = false"
|
|
.br
|
|
.RI "A flag indicating whether explicit base orders are required\&. "
|
|
.ti -1c
|
|
.RI "bool \fBrequire_explicit_mfem_rule\fP = false"
|
|
.br
|
|
.RI "A flag indicating whether explicit MFEM rules are required\&. "
|
|
.ti -1c
|
|
.RI "bool \fBreject_negative_boosts\fP = true"
|
|
.br
|
|
.RI "A flag indicating whether negative boosts should be rejected\&. "
|
|
.ti -1c
|
|
.RI "bool \fBreport_unused_overrides\fP = true"
|
|
.br
|
|
.RI "A flag indicating whether unused overrides should be reported\&. "
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
A struct to hold the options for quadrature validation\&. This contains flags for requiring explicit base orders and MFEM rules, rejecting negative boosts, and reporting unused overrides\&.
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "bool serif::discretization::quadrature::QuadratureValidationOptions::reject_negative_boosts = true"
|
|
|
|
.PP
|
|
A flag indicating whether negative boosts should be rejected\&.
|
|
.SS "bool serif::discretization::quadrature::QuadratureValidationOptions::report_unused_overrides = true"
|
|
|
|
.PP
|
|
A flag indicating whether unused overrides should be reported\&.
|
|
.SS "bool serif::discretization::quadrature::QuadratureValidationOptions::require_explicit_base_order = false"
|
|
|
|
.PP
|
|
A flag indicating whether explicit base orders are required\&.
|
|
.SS "bool serif::discretization::quadrature::QuadratureValidationOptions::require_explicit_mfem_rule = false"
|
|
|
|
.PP
|
|
A flag indicating whether explicit MFEM rules are required\&.
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|