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

84 lines
1.9 KiB
Groff
Raw Normal View History

.TH "serif::backend::mfem" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::backend::mfem
.SH SYNOPSIS
.br
.PP
.SS "Namespaces"
.in +1c
.ti -1c
.RI "namespace \fBdiscretization\fP"
.br
.ti -1c
.RI "namespace \fBserialize\fP"
.br
.ti -1c
.RI "namespace \fBshared\fP"
.br
.in -1c
.SS "Typedefs"
.in +1c
.ti -1c
.RI "using \fBVector\fP = ::mfem::Vector"
.br
.RI "Native owned finite-element coefficients\&. "
.ti -1c
.RI "using \fBDenseMatrix\fP = ::mfem::DenseMatrix"
.br
.RI "Dense element matrices and small systems\&. "
.ti -1c
.RI "using \fBSparseMatrix\fP = ::mfem::SparseMatrix"
.br
.RI "Explicitly assembled sparse matrices\&. "
.ti -1c
.RI "using \fBLinearOperator\fP = ::mfem::Operator"
.br
.RI "Assembled or matrix-free linear actions\&. "
.in -1c
.SS "Functions"
.in +1c
.ti -1c
.RI "void \fBinitialize\fP ()"
.br
.RI "Initialize the selected numerical runtime once, before application work begins\&. "
.in -1c
.SH "Typedef Documentation"
.PP
.SS "using \fBserif::backend::mfem::DenseMatrix\fP = ::mfem::DenseMatrix"
.PP
Dense element matrices and small systems\&.
.SS "using \fBserif::backend::mfem::LinearOperator\fP = ::mfem::Operator"
.PP
Assembled or matrix-free linear actions\&.
.SS "using \fBserif::backend::mfem::SparseMatrix\fP = ::mfem::SparseMatrix"
.PP
Explicitly assembled sparse matrices\&.
.SS "using \fBserif::backend::mfem::Vector\fP = ::mfem::Vector"
.PP
Native owned finite-element coefficients\&.
.SH "Function Documentation"
.PP
.SS "void serif::backend::mfem::initialize ()"
.PP
Initialize the selected numerical runtime once, before application work begins\&.
.PP
\fBNote\fP
.RS 4
Call on the main thread\&. An existing MPI session remains externally owned; a session started here is finalized by MFEM at process exit\&. Serial builds need no initialization\&.
.RE
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.