114 lines
5.5 KiB
Groff
114 lines
5.5 KiB
Groff
|
.TH "serif::operators::LinearizedSystemView< Layout, Blocks >" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
||
|
|
.ad l
|
||
|
|
.nh
|
||
|
|
.SH NAME
|
||
|
|
serif::operators::LinearizedSystemView< Layout, Blocks > \- Borrow an accepted collection of physical blocks and its independently ordered system layout\&.
|
||
|
|
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.br
|
||
|
|
.PP
|
||
|
|
.PP
|
||
|
|
\fR#include <linearized_system_view\&.hpp>\fP
|
||
|
|
.SS "Public Types"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "using \fBLayoutType\fP = std::remove_cvref_t<Layout>"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "using \fBBlockSources\fP = std::remove_cvref_t<Blocks>"
|
||
|
|
.br
|
||
|
|
.in -1c
|
||
|
|
.SS "Public Member Functions"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "\fBLinearizedSystemView\fP (const \fBLayoutType\fP &\fBlayout\fP, const \fBBlockSources\fP &\fBblocks\fP)"
|
||
|
|
.br
|
||
|
|
.RI "Both owners must outlive the view and remain at this accepted linearization while it is used\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "\fBLinearizedSystemView\fP (const \fBLayoutType\fP &&, const \fBBlockSources\fP &)=delete"
|
||
|
|
.br
|
||
|
|
.RI "A borrowed system cannot retain temporary coordinate metadata\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "\fBLinearizedSystemView\fP (const \fBLayoutType\fP &, const \fBBlockSources\fP &&)=delete"
|
||
|
|
.br
|
||
|
|
.RI "A borrowed system cannot retain temporary block sources\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "template<typename Rows, typename Values>
|
||
|
|
.br
|
||
|
|
requires utils::dependencies::BindingsWithBinding<typename BlockSources::Bindings, \fBPhysicalBlock\fP<Rows, Values>>const auto & \fBblock\fP () const"
|
||
|
|
.br
|
||
|
|
.RI "Access a declared physical coupling; absent blocks are compile-time errors\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "const \fBLayoutType\fP & \fBlayout\fP () const noexcept"
|
||
|
|
.br
|
||
|
|
.RI "Access the shared coordinate description without taking ownership\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "const \fBBlockSources\fP & \fBblocks\fP () const noexcept"
|
||
|
|
.br
|
||
|
|
.RI "Supply accepted block sources to ordinary dependency preparation\&. "
|
||
|
|
.in -1c
|
||
|
|
.SS "Private Attributes"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "const \fBLayoutType\fP & \fBm_layout\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "const \fBBlockSources\fP & \fBm_blocks\fP"
|
||
|
|
.br
|
||
|
|
.in -1c
|
||
|
|
.SH "Detailed Description"
|
||
|
|
.PP
|
||
|
|
|
||
|
|
.SS "template<discretization::blocks::SystemLayoutType Layout, utils::dependencies::IsDependencyContext Blocks>
|
||
|
|
.br
|
||
|
|
class serif::operators::LinearizedSystemView< Layout, Blocks >"Borrow an accepted collection of physical blocks and its independently ordered system layout\&.
|
||
|
|
.SH "Member Typedef Documentation"
|
||
|
|
.PP
|
||
|
|
.SS "template<discretization::blocks::SystemLayoutType Layout, utils::dependencies::IsDependencyContext Blocks> using \fBserif::operators::LinearizedSystemView\fP< Layout, Blocks >::BlockSources = std::remove_cvref_t<Blocks>"
|
||
|
|
|
||
|
|
.SS "template<discretization::blocks::SystemLayoutType Layout, utils::dependencies::IsDependencyContext Blocks> using \fBserif::operators::LinearizedSystemView\fP< Layout, Blocks >::LayoutType = std::remove_cvref_t<Layout>"
|
||
|
|
|
||
|
|
.SH "Constructor & Destructor Documentation"
|
||
|
|
.PP
|
||
|
|
.SS "template<discretization::blocks::SystemLayoutType Layout, utils::dependencies::IsDependencyContext Blocks> \fBserif::operators::LinearizedSystemView\fP< Layout, Blocks >::LinearizedSystemView (const \fBLayoutType\fP & layout, const \fBBlockSources\fP & blocks)\fR [inline]\fP"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
Both owners must outlive the view and remain at this accepted linearization while it is used\&.
|
||
|
|
.SS "template<discretization::blocks::SystemLayoutType Layout, utils::dependencies::IsDependencyContext Blocks> \fBserif::operators::LinearizedSystemView\fP< Layout, Blocks >::LinearizedSystemView (const \fBLayoutType\fP && , const \fBBlockSources\fP & )\fR [delete]\fP"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
A borrowed system cannot retain temporary coordinate metadata\&.
|
||
|
|
.SS "template<discretization::blocks::SystemLayoutType Layout, utils::dependencies::IsDependencyContext Blocks> \fBserif::operators::LinearizedSystemView\fP< Layout, Blocks >::LinearizedSystemView (const \fBLayoutType\fP & , const \fBBlockSources\fP && )\fR [delete]\fP"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
A borrowed system cannot retain temporary block sources\&.
|
||
|
|
.SH "Member Function Documentation"
|
||
|
|
.PP
|
||
|
|
.SS "template<discretization::blocks::SystemLayoutType Layout, utils::dependencies::IsDependencyContext Blocks> template<typename Rows, typename Values>
|
||
|
|
.br
|
||
|
|
requires utils::dependencies::BindingsWithBinding<typename BlockSources::Bindings, \fBPhysicalBlock\fP<Rows, Values>>const auto & \fBserif::operators::LinearizedSystemView\fP< Layout, Blocks >::block () const\fR [inline]\fP, \fR [nodiscard]\fP"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
Access a declared physical coupling; absent blocks are compile-time errors\&.
|
||
|
|
.SS "template<discretization::blocks::SystemLayoutType Layout, utils::dependencies::IsDependencyContext Blocks> const \fBBlockSources\fP & \fBserif::operators::LinearizedSystemView\fP< Layout, Blocks >::blocks () const\fR [inline]\fP, \fR [nodiscard]\fP, \fR [noexcept]\fP"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
Supply accepted block sources to ordinary dependency preparation\&.
|
||
|
|
.SS "template<discretization::blocks::SystemLayoutType Layout, utils::dependencies::IsDependencyContext Blocks> const \fBLayoutType\fP & \fBserif::operators::LinearizedSystemView\fP< Layout, Blocks >::layout () const\fR [inline]\fP, \fR [nodiscard]\fP, \fR [noexcept]\fP"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
Access the shared coordinate description without taking ownership\&.
|
||
|
|
.SH "Member Data Documentation"
|
||
|
|
.PP
|
||
|
|
.SS "template<discretization::blocks::SystemLayoutType Layout, utils::dependencies::IsDependencyContext Blocks> const \fBBlockSources\fP& \fBserif::operators::LinearizedSystemView\fP< Layout, Blocks >::m_blocks\fR [private]\fP"
|
||
|
|
|
||
|
|
.SS "template<discretization::blocks::SystemLayoutType Layout, utils::dependencies::IsDependencyContext Blocks> const \fBLayoutType\fP& \fBserif::operators::LinearizedSystemView\fP< Layout, Blocks >::m_layout\fR [private]\fP"
|
||
|
|
|
||
|
|
|
||
|
|
.SH "Author"
|
||
|
|
.PP
|
||
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|