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)
85 lines
2.1 KiB
Groff
85 lines
2.1 KiB
Groff
.TH "src/include/serif/operators/concepts.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/include/serif/operators/concepts.hpp
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include <concepts>\fP
|
|
.br
|
|
\fR#include <type_traits>\fP
|
|
.br
|
|
\fR#include 'serif/discretization/blocks/traits\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/discretization/functional_space/space\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/equations/concepts\&.hpp'\fP
|
|
.br
|
|
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "struct \fBserif::operators::HasScalarVolumeOperands< EquationT, OperandsT >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::operators::HasScalarVolumeOperands< EquationT, utils::types::TypeList< Operands\&.\&.\&. > >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::operators::VolumeOperands< C, ListT >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::operators::VolumeOperands< C, utils::types::TypeList< O\&.\&.\&. > >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::operators::VolumeContributions< TupleT >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::operators::VolumeContributions< std::tuple< C\&.\&.\&. > >\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Namespaces"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "namespace \fBserif\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::operators\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Concepts"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "concept \fBserif::operators::ScalarValueTerm\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "concept \fBserif::operators::ScalarValueOperand\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "concept \fBserif::operators::ScalarGradientOperand\fP"
|
|
.br
|
|
.RI "A conforming scalar gradient; discontinuous fields also require face terms\&. "
|
|
.ti -1c
|
|
.RI "concept \fBserif::operators::VectorGradientOperand\fP"
|
|
.br
|
|
.RI "Full vector gradients are supported for componentwise H1 fields\&. "
|
|
.ti -1c
|
|
.RI "concept \fBserif::operators::ScalarVolumeEquation\fP"
|
|
.br
|
|
.RI "Equations executable by the current scalar-value volume operator\&. "
|
|
.ti -1c
|
|
.RI "concept \fBserif::operators::MappedOperand\fP"
|
|
.br
|
|
.RI "Mathematical operand combinations implemented by the current volume backend\&. "
|
|
.ti -1c
|
|
.RI "concept \fBserif::operators::VolumeEquation\fP"
|
|
.br
|
|
.RI "One or more supported weak volume contributions assembled into a single residual row\&. "
|
|
.in -1c
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|