102 lines
1.9 KiB
Groff
102 lines
1.9 KiB
Groff
|
|
.TH "serif" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
||
|
|
.ad l
|
||
|
|
.nh
|
||
|
|
.SH NAME
|
||
|
|
serif
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.br
|
||
|
|
.PP
|
||
|
|
.SS "Namespaces"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "namespace \fBbackend\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "namespace \fBcompile_time_checks\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "namespace \fBdimensions\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "namespace \fBdiscretization\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "namespace \fBeos\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "namespace \fBequations\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "namespace \fBgeometry\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "namespace \fBmapping\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "namespace \fBmeta\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "namespace \fBmodel\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "namespace \fBoperators\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "namespace \fBsolver\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "namespace \fButils\fP"
|
||
|
|
.br
|
||
|
|
.in -1c
|
||
|
|
.SS "Typedefs"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "using \fBVector\fP = \fBbackend::mfem::Vector\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "using \fBDenseMatrix\fP = \fBbackend::mfem::DenseMatrix\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "using \fBSparseMatrix\fP = \fBbackend::mfem::SparseMatrix\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "using \fBLinearOperator\fP = \fBbackend::mfem::LinearOperator\fP"
|
||
|
|
.br
|
||
|
|
.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::DenseMatrix\fP = \fBbackend::mfem::DenseMatrix\fP"
|
||
|
|
|
||
|
|
.SS "using \fBserif::LinearOperator\fP = \fBbackend::mfem::LinearOperator\fP"
|
||
|
|
|
||
|
|
.SS "using \fBserif::SparseMatrix\fP = \fBbackend::mfem::SparseMatrix\fP"
|
||
|
|
|
||
|
|
.SS "using \fBserif::Vector\fP = \fBbackend::mfem::Vector\fP"
|
||
|
|
|
||
|
|
.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\&.
|