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)
56 lines
1.7 KiB
Groff
56 lines
1.7 KiB
Groff
.TH "serif::backend::mfem::discretization" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::backend::mfem::discretization
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.SS "Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "template<::serif::discretization::domain::schema::IsSchema SchemaT> \fB::serif::discretization::domain::schema::validation::SchemaValidationResult\fP \fBvalidate_schema\fP (const ::mfem::Mesh &mesh)"
|
|
.br
|
|
.RI "Validate an MFEM mesh against a physical domain schema\&. "
|
|
.ti -1c
|
|
.RI "\fB::serif::discretization::domain::mesh::MeshTopology\fP \fBmake_mesh_topology\fP (const ::mfem::Mesh &mesh)"
|
|
.br
|
|
.RI "Copy MFEM material labels and connectivity into backend-independent topology\&. "
|
|
.in -1c
|
|
.SH "Function Documentation"
|
|
.PP
|
|
.SS "\fBserif::discretization::domain::mesh::MeshTopology\fP serif::backend::mfem::discretization::make_mesh_topology (const ::mfem::Mesh & mesh)\fR [nodiscard]\fP"
|
|
|
|
.PP
|
|
Copy MFEM material labels and connectivity into backend-independent topology\&.
|
|
.SS "template<::serif::discretization::domain::schema::IsSchema SchemaT> \fB::serif::discretization::domain::schema::validation::SchemaValidationResult\fP serif::backend::mfem::discretization::validate_schema (const ::mfem::Mesh & mesh)\fR [nodiscard]\fP"
|
|
|
|
.PP
|
|
Validate an MFEM mesh against a physical domain schema\&.
|
|
.PP
|
|
\fBTemplate Parameters\fP
|
|
.RS 4
|
|
\fISchemaT\fP The schema type to validate against\&.
|
|
.RE
|
|
.PP
|
|
\fBParameters\fP
|
|
.RS 4
|
|
\fImesh\fP The MFEM mesh to validate\&.
|
|
.RE
|
|
.PP
|
|
\fBReturns\fP
|
|
.RS 4
|
|
The validation result for every relation in the schema\&.
|
|
.RE
|
|
.PP
|
|
\fBNote\fP
|
|
.RS 4
|
|
Reuse make_mesh_topology when several schemas inspect the same mesh\&.
|
|
.RE
|
|
.PP
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|