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

132 lines
4.6 KiB
Groff
Raw Normal View History

.TH "serif::discretization::quadrature::Policy" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::discretization::quadrature::Policy \- The \fBPolicy\fP class is used to determine the appropriate order and other relevant information for the integration rule based on a given quadrature query\&. It uses a \fBRuleSet\fP to determine the appropriate order and other relevant information for the integration rule\&.
.SH SYNOPSIS
.br
.PP
.PP
\fR#include <policy\&.hpp>\fP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBPolicy\fP (\fBRuleSet\fP ruleSet)"
.br
.RI "Constructs a \fBPolicy\fP with the given \fBRuleSet\fP\&. "
.ti -1c
.RI "\fBResolution\fP \fBresolve\fP (const \fBQuery\fP &query) const"
.br
.RI "Resolves the appropriate order and other relevant information for the integration rule based on the given quadrature query\&. "
.ti -1c
.RI "const \fBRuleSet\fP & \fBrules\fP () const noexcept"
.br
.RI "Inspect the authored quadrature controls without changing preparation\&. "
.in -1c
.SS "Private Member Functions"
.in +1c
.ti -1c
.RI "const \fBRuleControl\fP & \fBget_role_control\fP (\fBQuadratureRole\fP role) const"
.br
.RI "Retrieves the \fBRuleControl\fP for the given quadrature role\&. This is used to determine the appropriate order and other relevant information for the integration rule\&. "
.in -1c
.SS "Static Private Member Functions"
.in +1c
.ti -1c
.RI "static int \fBcompute_base_order\fP (const \fBQuery\fP &query)"
.br
.RI "Computes the base order for the given quadrature query\&. This is used to determine the appropriate order for the integration rule\&. "
.in -1c
.SS "Private Attributes"
.in +1c
.ti -1c
.RI "\fBRuleSet\fP \fBm_ruleSet\fP"
.br
.RI "The \fBRuleSet\fP used to determine the appropriate order and other relevant information for the integration rule\&. "
.in -1c
.SH "Detailed Description"
.PP
The \fBPolicy\fP class is used to determine the appropriate order and other relevant information for the integration rule based on a given quadrature query\&. It uses a \fBRuleSet\fP to determine the appropriate order and other relevant information for the integration rule\&.
.SH "Constructor & Destructor Documentation"
.PP
.SS "serif::discretization::quadrature::Policy::Policy (\fBRuleSet\fP ruleSet)\fR [explicit]\fP"
.PP
Constructs a \fBPolicy\fP with the given \fBRuleSet\fP\&.
.PP
\fBParameters\fP
.RS 4
\fIruleSet\fP The \fBRuleSet\fP used to determine the appropriate order and other relevant information for the integration rule\&.
.RE
.PP
.SH "Member Function Documentation"
.PP
.SS "int serif::discretization::quadrature::Policy::compute_base_order (const \fBQuery\fP & query)\fR [static]\fP, \fR [nodiscard]\fP, \fR [private]\fP"
.PP
Computes the base order for the given quadrature query\&. This is used to determine the appropriate order for the integration rule\&.
.PP
\fBParameters\fP
.RS 4
\fIquery\fP The quadrature query used to determine the base order\&.
.RE
.PP
\fBReturns\fP
.RS 4
The base order for the given quadrature query\&.
.RE
.PP
.SS "const \fBRuleControl\fP & serif::discretization::quadrature::Policy::get_role_control (\fBQuadratureRole\fP role) const\fR [nodiscard]\fP, \fR [private]\fP"
.PP
Retrieves the \fBRuleControl\fP for the given quadrature role\&. This is used to determine the appropriate order and other relevant information for the integration rule\&.
.PP
\fBParameters\fP
.RS 4
\fIrole\fP The quadrature role used to retrieve the \fBRuleControl\fP\&.
.RE
.PP
\fBReturns\fP
.RS 4
The \fBRuleControl\fP for the given quadrature role\&.
.RE
.PP
.SS "\fBResolution\fP serif::discretization::quadrature::Policy::resolve (const \fBQuery\fP & query) const\fR [nodiscard]\fP"
.PP
Resolves the appropriate order and other relevant information for the integration rule based on the given quadrature query\&.
.PP
\fBParameters\fP
.RS 4
\fIquery\fP The quadrature query used to determine the appropriate order and other relevant information for the integration rule\&.
.RE
.PP
\fBReturns\fP
.RS 4
The resolution containing the appropriate order and other relevant information for the integration rule\&.
.RE
.PP
.SS "const \fBRuleSet\fP & serif::discretization::quadrature::Policy::rules () const\fR [inline]\fP, \fR [nodiscard]\fP, \fR [noexcept]\fP"
.PP
Inspect the authored quadrature controls without changing preparation\&.
.SH "Member Data Documentation"
.PP
.SS "\fBRuleSet\fP serif::discretization::quadrature::Policy::m_ruleSet\fR [private]\fP"
.PP
The \fBRuleSet\fP used to determine the appropriate order and other relevant information for the integration rule\&.
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.