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)
This commit is contained in:
2026-11-09 14:09:44 -05:00
parent d9c4919477
commit 6b57738330
32596 changed files with 4155414 additions and 0 deletions

View File

@@ -0,0 +1,240 @@
.TH "serif::discretization::quadrature::QuadratureOptions" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::discretization::quadrature::QuadratureOptions \- A struct to hold the options for the quadrature system\&. This contains the mode, global boost, fallback fixed order, quadrature term options for each term, quadrature role options, convergence boosts, quadrature manifest options, and quadrature validation options\&.
.SH SYNOPSIS
.br
.PP
.PP
\fR#include <rules\&.hpp>\fP
.SS "Public Attributes"
.in +1c
.ti -1c
.RI "\fBMode\fP \fBmode\fP = \fBMode::production\fP"
.br
.RI "The mode of the quadrature system\&. This determines the level of accuracy and speed of the quadrature system\&. "
.ti -1c
.RI "int \fBglobal_boost\fP = 0"
.br
.RI "The global boost to the order of the quadrature rule\&. This is added to the default order determined by the form and role\&. Note that different systems have different accuracy requirements and should generally use the lowest order that is sufficient for their needs\&. "
.ti -1c
.RI "std::optional< int > \fBfallback_fixed_order\fP"
.br
.RI "The fallback fixed order for the quadrature rule\&. This is used if no other order is specified\&. "
.ti -1c
.RI "\fBQuadratureTermOptions\fP \fBgravity_hdiv_mass\fP"
.br
.RI "The quadrature term options for the gravity H(div) mass term\&. "
.ti -1c
.RI "\fBQuadratureTermOptions\fP \fBgravity_divergence\fP"
.br
.RI "The quadrature term options for the gravity divergence term\&. "
.ti -1c
.RI "\fBQuadratureTermOptions\fP \fBgravity_source\fP"
.br
.RI "The quadrature term options for the gravity source term\&. "
.ti -1c
.RI "\fBQuadratureTermOptions\fP \fBgravity_force\fP"
.br
.RI "The quadrature term options for the gravity force term\&. "
.ti -1c
.RI "\fBQuadratureTermOptions\fP \fBgravity_boundary\fP"
.br
.RI "The quadrature term options for the gravity boundary term\&. "
.ti -1c
.RI "\fBQuadratureTermOptions\fP \fBcentrifugal\fP"
.br
.RI "The quadrature term options for the centrifugal term\&. "
.ti -1c
.RI "\fBQuadratureTermOptions\fP \fBdensity_projection\fP"
.br
.RI "The quadrature term options for the density projection term\&. "
.ti -1c
.RI "\fBQuadratureTermOptions\fP \fBeos_closure\fP"
.br
.RI "The quadrature term options for the EOS closure term\&. "
.ti -1c
.RI "\fBQuadratureTermOptions\fP \fBhydrostatic_equilibrium\fP"
.br
.RI "The quadrature term options for the hydrostatic equilibrium term\&. "
.ti -1c
.RI "\fBQuadratureTermOptions\fP \fBisobaric_surface\fP"
.br
.RI "The quadrature term options for the isobaric surface term\&. "
.ti -1c
.RI "\fBQuadratureTermOptions\fP \fBmesh_extension\fP"
.br
.RI "The quadrature term options for the mesh extension term\&. "
.ti -1c
.RI "\fBQuadratureTermOptions\fP \fBmass_conservation\fP"
.br
.RI "The quadrature term options for the mass conservation term\&. "
.ti -1c
.RI "\fBQuadratureTermOptions\fP \fBmass_normalization\fP"
.br
.RI "The quadrature term options for the mass normalization term\&. "
.ti -1c
.RI "\fBQuadratureTermOptions\fP \fBcenter_of_mass\fP"
.br
.RI "The quadrature term options for the center of mass term\&. "
.ti -1c
.RI "\fBQuadratureTermOptions\fP \fBquadrupole\fP"
.br
.RI "The quadrature term options for the quadrupole term\&. "
.ti -1c
.RI "\fBQuadratureTermOptions\fP \fBgravitational_energy\fP"
.br
.RI "The quadrature term options for the gravitational energy term\&. "
.ti -1c
.RI "\fBQuadratureTermOptions\fP \fBpressure_integral\fP"
.br
.RI "The quadrature term options for the pressure integral term\&. "
.ti -1c
.RI "\fBQuadratureTermOptions\fP \fBpressure_force\fP"
.br
.RI "The quadrature term options for the pressure force term\&. "
.ti -1c
.RI "\fBQuadratureTermOptions\fP \fBvirial\fP"
.br
.RI "The quadrature term options for the virial term\&. "
.ti -1c
.RI "\fBQuadratureTermOptions\fP \fBerror_norm\fP"
.br
.RI "The quadrature term options for the error norm term\&. "
.ti -1c
.RI "\fBQuadratureRoleOptions\fP \fBroles\fP"
.br
.RI "The quadrature role options for each quadrature role\&. "
.ti -1c
.RI "std::vector< int > \fBconvergence_boosts\fP = {0, 2, 4}"
.br
.RI "The set of convergence boosts used for a tests (only used when the quadrature system is in convergence mode)\&. "
.ti -1c
.RI "\fBQuadratureManifestOptions\fP \fBmanifest\fP"
.br
.RI "The quadrature manifest options for the quadrature system\&. This contains flags for enabling the manifest, including repeated queries, and an optional output file\&. "
.ti -1c
.RI "\fBQuadratureValidationOptions\fP \fBvalidation\fP"
.br
.RI "The quadrature validation options for the quadrature system\&. This contains flags for requiring explicit base orders and MFEM rules, rejecting negative boosts, and reporting unused overrides\&. "
.in -1c
.SH "Detailed Description"
.PP
A struct to hold the options for the quadrature system\&. This contains the mode, global boost, fallback fixed order, quadrature term options for each term, quadrature role options, convergence boosts, quadrature manifest options, and quadrature validation options\&.
.SH "Member Data Documentation"
.PP
.SS "\fBQuadratureTermOptions\fP serif::discretization::quadrature::QuadratureOptions::center_of_mass"
.PP
The quadrature term options for the center of mass term\&.
.SS "\fBQuadratureTermOptions\fP serif::discretization::quadrature::QuadratureOptions::centrifugal"
.PP
The quadrature term options for the centrifugal term\&.
.SS "std::vector<int> serif::discretization::quadrature::QuadratureOptions::convergence_boosts = {0, 2, 4}"
.PP
The set of convergence boosts used for a tests (only used when the quadrature system is in convergence mode)\&.
.SS "\fBQuadratureTermOptions\fP serif::discretization::quadrature::QuadratureOptions::density_projection"
.PP
The quadrature term options for the density projection term\&.
.SS "\fBQuadratureTermOptions\fP serif::discretization::quadrature::QuadratureOptions::eos_closure"
.PP
The quadrature term options for the EOS closure term\&.
.SS "\fBQuadratureTermOptions\fP serif::discretization::quadrature::QuadratureOptions::error_norm"
.PP
The quadrature term options for the error norm term\&.
.SS "std::optional<int> serif::discretization::quadrature::QuadratureOptions::fallback_fixed_order"
.PP
The fallback fixed order for the quadrature rule\&. This is used if no other order is specified\&.
.SS "int serif::discretization::quadrature::QuadratureOptions::global_boost = 0"
.PP
The global boost to the order of the quadrature rule\&. This is added to the default order determined by the form and role\&. Note that different systems have different accuracy requirements and should generally use the lowest order that is sufficient for their needs\&.
.SS "\fBQuadratureTermOptions\fP serif::discretization::quadrature::QuadratureOptions::gravitational_energy"
.PP
The quadrature term options for the gravitational energy term\&.
.SS "\fBQuadratureTermOptions\fP serif::discretization::quadrature::QuadratureOptions::gravity_boundary"
.PP
The quadrature term options for the gravity boundary term\&.
.SS "\fBQuadratureTermOptions\fP serif::discretization::quadrature::QuadratureOptions::gravity_divergence"
.PP
The quadrature term options for the gravity divergence term\&.
.SS "\fBQuadratureTermOptions\fP serif::discretization::quadrature::QuadratureOptions::gravity_force"
.PP
The quadrature term options for the gravity force term\&.
.SS "\fBQuadratureTermOptions\fP serif::discretization::quadrature::QuadratureOptions::gravity_hdiv_mass"
.PP
The quadrature term options for the gravity H(div) mass term\&.
.SS "\fBQuadratureTermOptions\fP serif::discretization::quadrature::QuadratureOptions::gravity_source"
.PP
The quadrature term options for the gravity source term\&.
.SS "\fBQuadratureTermOptions\fP serif::discretization::quadrature::QuadratureOptions::hydrostatic_equilibrium"
.PP
The quadrature term options for the hydrostatic equilibrium term\&.
.SS "\fBQuadratureTermOptions\fP serif::discretization::quadrature::QuadratureOptions::isobaric_surface"
.PP
The quadrature term options for the isobaric surface term\&.
.SS "\fBQuadratureManifestOptions\fP serif::discretization::quadrature::QuadratureOptions::manifest"
.PP
The quadrature manifest options for the quadrature system\&. This contains flags for enabling the manifest, including repeated queries, and an optional output file\&.
.SS "\fBQuadratureTermOptions\fP serif::discretization::quadrature::QuadratureOptions::mass_conservation"
.PP
The quadrature term options for the mass conservation term\&.
.SS "\fBQuadratureTermOptions\fP serif::discretization::quadrature::QuadratureOptions::mass_normalization"
.PP
The quadrature term options for the mass normalization term\&.
.SS "\fBQuadratureTermOptions\fP serif::discretization::quadrature::QuadratureOptions::mesh_extension"
.PP
The quadrature term options for the mesh extension term\&.
.SS "\fBMode\fP serif::discretization::quadrature::QuadratureOptions::mode = \fBMode::production\fP"
.PP
The mode of the quadrature system\&. This determines the level of accuracy and speed of the quadrature system\&.
.SS "\fBQuadratureTermOptions\fP serif::discretization::quadrature::QuadratureOptions::pressure_force"
.PP
The quadrature term options for the pressure force term\&.
.SS "\fBQuadratureTermOptions\fP serif::discretization::quadrature::QuadratureOptions::pressure_integral"
.PP
The quadrature term options for the pressure integral term\&.
.SS "\fBQuadratureTermOptions\fP serif::discretization::quadrature::QuadratureOptions::quadrupole"
.PP
The quadrature term options for the quadrupole term\&.
.SS "\fBQuadratureRoleOptions\fP serif::discretization::quadrature::QuadratureOptions::roles"
.PP
The quadrature role options for each quadrature role\&.
.SS "\fBQuadratureValidationOptions\fP serif::discretization::quadrature::QuadratureOptions::validation"
.PP
The quadrature validation options for the quadrature system\&. This contains flags for requiring explicit base orders and MFEM rules, rejecting negative boosts, and reporting unused overrides\&.
.SS "\fBQuadratureTermOptions\fP serif::discretization::quadrature::QuadratureOptions::virial"
.PP
The quadrature term options for the virial term\&.
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.