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

96 lines
5.0 KiB
Groff
Raw Normal View History

.TH "src/include/serif/backend/mfem/operators/volume_inputs.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include/serif/backend/mfem/operators/volume_inputs.hpp
.SH SYNOPSIS
.br
.PP
\fR#include 'serif/backend/mfem/operators/volume_data\&.hpp'\fP
.br
\fR#include 'serif/backend/mfem/discretization/coefficient_tracking\&.hpp'\fP
.br
.SS "Classes"
.in +1c
.ti -1c
.RI "struct \fBserif::operators::backend::mfem::MetadataTracking\fP"
.br
.RI "Validate external mesh resources before the graph compares their metadata\&. "
.ti -1c
.RI "struct \fBserif::operators::backend::mfem::DisplacementCoefficients\fP"
.br
.ti -1c
.RI "struct \fBserif::operators::backend::mfem::CompactificationCoefficients\fP"
.br
.ti -1c
.RI "struct \fBserif::operators::backend::mfem::CoefficientTracking\fP"
.br
.RI "Track coefficient values using an owned snapshot and the identity of their binding\&. "
.in -1c
.SS "Namespaces"
.in +1c
.ti -1c
.RI "namespace \fBserif\fP"
.br
.ti -1c
.RI "namespace \fBserif::operators\fP"
.br
.ti -1c
.RI "namespace \fBserif::operators::backend\fP"
.br
.ti -1c
.RI "namespace \fBserif::operators::backend::mfem\fP"
.br
.in -1c
.SS "Typedefs"
.in +1c
.ti -1c
.RI "using \fBserif::operators::backend::mfem::MeshAndCoefficientBindings\fP = \fBvolume_keys::Scoped\fP<void>::Bindings"
.br
.in -1c
.SS "Functions"
.in +1c
.ti -1c
.RI "template<typename TestT, typename SchemaT> void \fBserif::operators::backend::mfem::validate_volume_discretization\fP (const \fBVolumeDiscretization\fP< TestT, SchemaT > &discretization)"
.br
.RI "Check borrowed mesh objects before sampling or applying accepted results\&. "
.ti -1c
.RI "template<VolumeEquation EquationT, typename Scope = void, typename SchemaT, typename CoefficientsT, typename\&.\&.\&. Columns> auto \fBserif::operators::backend::mfem::make_volume_binding_input\fP (const \fBVolumeDiscretization\fP< typename EquationT::Test, SchemaT > &discretization, const CoefficientsT &term_coefficients, \fButils::types::TypeList\fP< Columns\&.\&.\&. >)"
.br
.RI "Validate one equation's bindings without constructing duplicate coefficient resources\&. "
.ti -1c
.RI "template<VolumeEquation EquationT, typename Scope = void, typename SchemaT, typename CoefficientsT> auto \fBserif::operators::backend::mfem::make_volume_binding_input\fP (const \fBVolumeDiscretization\fP< typename EquationT::Test, SchemaT > &discretization, const CoefficientsT &term_coefficients)"
.br
.RI "Share equation metadata with a model's common physical coefficient context\&. "
.ti -1c
.RI "template<VolumeEquation EquationT, typename Scope = void, typename SchemaT, typename CoefficientsT, typename\&.\&.\&. Columns> auto \fBserif::operators::backend::mfem::make_volume_inputs\fP (const \fBVolumeDiscretization\fP< typename EquationT::Test, SchemaT > &discretization, const CoefficientsT &term_coefficients, \fButils::types::TypeList\fP< Columns\&.\&.\&. > columns)"
.br
.RI "Supply precisely the consumed terms for a standalone equation\&. "
.ti -1c
.RI "template<VolumeEquation EquationT, typename Scope = void, typename SchemaT, typename CoefficientsT> auto \fBserif::operators::backend::mfem::make_volume_inputs\fP (const \fBVolumeDiscretization\fP< typename EquationT::Test, SchemaT > &discretization, const CoefficientsT &term_coefficients)"
.br
.RI "Bind equation and reference inputs when displacement will be produced inside the dependency graph\&. "
.ti -1c
.RI "template<VolumeEquation EquationT, typename Scope = void, typename SchemaT, typename CoefficientsT, typename\&.\&.\&. Columns> auto \fBserif::operators::backend::mfem::make_volume_inputs\fP (const \fBVolumeDiscretization\fP< typename EquationT::Test, SchemaT > &discretization, const CoefficientsT &term_coefficients, const \fB::mfem::Vector\fP &displacement_coefficients, \fButils::types::TypeList\fP< Columns\&.\&.\&. > columns)"
.br
.RI "Append a checked external displacement while preserving each original resource's tracking policy\&. "
.ti -1c
.RI "template<VolumeEquation EquationT, typename Scope = void, typename SchemaT, typename CoefficientsT> auto \fBserif::operators::backend::mfem::make_volume_inputs\fP (const \fBVolumeDiscretization\fP< typename EquationT::Test, SchemaT > &discretization, const CoefficientsT &term_coefficients, const \fB::mfem::Vector\fP &displacement_coefficients)"
.br
.RI "Build a checked source context without retaining the coefficient vectors\&. "
.ti -1c
.RI "template<VolumeEquation EquationT, typename Scope = void, typename SchemaT, typename CoefficientsT> void \fBserif::operators::backend::mfem::make_volume_inputs\fP (const \fBVolumeDiscretization\fP< typename EquationT::Test, SchemaT > &, const CoefficientsT &, \fB::mfem::Vector\fP &&)=delete"
.br
.ti -1c
.RI "template<VolumeEquation EquationT, typename Scope = void, typename SchemaT, typename CoefficientsT> void \fBserif::operators::backend::mfem::make_volume_inputs\fP (const \fBVolumeDiscretization\fP< typename EquationT::Test, SchemaT > &, const CoefficientsT &, const \fB::mfem::Vector\fP &&)=delete"
.br
.in -1c
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.