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)
150 lines
5.4 KiB
Groff
150 lines
5.4 KiB
Groff
.TH "serif::discretization::quadrature::backend::mfem" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::discretization::quadrature::backend::mfem
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "struct \fBMFEMOperandListOrder\fP"
|
|
.br
|
|
.RI "A helper struct to compute the static order of an MFEM integrator for a given list of operands\&. "
|
|
.ti -1c
|
|
.RI "struct \fBMFEMOperandListOrder< utils::types::TypeList< OperandTs\&.\&.\&. > >\fP"
|
|
.br
|
|
.RI "A specialization of the \fBMFEMOperandListOrder\fP struct for a list of operand types\&. This struct is used to compute the static order of an MFEM integrator for a given list of operands\&. "
|
|
.ti -1c
|
|
.RI "struct \fBMFEMQuadratureContext\fP"
|
|
.br
|
|
.RI "The \fBMFEMQuadratureContext\fP struct is used to describe the context in which we are trying to resolve an MFEM integration rule\&. This includes the geometry type, the order of the geometry weight, any dynamic orders, the domain or set of domains, and the mapping kind\&. "
|
|
.ti -1c
|
|
.RI "class \fBMFEMResolver\fP"
|
|
.br
|
|
.RI "The \fBMFEMResolver\fP class is used to resolve the appropriate MFEM integration rule for a given quadrature context\&. It uses a policy to determine the appropriate order and other relevant information for the integration rule\&. "
|
|
.ti -1c
|
|
.RI "struct \fBMFEMRule\fP"
|
|
.br
|
|
.RI "The \fBMFEMRule\fP struct is used to describe the result of resolving an MFEM integration rule\&. This includes the resolution (which contains the order and any other relevant information) and a pointer to the integration rule itself\&. "
|
|
.in -1c
|
|
.SS "Concepts"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "concept \fBHasReferenceSetIntegrationRule\fP"
|
|
.br
|
|
.RI "A HasReferenceSetIntegrationRule is an integrator that can be configured with a reference to an integration rule\&. "
|
|
.ti -1c
|
|
.RI "concept \fBHasPointerSetIntegrationRule\fP"
|
|
.br
|
|
.RI "A HasPointerSetIntegrationRule is an integrator that can be configured with a pointer to an integration rule\&. "
|
|
.ti -1c
|
|
.RI "concept \fBHasSetIntRule\fP"
|
|
.br
|
|
.RI "A HasSetIntRule is an integrator that can be configured with an integration rule by value\&. "
|
|
.ti -1c
|
|
.RI "concept \fBConfigurableIntegrator\fP"
|
|
.br
|
|
.RI "A ConfigurableIntegrator is an integrator that can be configured with an integration rule in some way (either by reference, by pointer, or by value)\&. "
|
|
.in -1c
|
|
.SS "Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "template<ConfigurableIntegrator IntegratorT> void \fBset_integration_rule\fP (IntegratorT &integrator, const ::mfem::IntegrationRule &integration_rule)"
|
|
.br
|
|
.RI "Configure an MFEM integrator with an integration rule\&. This function will call the appropriate SetIntegrationRule method on the integrator based on its capabilities\&. "
|
|
.ti -1c
|
|
.RI "template<forms::IsOperand OperandT> consteval int \fBresolve_operand_order\fP () noexcept"
|
|
.br
|
|
.RI "A function to resolve the static order of an MFEM integrator for a given operand type\&. "
|
|
.ti -1c
|
|
.RI "int \fBsum_dynamic_orders\fP (const std::span< const int > dynamic_orders)"
|
|
.br
|
|
.RI "Sums the dynamic orders in a span of integers\&. "
|
|
.in -1c
|
|
.SS "Variables"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "template<forms::Form FormT> constexpr int \fBmfem_form_static_order\fP = \fBMFEMOperandListOrder\fP<typename FormT::operand_types>::value"
|
|
.br
|
|
.RI "A trait to determine the static order of an MFEM integrator for a given form type\&. "
|
|
.in -1c
|
|
.SH "Function Documentation"
|
|
.PP
|
|
.SS "template<forms::IsOperand OperandT> int serif::discretization::quadrature::backend::mfem::resolve_operand_order ()\fR [nodiscard]\fP, \fR [consteval]\fP, \fR [noexcept]\fP"
|
|
|
|
.PP
|
|
A function to resolve the static order of an MFEM integrator for a given operand type\&.
|
|
.PP
|
|
\fBTemplate Parameters\fP
|
|
.RS 4
|
|
\fIOperandT\fP The operand type to resolve the static order for\&.
|
|
.RE
|
|
.PP
|
|
\fBReturns\fP
|
|
.RS 4
|
|
The static order of the MFEM integrator for the given operand type\&.
|
|
.RE
|
|
.PP
|
|
\fBTodo\fP
|
|
.RS 4
|
|
We already have some of this information in the form_traits file, we should probably extract the order boost from there\&.
|
|
.RE
|
|
.PP
|
|
|
|
.SS "template<ConfigurableIntegrator IntegratorT> void serif::discretization::quadrature::backend::mfem::set_integration_rule (IntegratorT & integrator, const ::mfem::IntegrationRule & integration_rule)"
|
|
|
|
.PP
|
|
Configure an MFEM integrator with an integration rule\&. This function will call the appropriate SetIntegrationRule method on the integrator based on its capabilities\&.
|
|
.PP
|
|
\fBTemplate Parameters\fP
|
|
.RS 4
|
|
\fIIntegratorT\fP The type of the integrator to configure\&.
|
|
.RE
|
|
.PP
|
|
\fBParameters\fP
|
|
.RS 4
|
|
\fIintegrator\fP The integrator to configure\&.
|
|
.br
|
|
\fIintegration_rule\fP The integration rule to use for configuration\&.
|
|
.RE
|
|
.PP
|
|
|
|
.SS "int serif::discretization::quadrature::backend::mfem::sum_dynamic_orders (const std::span< const int > dynamic_orders)\fR [inline]\fP, \fR [nodiscard]\fP"
|
|
|
|
.PP
|
|
Sums the dynamic orders in a span of integers\&.
|
|
.PP
|
|
\fBParameters\fP
|
|
.RS 4
|
|
\fIdynamic_orders\fP The span of dynamic orders to sum\&.
|
|
.RE
|
|
.PP
|
|
\fBReturns\fP
|
|
.RS 4
|
|
The sum of the dynamic orders\&.
|
|
.RE
|
|
.PP
|
|
|
|
.SH "Variable Documentation"
|
|
.PP
|
|
.SS "template<forms::Form FormT> int serif::discretization::quadrature::backend::mfem::mfem_form_static_order = \fBMFEMOperandListOrder\fP<typename FormT::operand_types>::value\fR [inline]\fP, \fR [constexpr]\fP"
|
|
|
|
.PP
|
|
A trait to determine the static order of an MFEM integrator for a given form type\&.
|
|
.PP
|
|
\fBTemplate Parameters\fP
|
|
.RS 4
|
|
\fIFormT\fP The form type to check\&.
|
|
.RE
|
|
.PP
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|