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

41 lines
1.8 KiB
Groff
Raw Normal View History

.TH "serif::discretization::quadrature::RuleControl" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::discretization::quadrature::RuleControl \- A struct to control the behavior of a quadrature rule for a given form or role\&. Rule control always contains boost (default to 0) and may contain some fixed order (think of this as an override)\&. If the fixed order is empty then the quadrature system will determine the order based on the form and role + boost\&.
.SH SYNOPSIS
.br
.PP
.PP
\fR#include <rules\&.hpp>\fP
.SS "Public Attributes"
.in +1c
.ti -1c
.RI "std::optional< int > \fBfixed_order\fP"
.br
.RI "An optional fixed order for the quadrature rule\&. If this is set, it will override the default order determined by the form and role\&. "
.ti -1c
.RI "int \fBboost\fP = 0"
.br
.RI "An additional boost to the order of the quadrature rule\&. This is added to the default order determined by the form and role\&. "
.in -1c
.SH "Detailed Description"
.PP
A struct to control the behavior of a quadrature rule for a given form or role\&. Rule control always contains boost (default to 0) and may contain some fixed order (think of this as an override)\&. If the fixed order is empty then the quadrature system will determine the order based on the form and role + boost\&.
.SH "Member Data Documentation"
.PP
.SS "int serif::discretization::quadrature::RuleControl::boost = 0"
.PP
An additional boost to the order of the quadrature rule\&. This is added to the default order determined by the form and role\&.
.SS "std::optional<int> serif::discretization::quadrature::RuleControl::fixed_order"
.PP
An optional fixed order for the quadrature rule\&. If this is set, it will override the default order determined by the form and role\&.
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.