94 lines
2.7 KiB
Groff
94 lines
2.7 KiB
Groff
|
.TH "src/include/serif/discretization/blocks/system_layout.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
||
|
|
.ad l
|
||
|
|
.nh
|
||
|
|
.SH NAME
|
||
|
|
src/include/serif/discretization/blocks/system_layout.hpp \- Describe the independently ordered physical state and residual coordinates of a discrete system\&. This is an accounting layer to keep index offsets straight in memory\&.
|
||
|
|
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.br
|
||
|
|
.PP
|
||
|
|
\fR#include <array>\fP
|
||
|
|
.br
|
||
|
|
\fR#include <cstddef>\fP
|
||
|
|
.br
|
||
|
|
\fR#include <span>\fP
|
||
|
|
.br
|
||
|
|
\fR#include <type_traits>\fP
|
||
|
|
.br
|
||
|
|
\fR#include 'serif/discretization/blocks/base\&.hpp'\fP
|
||
|
|
.br
|
||
|
|
\fR#include 'serif/utils/dependencies/key_list_operations\&.hpp'\fP
|
||
|
|
.br
|
||
|
|
|
||
|
|
.SS "Classes"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "struct \fBserif::discretization::blocks::SystemLayout< ValuesT, ResidualsT >\fP"
|
||
|
|
.br
|
||
|
|
.RI "Describe the independently ordered physical state and residual coordinates of a discrete system\&. "
|
||
|
|
.in -1c
|
||
|
|
.SS "Namespaces"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "namespace \fBserif\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "namespace \fBserif::discretization\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "namespace \fBserif::discretization::blocks\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "namespace \fBserif::discretization::blocks::detail\fP"
|
||
|
|
.br
|
||
|
|
.in -1c
|
||
|
|
.SS "Concepts"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "concept \fBserif::discretization::blocks::SystemLayoutType\fP"
|
||
|
|
.br
|
||
|
|
.RI "Compile time check for a SystemLayout type, e\&.g\&. SystemLayout<Values, Residuals>\&. "
|
||
|
|
.in -1c
|
||
|
|
.SS "Functions"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "std::size_t \fBserif::discretization::blocks::checked_block_size\fP (std::span< const std::size_t > sizes)"
|
||
|
|
.br
|
||
|
|
.RI "Sum some memory span with checking for if any element is too large to fit in a size_t\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "template<SystemLayoutType Layout, typename SizeResolver> constexpr std::remove_cvref_t< Layout > \fBserif::discretization::blocks::make_system_layout\fP (const SizeResolver &size)"
|
||
|
|
.br
|
||
|
|
.RI "Build both coordinate orderings from the same physical size resolver\&. "
|
||
|
|
.in -1c
|
||
|
|
.SS "Variables"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "template<typename Candidate> constexpr bool \fBserif::discretization::blocks::detail::is_system_layout\fP = false"
|
||
|
|
.br
|
||
|
|
.RI "Default false specialization for is_system_layout, specialized to true for \fBSystemLayout<Values, Residuals>\fP\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "template<typename Values, typename Residuals> constexpr bool \fBserif::discretization::blocks::detail::is_system_layout< SystemLayout< Values, Residuals > >\fP = true"
|
||
|
|
.br
|
||
|
|
.RI "True specialization for is_system_layout, specialized to true for \fBSystemLayout<Values, Residuals>\fP\&. "
|
||
|
|
.in -1c
|
||
|
|
.SH "Detailed Description"
|
||
|
|
.PP
|
||
|
|
Describe the independently ordered physical state and residual coordinates of a discrete system\&. This is an accounting layer to keep index offsets straight in memory\&.
|
||
|
|
|
||
|
|
|
||
|
|
.PP
|
||
|
|
\fBAuthor\fP
|
||
|
|
.RS 4
|
||
|
|
Emily M\&. Boudreaux
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
|
||
|
|
.SH "Author"
|
||
|
|
.PP
|
||
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|