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)
63 lines
1.7 KiB
Groff
63 lines
1.7 KiB
Groff
.TH "src/include/serif/backend/mfem/shared/parallel.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/include/serif/backend/mfem/shared/parallel.hpp
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include <exception>\fP
|
|
.br
|
|
\fR#include <vector>\fP
|
|
.br
|
|
|
|
.SS "Namespaces"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "namespace \fBmfem\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::utils\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::utils::parallel\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::utils::parallel::detail\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Typedefs"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "using \fBserif::utils::parallel::detail::Body\fP = void (*)(void* context, int index, int worker)"
|
|
.br
|
|
.in -1c
|
|
.SS "Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "int \fBserif::utils::parallel::worker_count\fP () noexcept"
|
|
.br
|
|
.RI "Workers an element loop may use: OpenMP's thread limit (OMP_NUM_THREADS), or 1 without OpenMP or inside an enclosing parallel region\&. "
|
|
.ti -1c
|
|
.RI "void \fBserif::utils::parallel::detail::run\fP (int count, void *context, \fBBody\fP body)"
|
|
.br
|
|
.RI "Run body for every index; body must not throw\&. Compiled in libserif so OpenMP never depends on the caller's flags\&. "
|
|
.ti -1c
|
|
.RI "template<typename BodyT> void \fBserif::utils::parallel::for_each_index\fP (const int count, BodyT &&body)"
|
|
.br
|
|
.RI "Call body(index, worker) once for every index in [0, count), possibly concurrently\&. "
|
|
.ti -1c
|
|
.RI "void \fBserif::utils::parallel::element_transformation\fP (const ::mfem::Mesh &mesh, int element, ::mfem::IsoparametricTransformation &transformation)"
|
|
.br
|
|
.RI "Mesh::GetElementTransformation(element, transformation), safe in concurrent element loops\&. "
|
|
.in -1c
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|