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

68 lines
2.1 KiB
Groff
Raw Normal View History

.TH "serif::discretization::domain::relation::FullyConnected< A >" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::discretization::domain::relation::FullyConnected< A > \- Compile time type representing the fully connected relation for a domain or set\&. This relation states that the domain is a single connected blob of elements, not two separate pieces\&.
.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 \fBdomain_type\fP = A"
.br
.RI "\fBDomain\fP or \fBDomain\fP Set defining the domain in the fully connected relation\&. "
.in -1c
.SS "Static Public Attributes"
.in +1c
.ti -1c
.RI "static constexpr std::string_view \fBname\fP = 'fully_connected'"
.br
.RI "Compile time name of the relation\&. "
.in -1c
.SH "Detailed Description"
.PP
.SS "template<IsDomainOrSet A>
.br
struct serif::discretization::domain::relation::FullyConnected< A >"Compile time type representing the fully connected relation for a domain or set\&. This relation states that the domain is a single connected blob of elements, not two separate pieces\&.
.PP
\fBTemplate Parameters\fP
.RS 4
\fIA\fP The domain or set type\&.
.RE
.PP
This relation is used to define constraints on the mesh, ensuring that the domain is fully connected and does not consist of disjoint parts\&.
.SH "Member Typedef Documentation"
.PP
.SS "template<IsDomainOrSet A> using \fBserif::discretization::domain::relation::FullyConnected\fP< A >::domain_type = A"
.PP
\fBDomain\fP or \fBDomain\fP Set defining the domain in the fully connected relation\&.
.SH "Member Data Documentation"
.PP
.SS "template<IsDomainOrSet A> std::string_view \fBserif::discretization::domain::relation::FullyConnected\fP< A >::name = 'fully_connected'\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\&.