Files
MeanField_SERiF/docs/man/man3/serif_discretization_domain_relation_Inscribed.3

78 lines
2.6 KiB
Groff
Raw Normal View History

.TH "serif::discretization::domain::relation::Inscribed< A, B >" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::discretization::domain::relation::Inscribed< A, B > \- Compile time type representing the inscribed relation between two domains or sets\&. This relation states that every face of the inner domain (A) that is not interior to A borders the outer domain (B)\&.
.SH SYNOPSIS
.br
.PP
.PP
\fR#include <relations\&.hpp>\fP
.PP
Inherits \fBserif::discretization::domain::relation::DomainRelation\fP\&.
.SS "Public Types"
.in +1c
.ti -1c
.RI "using \fBinner_type\fP = A"
.br
.RI "\fBDomain\fP or \fBDomain\fP Set defining the inner domain (A) in the inscribed relation\&. "
.ti -1c
.RI "using \fBouter_type\fP = B"
.br
.RI "\fBDomain\fP or \fBDomain\fP Set defining the outer domain (B) in the inscribed relation\&. "
.in -1c
.SS "Static Public Attributes"
.in +1c
.ti -1c
.RI "static constexpr std::string_view \fBname\fP = 'inscribed'"
.br
.RI "Compile time name of the relation\&. "
.in -1c
.SH "Detailed Description"
.PP
.SS "template<IsDomainOrSet A, IsDomainOrSet B>
.br
struct serif::discretization::domain::relation::Inscribed< A, B >"Compile time type representing the inscribed relation between two domains or sets\&. This relation states that every face of the inner domain (A) that is not interior to A borders the outer domain (B)\&.
.PP
\fBTemplate Parameters\fP
.RS 4
\fIA\fP The inner domain or set type\&.
.br
\fIB\fP The outer domain or set type\&.
.RE
.PP
This relation is used to define constraints on the mesh, ensuring that the inner domain is fully contained within the outer domain and that their boundaries are properly aligned\&.
.SH "Member Typedef Documentation"
.PP
.SS "template<IsDomainOrSet A, IsDomainOrSet B> using \fBserif::discretization::domain::relation::Inscribed\fP< A, B >::inner_type = A"
.PP
\fBDomain\fP or \fBDomain\fP Set defining the inner domain (A) in the inscribed relation\&.
.SS "template<IsDomainOrSet A, IsDomainOrSet B> using \fBserif::discretization::domain::relation::Inscribed\fP< A, B >::outer_type = B"
.PP
\fBDomain\fP or \fBDomain\fP Set defining the outer domain (B) in the inscribed relation\&.
.SH "Member Data Documentation"
.PP
.SS "template<IsDomainOrSet A, IsDomainOrSet B> std::string_view \fBserif::discretization::domain::relation::Inscribed\fP< A, B >::name = 'inscribed'\fR [static]\fP, \fR [constexpr]\fP"
.PP
Compile time name of the relation\&.
.PP
\fBTodo\fP
.RS 4
we should replace this with our meta library\&.
.RE
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.