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

56 lines
1.7 KiB
Groff
Raw Normal View History

.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\&.