SERiF v0.0.1a
Stellar Evolution and Rotation in Four Dimensions
Loading...
Searching...
No Matches
serif::equations::RotationalForce Class Referencefinal

Rotational contribution to displacement balance: -integral_star rho grad(Psi) . w dV. More...

#include <rotational_force.hpp>

Inheritance diagram for serif::equations::RotationalForce:
[legend]
Collaboration diagram for serif::equations::RotationalForce:
[legend]

Public Types

using Density = discretization::blocks::density::mass
 
using AngularVelocity = discretization::blocks::rotation::angular_velocity
 
using AngularVelocityValue = discretization::forms::Operand<AngularVelocity>
 
using DensityValue = discretization::forms::Operand<Density>
 
using Operands = utils::types::TypeList<DensityValue, AngularVelocityValue>
 
using Result = discretization::forms::VectorValue
 
- Public Types inherited from serif::equations::Contribution< discretization::forms::Operand< discretization::blocks::displacement::vector >, discretization::domain::StellarDomains >
using Test
 The test type of the contribution.
 
using TestOperand
 The operand type of the contribution (associating a test function and a term)
 
using Support
 The domain support of the contribution (which then boils down to the dofs which are supported by the term on that test function)
 

Public Member Functions

 RotationalForce (Result axis={0.0, 0.0, 1.0}, Result center={})
 Prescribe only the axis and center; angular speed is a global scalar operand.
 
PointLinearization< Operands, Result > evaluate (const EquationPoint< Operands > &point) const
 F = -rho grad(Psi), dF/drho = -grad(Psi), dF/dx = -rho Hessian(Psi).
 
int additional_order (DensityValue, int position_order) const
 
int additional_order (AngularVelocityValue, int position_order) const
 

Static Public Attributes

static constexpr std::string_view name = "rotational force"
 

Private Attributes

RigidRotation m_rotation
 

Detailed Description

Rotational contribution to displacement balance: -integral_star rho grad(Psi) . w dV.

Member Typedef Documentation

◆ AngularVelocity

◆ AngularVelocityValue

◆ Density

◆ DensityValue

◆ Operands

◆ Result

Constructor & Destructor Documentation

◆ RotationalForce()

serif::equations::RotationalForce::RotationalForce ( Result axis = {0.0, 0.0, 1.0},
Result center = {} )
inlineexplicit

Prescribe only the axis and center; angular speed is a global scalar operand.

Member Function Documentation

◆ additional_order() [1/2]

int serif::equations::RotationalForce::additional_order ( AngularVelocityValue ,
int position_order ) const
inlinenodiscard

◆ additional_order() [2/2]

int serif::equations::RotationalForce::additional_order ( DensityValue ,
int position_order ) const
inlinenodiscard

◆ evaluate()

PointLinearization< Operands, Result > serif::equations::RotationalForce::evaluate ( const EquationPoint< Operands > & point) const
inlinenodiscard

F = -rho grad(Psi), dF/drho = -grad(Psi), dF/dx = -rho Hessian(Psi).

Member Data Documentation

◆ m_rotation

RigidRotation serif::equations::RotationalForce::m_rotation
private

◆ name

std::string_view serif::equations::RotationalForce::name = "rotational force"
staticconstexpr

The documentation for this class was generated from the following file: