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)
99 lines
5.7 KiB
Groff
99 lines
5.7 KiB
Groff
.TH "src/include/serif/backend/mfem/operators/element_preparation.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/include/serif/backend/mfem/operators/element_preparation.hpp
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include <array>\fP
|
|
.br
|
|
\fR#include <cmath>\fP
|
|
.br
|
|
\fR#include <expected>\fP
|
|
.br
|
|
\fR#include <memory>\fP
|
|
.br
|
|
\fR#include <utility>\fP
|
|
.br
|
|
\fR#include 'serif/backend/mfem/mapping/domain_mapper\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/backend/mfem/operators/element_data\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/backend/mfem/operators/operand_evaluation\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/backend/mfem/operators/quadrature\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/backend/mfem/operators/rejection\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/backend/mfem/discretization/term_coefficients\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/backend/mfem/operators/workspace\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/backend/mfem/shared/parallel\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/utils/misc/compensated_sum\&.hpp'\fP
|
|
.br
|
|
|
|
.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 "Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "template<VolumeEquation EquationT, typename ContributionT> std::expected< \fBElementBasis\fP< \fBEquationPlan\fP< EquationT >::operand_count >, \fBPreparationRejection\fP > \fBserif::operators::backend::mfem::sample_element_basis\fP (const ContributionT &equation, int element, const \fBdiscretization::backend::mfem::DofMap\fP &row, const \fBdiscretization::backend::mfem::DofMap\fP &displacement_binding, const std::array< const \fBdiscretization::backend::mfem::DofMap\fP *, \fBEquationPlan\fP< EquationT >::column_count > &columns, const \fBmapping::DomainMapper\fP &mapper, const \fBdiscretization::quadrature::Policy\fP &policy, \fBTensorBasisCache\fP &basis_cache, \fBContractionMode\fP contraction_mode)"
|
|
.br
|
|
.RI "Sample the contribution's quadrature rule and bases on the fixed computational mesh\&. "
|
|
.ti -1c
|
|
.RI "elements \fBserif::operators::backend::mfem::element_values\fP (basis\&.element, input\&.values, workspace\&.element_values)"
|
|
.br
|
|
.ti -1c
|
|
.RI "template<VolumeEquation EquationT, typename ContributionT> std::expected< \fBElementGeometry\fP< \fBEquationPlan\fP< EquationT >::operand_count >, \fBPreparationRejection\fP > \fBserif::operators::backend::mfem::map_element_geometry\fP (const \fBElementBasis\fP< \fBEquationPlan\fP< EquationT >::operand_count > &basis, const \fBdiscretization::backend::mfem::DofMap\fP &displacement_binding, const \fBdiscretization::backend::mfem::DofMap::Elements\fP &displacement_elements, const \fB::mfem::Vector\fP &displacement, const \fBMappingCoefficients\fP &compactification, const \fBmapping::DomainMapper\fP &mapper, \fBWorkspace\fP &workspace)"
|
|
.br
|
|
.RI "Freeze displacement and compactification, then map quadrature points and bases to physical space\&. "
|
|
.ti -1c
|
|
.RI "template<EvaluableOperand OperandT, std::size_t Count> \fB::mfem::Vector\fP \fBserif::operators::backend::mfem::map_element_operand\fP (const \fB::mfem::Vector\fP &reference, const \fBElementGeometry\fP< Count > &geometry, \fBWorkspace\fP &workspace)"
|
|
.br
|
|
.RI "Apply an operand's physical transformation to its cached fixed-mesh samples\&. "
|
|
.ti -1c
|
|
.RI "template<VolumeEquation EquationT, typename ContributionT> \fBequations::EquationPoint\fP< typename ContributionT::Operands > \fBserif::operators::backend::mfem::element_equation_point\fP (const std::array< std::shared_ptr< const \fB::mfem::Vector\fP >, \fBEquationPlan\fP< EquationT >::operand_count > &physical_values, const \fBmapping::MappingPointContext\fP &context, int point)"
|
|
.br
|
|
.RI "Pack the physical samples requested by this contribution at one quadrature point\&. "
|
|
.ti -1c
|
|
.RI "template<VolumeEquation EquationT, typename ContributionT> bool \fBserif::operators::backend::mfem::store_element_linearization\fP (const \fBequations::PointLinearization\fP< typename ContributionT::Operands, typename \fBOperandEvaluator\fP< \fBequations::TestOperandOf\fP< ContributionT > >::Value > &physics, int point, double weight, \fBElementData\fP< \fBEquationPlan\fP< EquationT >::operand_count > &data)"
|
|
.br
|
|
.RI "Weight a point's residual and derivatives; reject any non-finite stored component\&. "
|
|
.ti -1c
|
|
.RI "template<VolumeEquation EquationT, typename ContributionT> std::expected< \fBElementData\fP< \fBEquationPlan\fP< EquationT >::operand_count >, \fBPreparationRejection\fP > \fBserif::operators::backend::mfem::evaluate_element_equation\fP (const ContributionT &equation, double coefficient, std::shared_ptr< const \fBElementBasis\fP< \fBEquationPlan\fP< EquationT >::operand_count > > basis, std::shared_ptr< const \fBElementGeometry\fP< \fBEquationPlan\fP< EquationT >::operand_count > > geometry, std::array< std::shared_ptr< const \fB::mfem::Vector\fP >, \fBEquationPlan\fP< EquationT >::operand_count > reference_values, const std::array< std::shared_ptr< const \fB::mfem::Vector\fP >, \fBEquationPlan\fP< EquationT >::operand_count > &physical_values, \fBWorkspace\fP &workspace)"
|
|
.br
|
|
.RI "Evaluate and weight the equation while retaining its immutable preparation inputs\&. "
|
|
.in -1c
|
|
.SS "Variables"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "template<VolumeEquation EquationT, EvaluableOperand OperandT, typename BindingT> constexpr std::size_t \fBserif::operators::backend::mfem::index\fP = \fBequations::OperandValues\fP<typename Plan::Operands>::template index<OperandT>()"
|
|
.br
|
|
.RI "Contract one operand's fixed-mesh basis with its current coefficients\&. "
|
|
.ti -1c
|
|
.RI "\fB::mfem::Vector\fP \fBserif::operators::backend::mfem::values\fP"
|
|
.br
|
|
.in -1c
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|