Files
MeanField_SERiF/docs/man/man3/inputs.hpp.3

60 lines
2.6 KiB
Groff
Raw Normal View History

.TH "src/include/serif/backend/mfem/model/inputs.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include/serif/backend/mfem/model/inputs.hpp
.SH SYNOPSIS
.br
.PP
\fR#include 'serif/model/plan\&.hpp'\fP
.br
\fR#include 'serif/backend/mfem/operators/volume_inputs\&.hpp'\fP
.br
.SS "Namespaces"
.in +1c
.ti -1c
.RI "namespace \fBserif\fP"
.br
.ti -1c
.RI "namespace \fBserif::model\fP"
.br
.ti -1c
.RI "namespace \fBserif::model::backend\fP"
.br
.ti -1c
.RI "namespace \fBserif::model::backend::mfem\fP"
.br
.ti -1c
.RI "namespace \fBserif::model::backend::mfem::detail\fP"
.br
.in -1c
.SS "Functions"
.in +1c
.ti -1c
.RI "template<typename Discretization, typename Coefficients, typename\&.\&.\&. Terms> void \fBserif::model::backend::mfem::detail::validate_coefficient_owners\fP (const Discretization &discretization, const Coefficients &coefficients, \fButils::dependencies::KeyList\fP< Terms\&.\&.\&. >)"
.br
.RI "Accepted actions may borrow only bindings retained by the declared discretization owner\&. "
.ti -1c
.RI "template<typename Discretization, typename Coefficients, typename\&.\&.\&. Equations, typename\&.\&.\&. Fields> auto \fBserif::model::backend::mfem::detail::model_inputs\fP (const Discretization &discretization, const Coefficients &coefficients, \fButils::types::TypeList\fP< Equations\&.\&.\&. >, \fButils::dependencies::KeyList\fP< Fields\&.\&.\&. >)"
.br
.RI "Bind common physical coefficients once and keep equation-specific metadata distinct\&. "
.ti -1c
.RI "template<ExecutableInteriorEquations Registry, typename Discretization, typename Coefficients> auto \fBserif::model::backend::mfem::make_model_inputs\fP (const Discretization &discretization, const Coefficients &coefficients)"
.br
.RI "Supply the same physical coefficient resources to all explicitly listed interior equations\&. "
.ti -1c
.RI "template<ExecutableInteriorEquations Registry, typename Discretization, typename Coefficients> auto \fBserif::model::backend::mfem::make_model_inputs\fP (const Discretization &discretization, const Coefficients &coefficients, const ::mfem::Vector &displacement)"
.br
.RI "Prepare an interior system with a prescribed displacement field, without adding displacement unknowns\&. "
.ti -1c
.RI "template<typename Registry, typename Discretization, typename Coefficients> void \fBserif::model::backend::mfem::make_model_inputs\fP (const Discretization &, const Coefficients &, const ::mfem::Vector &&)=delete"
.br
.RI "Reject a displacement temporary whose coefficients would expire before graph preparation\&. "
.in -1c
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.