.TH "serif::equations::RotationalForce" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::equations::RotationalForce \- Rotational contribution to displacement balance: -integral_star rho grad(Psi) \&. w dV\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fR#include <rotational_force\&.hpp>\fP
.PP
Inherits \fBserif::equations::Contribution< discretization::forms::Operand< discretization::blocks::displacement::vector >, discretization::domain::StellarDomains >\fP\&.
.SS "Public Types"

.in +1c
.ti -1c
.RI "using \fBDensity\fP = \fBdiscretization::blocks::density::mass\fP"
.br
.ti -1c
.RI "using \fBAngularVelocity\fP = \fBdiscretization::blocks::rotation::angular_velocity\fP"
.br
.ti -1c
.RI "using \fBAngularVelocityValue\fP = \fBdiscretization::forms::Operand\fP<\fBAngularVelocity\fP>"
.br
.ti -1c
.RI "using \fBDensityValue\fP = \fBdiscretization::forms::Operand\fP<\fBDensity\fP>"
.br
.ti -1c
.RI "using \fBOperands\fP = \fButils::types::TypeList\fP<\fBDensityValue\fP, \fBAngularVelocityValue\fP>"
.br
.ti -1c
.RI "using \fBResult\fP = \fBdiscretization::forms::VectorValue\fP"
.br
.in -1c

Public Types inherited from \fBserif::equations::Contribution< discretization::forms::Operand< discretization::blocks::displacement::vector >, discretization::domain::StellarDomains >\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 "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBRotationalForce\fP (\fBResult\fP axis={0\&.0, 0\&.0, 1\&.0}, \fBResult\fP center={})"
.br
.RI "Prescribe only the axis and center; angular speed is a global scalar operand\&. "
.ti -1c
.RI "\fBPointLinearization\fP< \fBOperands\fP, \fBResult\fP > \fBevaluate\fP (const \fBEquationPoint\fP< \fBOperands\fP > &point) const"
.br
.RI "F = -rho grad(Psi), dF/drho = -grad(Psi), dF/dx = -rho Hessian(Psi)\&. "
.ti -1c
.RI "int \fBadditional_order\fP (\fBDensityValue\fP, int position_order) const"
.br
.ti -1c
.RI "int \fBadditional_order\fP (\fBAngularVelocityValue\fP, int position_order) const"
.br
.in -1c
.SS "Static Public Attributes"

.in +1c
.ti -1c
.RI "static constexpr std::string_view \fBname\fP = 'rotational force'"
.br
.in -1c
.SS "Private Attributes"

.in +1c
.ti -1c
.RI "\fBRigidRotation\fP \fBm_rotation\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
Rotational contribution to displacement balance: -integral_star rho grad(Psi) \&. w dV\&. 
.SH "Member Typedef Documentation"
.PP 
.SS "using \fBserif::equations::RotationalForce::AngularVelocity\fP = \fBdiscretization::blocks::rotation::angular_velocity\fP"

.SS "using \fBserif::equations::RotationalForce::AngularVelocityValue\fP = \fBdiscretization::forms::Operand\fP<\fBAngularVelocity\fP>"

.SS "using \fBserif::equations::RotationalForce::Density\fP = \fBdiscretization::blocks::density::mass\fP"

.SS "using \fBserif::equations::RotationalForce::DensityValue\fP = \fBdiscretization::forms::Operand\fP<\fBDensity\fP>"

.SS "using \fBserif::equations::RotationalForce::Operands\fP = \fButils::types::TypeList\fP<\fBDensityValue\fP, \fBAngularVelocityValue\fP>"

.SS "using \fBserif::equations::RotationalForce::Result\fP = \fBdiscretization::forms::VectorValue\fP"

.SH "Constructor & Destructor Documentation"
.PP 
.SS "serif::equations::RotationalForce::RotationalForce (\fBResult\fP axis = \fR{0\&.0, 0\&.0, 1\&.0}\fP, \fBResult\fP center = \fR{}\fP)\fR [inline]\fP, \fR [explicit]\fP"

.PP
Prescribe only the axis and center; angular speed is a global scalar operand\&. 
.SH "Member Function Documentation"
.PP 
.SS "int serif::equations::RotationalForce::additional_order (\fBAngularVelocityValue\fP , int position_order) const\fR [inline]\fP, \fR [nodiscard]\fP"

.SS "int serif::equations::RotationalForce::additional_order (\fBDensityValue\fP , int position_order) const\fR [inline]\fP, \fR [nodiscard]\fP"

.SS "\fBPointLinearization\fP< \fBOperands\fP, \fBResult\fP > serif::equations::RotationalForce::evaluate (const \fBEquationPoint\fP< \fBOperands\fP > & point) const\fR [inline]\fP, \fR [nodiscard]\fP"

.PP
F = -rho grad(Psi), dF/drho = -grad(Psi), dF/dx = -rho Hessian(Psi)\&. 
.SH "Member Data Documentation"
.PP 
.SS "\fBRigidRotation\fP serif::equations::RotationalForce::m_rotation\fR [private]\fP"

.SS "std::string_view serif::equations::RotationalForce::name = 'rotational force'\fR [static]\fP, \fR [constexpr]\fP"


.SH "Author"
.PP 
Generated automatically by Doxygen for SERiF from the source code\&.