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)
138 lines
5.9 KiB
Groff
138 lines
5.9 KiB
Groff
.TH "serif::equations::BarycenterConstraint< Axis, Row >" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::equations::BarycenterConstraint< Axis, Row > \- Fix one component of integral rho (x-center)/M_target\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <barycenter\&.hpp>\fP
|
|
.PP
|
|
Inherits \fBserif::equations::Contribution< TestOperandT, SupportT >\fP\&.
|
|
.SS "Public Types"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "using \fBDensity\fP = \fBdiscretization::blocks::density::mass\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "using \fBOperands\fP = \fButils::types::TypeList\fP<\fBdiscretization::forms::Operand\fP<\fBDensity\fP>>"
|
|
.br
|
|
.ti -1c
|
|
.RI "using \fBResidualQuantity\fP = \fBdimensions::Length\fP"
|
|
.br
|
|
.in -1c
|
|
|
|
Public Types inherited from \fBserif::equations::Contribution< TestOperandT, SupportT >\fP
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "using \fBTest\fP = TestOperandT::term_type"
|
|
.br
|
|
.RI "The test type of the contribution\&. "
|
|
.ti -1c
|
|
.RI "using \fBTestOperand\fP = TestOperandT"
|
|
.br
|
|
.RI "The operand type of the contribution (associating a test function and a term) "
|
|
.ti -1c
|
|
.RI "using \fBSupport\fP = SupportT"
|
|
.br
|
|
.RI "The domain support of the contribution (which then boils down to the dofs which are supported by the term on that test function) "
|
|
.in -1c
|
|
.SS "Public Member Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "\fBBarycenterConstraint\fP (double \fBtarget_mass\fP, std::array< double, 3 > \fBcenter\fP={})"
|
|
.br
|
|
.RI "Use a fixed positive mass scale and the same finite center as the rotation and deformation\&. "
|
|
.ti -1c
|
|
.RI "\fBPointLinearization\fP< \fBOperands\fP > \fBevaluate\fP (const \fBEquationPoint\fP< \fBOperands\fP > &point) const"
|
|
.br
|
|
.RI "Differentiate the normalized first mass moment in density and physical position\&. "
|
|
.ti -1c
|
|
.RI "double \fBtarget_mass\fP () const noexcept"
|
|
.br
|
|
.RI "Inspect the fixed normalization mass\&. "
|
|
.ti -1c
|
|
.RI "const std::array< double, 3 > & \fBcenter\fP () const noexcept"
|
|
.br
|
|
.RI "Inspect the desired barycenter\&. "
|
|
.in -1c
|
|
.SS "Static Public Member Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "static int \fBadditional_order\fP (\fBdiscretization::forms::Operand\fP< \fBDensity\fP >, int position_order)"
|
|
.br
|
|
.RI "Include the linear position factor in quadrature selection\&. "
|
|
.in -1c
|
|
.SS "Static Public Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "static constexpr std::string_view \fBname\fP = 'barycenter constraint'"
|
|
.br
|
|
.in -1c
|
|
.SS "Private Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "double \fBm_target_mass\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "std::array< double, 3 > \fBm_center\fP"
|
|
.br
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
|
|
.SS "template<int Axis, typename Row = discretization::blocks::frame_acceleration::component<Axis>>
|
|
.br
|
|
class serif::equations::BarycenterConstraint< Axis, Row >"Fix one component of integral rho (x-center)/M_target\&.
|
|
.SH "Member Typedef Documentation"
|
|
.PP
|
|
.SS "template<int Axis, typename Row = discretization::blocks::frame_acceleration::component<Axis>> using \fBserif::equations::BarycenterConstraint\fP< Axis, Row >::Density = \fBdiscretization::blocks::density::mass\fP"
|
|
|
|
.SS "template<int Axis, typename Row = discretization::blocks::frame_acceleration::component<Axis>> using \fBserif::equations::BarycenterConstraint\fP< Axis, Row >::Operands = \fButils::types::TypeList\fP<\fBdiscretization::forms::Operand\fP<\fBDensity\fP>>"
|
|
|
|
.SS "template<int Axis, typename Row = discretization::blocks::frame_acceleration::component<Axis>> using \fBserif::equations::BarycenterConstraint\fP< Axis, Row >::ResidualQuantity = \fBdimensions::Length\fP"
|
|
|
|
.SH "Constructor & Destructor Documentation"
|
|
.PP
|
|
.SS "template<int Axis, typename Row = discretization::blocks::frame_acceleration::component<Axis>> \fBserif::equations::BarycenterConstraint\fP< Axis, Row >::BarycenterConstraint (double target_mass, std::array< double, 3 > center = \fR{}\fP)\fR [inline]\fP, \fR [explicit]\fP"
|
|
|
|
.PP
|
|
Use a fixed positive mass scale and the same finite center as the rotation and deformation\&.
|
|
.SH "Member Function Documentation"
|
|
.PP
|
|
.SS "template<int Axis, typename Row = discretization::blocks::frame_acceleration::component<Axis>> static int \fBserif::equations::BarycenterConstraint\fP< Axis, Row >::additional_order (\fBdiscretization::forms::Operand\fP< \fBDensity\fP > , int position_order)\fR [inline]\fP, \fR [static]\fP, \fR [nodiscard]\fP"
|
|
|
|
.PP
|
|
Include the linear position factor in quadrature selection\&.
|
|
.SS "template<int Axis, typename Row = discretization::blocks::frame_acceleration::component<Axis>> const std::array< double, 3 > & \fBserif::equations::BarycenterConstraint\fP< Axis, Row >::center () const\fR [inline]\fP, \fR [nodiscard]\fP, \fR [noexcept]\fP"
|
|
|
|
.PP
|
|
Inspect the desired barycenter\&.
|
|
.SS "template<int Axis, typename Row = discretization::blocks::frame_acceleration::component<Axis>> \fBPointLinearization\fP< \fBOperands\fP > \fBserif::equations::BarycenterConstraint\fP< Axis, Row >::evaluate (const \fBEquationPoint\fP< \fBOperands\fP > & point) const\fR [inline]\fP, \fR [nodiscard]\fP"
|
|
|
|
.PP
|
|
Differentiate the normalized first mass moment in density and physical position\&.
|
|
.SS "template<int Axis, typename Row = discretization::blocks::frame_acceleration::component<Axis>> double \fBserif::equations::BarycenterConstraint\fP< Axis, Row >::target_mass () const\fR [inline]\fP, \fR [nodiscard]\fP, \fR [noexcept]\fP"
|
|
|
|
.PP
|
|
Inspect the fixed normalization mass\&.
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "template<int Axis, typename Row = discretization::blocks::frame_acceleration::component<Axis>> std::array<double, 3> \fBserif::equations::BarycenterConstraint\fP< Axis, Row >::m_center\fR [private]\fP"
|
|
|
|
.SS "template<int Axis, typename Row = discretization::blocks::frame_acceleration::component<Axis>> double \fBserif::equations::BarycenterConstraint\fP< Axis, Row >::m_target_mass\fR [private]\fP"
|
|
|
|
.SS "template<int Axis, typename Row = discretization::blocks::frame_acceleration::component<Axis>> std::string_view \fBserif::equations::BarycenterConstraint\fP< Axis, Row >::name = 'barycenter constraint'\fR [static]\fP, \fR [constexpr]\fP"
|
|
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|