Emily Boudreaux
6b57738330
Note for now much of the docs is LLM written. This was done to save time and focus on code development. The docs have been LOOSLEY reviewed. However, the code itself has been either fully written by hand or fully reviewed. Therefore, the docs should at the moment be seen as a loose resource rather than authoratiative (and this is on top of the general ability for docs to drift)
157 lines
5.7 KiB
Groff
157 lines
5.7 KiB
Groff
.TH "src/include/serif/backend/mfem/operators/volume_data.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/include/serif/backend/mfem/operators/volume_data.hpp
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include <array>\fP
|
|
.br
|
|
\fR#include <memory>\fP
|
|
.br
|
|
\fR#include <vector>\fP
|
|
.br
|
|
\fR#include 'mfem/fem/gridfunc\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/backend/mfem/mapping/domain_mapper\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/backend/mfem/discretization/term_coefficients\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/backend/mfem/operators/element_data\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/backend/mfem/operators/quadrature\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/backend/mfem/operators/workspace\&.hpp'\fP
|
|
.br
|
|
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "struct \fBserif::operators::backend::mfem::volume_keys::Scoped< Scope >\fP"
|
|
.br
|
|
.RI "Keep equation-local stages distinct while sharing physical coefficient sources\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::operators::backend::mfem::volume_keys::Scoped< Scope >::Basis< Contribution >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::operators::backend::mfem::volume_keys::Scoped< Scope >::Geometry< Contribution >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::operators::backend::mfem::volume_keys::Scoped< Scope >::ReferenceValues< Contribution, OperandT >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::operators::backend::mfem::volume_keys::Scoped< Scope >::PhysicalValues< Contribution, OperandT >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::operators::backend::mfem::volume_keys::Scoped< Scope >::QuadratureLinearization< Contribution >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::operators::backend::mfem::volume_keys::Scoped< Scope >::GeometryDerivatives< Contribution >\fP"
|
|
.br
|
|
.RI "Weighted local displacement derivatives, owned and invalidated by the graph\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::operators::backend::mfem::volume_keys::Scoped< Scope >::Linearization\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::operators::backend::mfem::volume_keys::Scoped< Scope >::Bindings\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::operators::backend::mfem::BasisBindings< ColumnCount >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::operators::backend::mfem::VolumeDiscretization< TestT, SchemaT >\fP"
|
|
.br
|
|
.RI "Borrowed discretization objects must outlive their graph and its accepted results\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::operators::backend::mfem::VolumeOptions\fP"
|
|
.br
|
|
.RI "Numerical choices fixed when the graph is constructed\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::operators::backend::mfem::OperandSamples\fP"
|
|
.br
|
|
.RI "Reference samples remain available for derivatives through the physical mapping\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::operators::backend::mfem::ContributionData< OperandCount >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::operators::backend::mfem::VolumeConfiguration< EquationT, SchemaT >\fP"
|
|
.br
|
|
.RI "Stable equation ownership also retains temporary and move-only contribution trees\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::operators::backend::mfem::VolumeData< EquationT, SchemaT >\fP"
|
|
.br
|
|
.RI "One accepted result contains ordered contribution batches and the assembled residual\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::operators::backend::mfem::VolumeScratch\fP"
|
|
.br
|
|
.RI "Scratch belongs to graph callables and is never a dependency source\&. "
|
|
.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
|
|
.ti -1c
|
|
.RI "namespace \fBserif::operators::backend::mfem::volume_keys\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Typedefs"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "template<std::size_t Contribution> using \fBserif::operators::backend::mfem::volume_keys::Basis\fP = \fBScoped\fP<void>::Basis<Contribution>"
|
|
.br
|
|
.ti -1c
|
|
.RI "template<std::size_t Contribution> using \fBserif::operators::backend::mfem::volume_keys::Geometry\fP = \fBScoped\fP<void>::Geometry<Contribution>"
|
|
.br
|
|
.ti -1c
|
|
.RI "template<std::size_t Contribution, typename OperandT> using \fBserif::operators::backend::mfem::volume_keys::ReferenceValues\fP = \fBScoped\fP<void>::ReferenceValues<Contribution, OperandT>"
|
|
.br
|
|
.ti -1c
|
|
.RI "template<std::size_t Contribution, typename OperandT> using \fBserif::operators::backend::mfem::volume_keys::PhysicalValues\fP = \fBScoped\fP<void>::PhysicalValues<Contribution, OperandT>"
|
|
.br
|
|
.ti -1c
|
|
.RI "template<std::size_t Contribution> using \fBserif::operators::backend::mfem::volume_keys::QuadratureLinearization\fP = \fBScoped\fP<void>::QuadratureLinearization<Contribution>"
|
|
.br
|
|
.ti -1c
|
|
.RI "template<std::size_t Contribution> using \fBserif::operators::backend::mfem::volume_keys::GeometryDerivatives\fP = \fBScoped\fP<void>::GeometryDerivatives<Contribution>"
|
|
.br
|
|
.ti -1c
|
|
.RI "using \fBserif::operators::backend::mfem::volume_keys::Linearization\fP = \fBScoped\fP<void>::Linearization"
|
|
.br
|
|
.ti -1c
|
|
.RI "template<typename ElementT> using \fBserif::operators::backend::mfem::ElementBatch\fP = std::vector<std::shared_ptr<const ElementT>>"
|
|
.br
|
|
.RI "A stage owns immutable element results, shared with downstream stages and accepted linearizations\&. "
|
|
.in -1c
|
|
.SS "Enumerations"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "enum class \fBserif::operators::backend::mfem::ContractionMode\fP "
|
|
.br
|
|
.RI "Options enum to control how the tensor contractions are performed\&. "
|
|
.in -1c
|
|
.SS "Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "template<typename TestT, typename SchemaT> \fBserif::operators::backend::mfem::VolumeDiscretization\fP (const \fBdiscretization::backend::mfem::TermBinding\fP< TestT, SchemaT > &, const \fBdiscretization::backend::mfem::TermBinding\fP< \fBdiscretization::blocks::displacement::vector\fP, SchemaT > &, const ::mfem::GridFunction &, const \fBmapping::DomainMapper\fP &) \-> VolumeDiscretization< TestT, SchemaT >"
|
|
.br
|
|
.in -1c
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|