.TH "serif::equations::CenteringConstraint" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*- .ad l .nh .SH NAME serif::equations::CenteringConstraint \- \fBEquation\fP that fixes the material point at the computational origin\&. .SH SYNOPSIS .br .PP .PP \fR#include \fP .PP Inherits \fBserif::equations::Contribution< discretization::forms::Operand< discretization::blocks::displacement::vector > >\fP\&. .SS "Public Types" .in +1c .ti -1c .RI "using \fBOperands\fP = \fButils::types::TypeList\fP<\fBTestOperand\fP>" .br .RI "The list of operands for the centering constraint equation\&. " .in -1c Public Types inherited from \fBserif::equations::Contribution< discretization::forms::Operand< discretization::blocks::displacement::vector > >\fP .in +1c .ti -1c .RI "using \fBTest\fP" .br .RI "The test type of the contribution\&. " .ti -1c .RI "using \fBTestOperand\fP" .br .RI "The operand type of the contribution (associating a test function and a term) " .ti -1c .RI "using \fBSupport\fP" .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 "Static Public Member Functions" .in +1c .ti -1c .RI "static \fBPointLinearization\fP< \fBOperands\fP, \fBdiscretization::forms::VectorValue\fP > \fBevaluate\fP (const \fBEquationPoint\fP< \fBOperands\fP > &point)" .br .RI "Evaluate the centering constraint equation at a given point\&. Fundamentally all this this is doing is returning the displacement of the material point at the origin since to center that the displacement of that point should be zero\&. The derivative of the residual with respect to displacement along each axis is then just the identity matrix\&. " .in -1c .SS "Static Public Attributes" .in +1c .ti -1c .RI "static constexpr std::string_view \fBname\fP = 'centering constraint'" .br .RI "Compile time name for the centering constraint equation, used for debugging and logging\&. " .ti -1c .RI "static constexpr bool \fBposition_independent\fP = true" .br .RI "A centering constraint is position independent, as it does not depend on the spatial location of the material point\&. This member is only used for compile-time checks\&. " .ti -1c .RI "static constexpr std::array< double, 3 > \fBreference_position\fP {}" .br .RI "The reference position for the centering constraint equation, which is the origin (0, 0, 0)\&. This member is only used for compile-time checks\&. " .in -1c .SH "Detailed Description" .PP \fBEquation\fP that fixes the material point at the computational origin\&. \fBEquation\fP \fBContributions\fP .PD 0 .IP "\(bu" 2 Residuals to the global displacement vector\&. .PP .PP \fBNote\fP .RS 4 This is a translational gauge, not a center-of-mass constraint\&. .RE .PP .SH "Member Typedef Documentation" .PP .SS "using \fBserif::equations::CenteringConstraint::Operands\fP = \fButils::types::TypeList\fP<\fBTestOperand\fP>" .PP The list of operands for the centering constraint equation\&. .SH "Member Function Documentation" .PP .SS "static \fBPointLinearization\fP< \fBOperands\fP, \fBdiscretization::forms::VectorValue\fP > serif::equations::CenteringConstraint::evaluate (const \fBEquationPoint\fP< \fBOperands\fP > & point)\fR [inline]\fP, \fR [static]\fP, \fR [nodiscard]\fP" .PP Evaluate the centering constraint equation at a given point\&. Fundamentally all this this is doing is returning the displacement of the material point at the origin since to center that the displacement of that point should be zero\&. The derivative of the residual with respect to displacement along each axis is then just the identity matrix\&. .PP \fBParameters\fP .RS 4 \fIpoint\fP The point at which to evaluate the centering constraint equation\&. .RE .PP \fBReturns\fP .RS 4 A \fBPointLinearization\fP object containing the residual and field derivatives for the centering constraint equation at the given point\&. .RE .PP .SH "Member Data Documentation" .PP .SS "std::string_view serif::equations::CenteringConstraint::name = 'centering constraint'\fR [static]\fP, \fR [constexpr]\fP" .PP Compile time name for the centering constraint equation, used for debugging and logging\&. .SS "bool serif::equations::CenteringConstraint::position_independent = true\fR [static]\fP, \fR [constexpr]\fP" .PP A centering constraint is position independent, as it does not depend on the spatial location of the material point\&. This member is only used for compile-time checks\&. .SS "std::array serif::equations::CenteringConstraint::reference_position {}\fR [static]\fP, \fR [constexpr]\fP" .PP The reference position for the centering constraint equation, which is the origin (0, 0, 0)\&. This member is only used for compile-time checks\&. .SH "Author" .PP Generated automatically by Doxygen for SERiF from the source code\&.