module; #include #include #include #include #include module mean_field; import :operators.prepared_angular_momentum; namespace { using DomainSchema = mean_field::utils::domain::CoreEnvelopeVacuumDomainSchema; [[nodiscard]] bool is_vacuum_attribute(const int attribute) { return DomainSchema::template attribute_belongs_to(attribute); } void validate_finite_vector(const mfem::Vector &vector, const char *message) { for (int index = 0; index < vector.Size(); ++index) { MFEM_VERIFY(std::isfinite(vector(index)), message); } } void true_to_local( const mfem::ParFiniteElementSpace &finiteElementSpace, const mfem::Vector &trueVector, mfem::Vector &localVector ) { MFEM_VERIFY(trueVector.Size() == finiteElementSpace.GetTrueVSize(), "True vector has the wrong size."); localVector.SetSize(finiteElementSpace.GetVSize()); const mfem::Operator *prolongation = finiteElementSpace.GetProlongationMatrix(); if (prolongation != nullptr) { prolongation->Mult(trueVector, localVector); } else { localVector = trueVector; } } [[nodiscard]] const mfem::IntegrationRule &get_moment_of_inertia_rule( const mean_field::fem::FEM &f, const mfem::FiniteElement &densityElement, const mfem::ElementTransformation &transformation ) { using DensityField = mean_field::field::Field; MFEM_VERIFY( densityElement.GetOrder() == mean_field::field::Density::Scalar::familyOrder, "The angular-momentum element does not match the registered density field." ); const mean_field::quadrature::Query query = DensityField::make_query( mean_field::quadrature::QuadratureRole::discretization, transformation.OrderW(), std::array{2}, mean_field::utils::DOMAINS::STELLAR, mean_field::quadrature::MappingKind::general ); const auto resolution = f.quadratureFactory->get(query, transformation.GetGeometryType()); MFEM_VERIFY( resolution.integration_rule != nullptr, "The quadrature policy did not return an angular-momentum integration rule." ); return *resolution.integration_rule; } void validate_shared_gravity_revisions( const mean_field::operators::context::gravity_field::GravityFieldLinearizationContext &gravityContext, const mean_field::operators::AngularMomentumDependencies &dependencies ) { MFEM_VERIFY( gravityContext.IsPrepared(), "PreparedAngularMomentumOperator requires the shared gravity context to be prepared first." ); const auto &revisions = gravityContext.GetRevisions(); MFEM_VERIFY( revisions.discretization.value == dependencies.discretization.revision && revisions.density.value == dependencies.density.revision && revisions.displacement.value == dependencies.displacement.revision, "PreparedAngularMomentumOperator received revisions that do not match the shared gravity context." ); } void validate_identity_transition( const mean_field::operators::AngularMomentumDependencyStamp &prepared, const mean_field::operators::AngularMomentumDependencyStamp &requested, const char *message ) { MFEM_VERIFY(prepared.identity == requested.identity || prepared.revision != requested.revision, message); } } // namespace namespace mean_field::operators { PreparedAngularMomentumOperator::PreparedAngularMomentumOperator( const fem::FEM &f, const mapping::DomainMapper &domainMapper, const context::gravity_field::GravityFieldLinearizationContext &gravityContext, models::CompiledFixedAngularMomentum constraint ) : m_fem(f), m_domainMapper(domainMapper), m_gravityContext(gravityContext), m_constraint(std::move(constraint)) { MFEM_VERIFY(m_fem.mesh != nullptr, "PreparedAngularMomentumOperator requires a mesh."); MFEM_VERIFY( m_fem.mesh->Dimension() == 3 && m_domainMapper.GetDimension() == 3, "PreparedAngularMomentumOperator currently requires a three-dimensional mapped domain." ); MFEM_VERIFY( m_fem.densityFes != nullptr && m_fem.displacementFes != nullptr && m_fem.compactificationFes != nullptr && m_fem.compactificationCoordinate != nullptr && m_fem.quadratureFactory != nullptr, "PreparedAngularMomentumOperator requires density, displacement, compactification, and quadrature data." ); MFEM_VERIFY( m_gravityContext.GetDensityMap().full_size() == m_fem.densityFes->GetTrueVSize() && m_gravityContext.GetDisplacementMap().full_size() == m_fem.displacementFes->GetTrueVSize(), "PreparedAngularMomentumOperator received incompatible shared FieldDof maps." ); m_densityVariationTrue.SetSize(m_gravityContext.GetDensityMap().full_size()); m_displacementVariationTrue.SetSize(m_gravityContext.GetDisplacementMap().full_size()); } PreparedAngularMomentumReport PreparedAngularMomentumOperator::Prepare( const double angularVelocity, const AngularMomentumDependencies &dependencies ) { MFEM_VERIFY( std::isfinite(angularVelocity), "PreparedAngularMomentumOperator requires a finite angular-velocity coordinate." ); validate_shared_gravity_revisions(m_gravityContext, dependencies); if (m_isPrepared) { validate_identity_transition( m_preparedDependencies.discretization, dependencies.discretization, "A new angular-momentum discretization identity must change its revision." ); validate_identity_transition( m_preparedDependencies.density, dependencies.density, "A new angular-momentum density identity must change its revision." ); validate_identity_transition( m_preparedDependencies.displacement, dependencies.displacement, "A new angular-momentum displacement identity must change its revision." ); validate_identity_transition( m_preparedDependencies.rotation, dependencies.rotation, "A new angular-momentum rotation identity must change its revision." ); } const bool rebuildStaticPlan = !m_isPrepared || dependencies.discretization != m_preparedDependencies.discretization; const bool refreshGeometry = rebuildStaticPlan || dependencies.displacement != m_preparedDependencies.displacement; const bool refreshDensity = rebuildStaticPlan || dependencies.density != m_preparedDependencies.density; const bool updateAngularVelocity = !m_isPrepared || dependencies.rotation != m_preparedDependencies.rotation || angularVelocity != m_angularVelocity; m_isPrepared = false; PreparedAngularMomentumReport report; if (rebuildStaticPlan) { BuildStaticPlan(); report.rebuiltStaticPlan = true; } if (refreshGeometry) { RefreshGeometry(m_gravityContext.GetGeometryContext().GetDisplacementTrue()); report.refreshedGeometry = true; } if (refreshDensity) { RefreshDensity(m_gravityContext.GetDensityTrue()); report.refreshedDensity = true; } if (updateAngularVelocity) { m_angularVelocity = angularVelocity; report.updatedAngularVelocity = true; } if (refreshGeometry || refreshDensity || updateAngularVelocity) { AssembleResidual(); report.assembledResidual = true; } m_preparedDependencies = dependencies; m_isPrepared = true; return report; } void PreparedAngularMomentumOperator::BuildStaticPlan() { m_elements.clear(); m_elements.reserve(m_fem.mesh->GetNE()); int localStellarElementCount = 0; for (int elementId = 0; elementId < m_fem.mesh->GetNE(); ++elementId) { mfem::ElementTransformation *transformation = m_fem.mesh->GetElementTransformation(elementId); MFEM_VERIFY(transformation != nullptr, "Angular-momentum preparation received a null transformation."); if (is_vacuum_attribute(transformation->Attribute)) { continue; } ++localStellarElementCount; m_elements.emplace_back(); ElementPAData &data = m_elements.back(); data.elementId = elementId; data.densityDofTransformation = m_fem.densityFes->GetElementDofs(elementId, data.densityDofs); data.displacementDofTransformation = m_fem.displacementFes->GetElementVDofs(elementId, data.displacementDofs); data.compactificationDofTransformation = m_fem.compactificationFes->GetElementDofs(elementId, data.compactificationDofs); const mfem::FiniteElement &densityElement = *m_fem.densityFes->GetFE(elementId); const mfem::IntegrationRule &integrationRule = get_moment_of_inertia_rule(m_fem, densityElement, *transformation); data.quadraturePoints.resize(integrationRule.GetNPoints()); for (int quadraturePoint = 0; quadraturePoint < integrationRule.GetNPoints(); ++quadraturePoint) { QuadraturePointData &point = data.quadraturePoints[quadraturePoint]; point.integrationPoint = integrationRule.IntPoint(quadraturePoint); point.densityShape.SetSize(densityElement.GetDof()); densityElement.CalcShape(point.integrationPoint, point.densityShape); } } int globalStellarElementCount = 0; MPI_Allreduce( &localStellarElementCount, &globalStellarElementCount, 1, MPI_INT, MPI_SUM, m_fem.mesh->GetComm() ); MFEM_VERIFY(globalStellarElementCount > 0, "PreparedAngularMomentumOperator found no stellar elements."); } void PreparedAngularMomentumOperator::RefreshGeometry(const mfem::Vector &displacement) { MFEM_VERIFY( displacement.Size() == m_fem.displacementFes->GetTrueVSize(), "Angular-momentum geometry has the wrong displacement size." ); validate_finite_vector(displacement, "Angular-momentum geometry contains a non-finite displacement."); mfem::Vector displacementLocal; true_to_local(*m_fem.displacementFes, displacement, displacementLocal); mapping::DomainMapper::Workspace workspace(m_fem.mesh->Dimension()); for (ElementPAData &data : m_elements) { displacementLocal.GetSubVector(data.displacementDofs, data.baseDisplacement); m_fem.compactificationCoordinate->GetSubVector(data.compactificationDofs, data.compactification); if (data.displacementDofTransformation != nullptr) { data.displacementDofTransformation->InvTransformPrimal(data.baseDisplacement); } if (data.compactificationDofTransformation != nullptr) { data.compactificationDofTransformation->InvTransformPrimal(data.compactification); } const mfem::FiniteElement &displacementElement = *m_fem.displacementFes->GetFE(data.elementId); const mfem::FiniteElement &compactificationElement = *m_fem.compactificationFes->GetFE(data.elementId); const mapping::ElementDisplacementData displacementData = mapping::ElementDisplacementDataFromElementVDofs(displacementElement, data.baseDisplacement); const mapping::ElementCompactificationData compactificationData( compactificationElement, data.compactification ); const mapping::ElementMappingData mappingData{ .displacement = displacementData, .compactification = compactificationData }; mfem::ElementTransformation *transformation = m_fem.mesh->GetElementTransformation(data.elementId); for (QuadraturePointData &point : data.quadraturePoints) { const mapping::MappingStatus status = m_domainMapper.EvaluateVolume( mappingData, *transformation, point.integrationPoint, workspace, point.mappingContext ); MFEM_VERIFY( status == mapping::MappingStatus::valid && !point.mappingContext.mapping.compactified, "Mapped angular-momentum geometry is invalid. Element: " << data.elementId ); point.cylindricalRadiusSquared = CylindricalRadiusSquared(point.mappingContext.mapping.physical_position); } } } void PreparedAngularMomentumOperator::RefreshDensity(const mfem::Vector &density) { MFEM_VERIFY( density.Size() == m_fem.densityFes->GetTrueVSize(), "Angular-momentum density has the wrong size." ); validate_finite_vector(density, "Angular-momentum density contains a non-finite value."); mfem::Vector densityLocal; true_to_local(*m_fem.densityFes, density, densityLocal); mfem::Vector elementDensity; for (ElementPAData &data : m_elements) { densityLocal.GetSubVector(data.densityDofs, elementDensity); if (data.densityDofTransformation != nullptr) { data.densityDofTransformation->InvTransformPrimal(elementDensity); } for (QuadraturePointData &point : data.quadraturePoints) { point.density = elementDensity * point.densityShape; MFEM_VERIFY(std::isfinite(point.density), "Angular-momentum quadrature density is non-finite."); } } } void PreparedAngularMomentumOperator::AssembleResidual() { double localMomentOfInertia = 0.0; for (const ElementPAData &data : m_elements) { for (const QuadraturePointData &point : data.quadraturePoints) { localMomentOfInertia += point.density * point.cylindricalRadiusSquared * point.mappingContext.quadrature.weight; } } m_momentOfInertia = GlobalSum(localMomentOfInertia); MFEM_VERIFY( std::isfinite(m_momentOfInertia) && m_momentOfInertia >= 0.0, "PreparedAngularMomentumOperator assembled an invalid moment of inertia." ); m_currentAngularMomentum = m_angularVelocity * m_momentOfInertia; m_cachedResidual.SetSize(1); m_cachedResidual(0) = m_currentAngularMomentum - m_constraint.targetAngularMomentum().value(); ++m_preparationCount; } void PreparedAngularMomentumOperator::BuildResidual(mfem::Vector &residual) const { VerifyPrepared(); residual = m_cachedResidual; ++m_residualApplicationCount; } double PreparedAngularMomentumOperator::EvaluateDensityMomentActionLocal( const mfem::Vector &densityVariation ) const { MFEM_VERIFY( densityVariation.Size() == m_fem.densityFes->GetTrueVSize(), "Angular-momentum density action has the wrong true-vector size." ); true_to_local(*m_fem.densityFes, densityVariation, m_densityVariationLocal); double localAction = 0.0; for (const ElementPAData &data : m_elements) { m_densityVariationLocal.GetSubVector(data.densityDofs, m_elementDensityVariation); if (data.densityDofTransformation != nullptr) { data.densityDofTransformation->InvTransformPrimal(m_elementDensityVariation); } for (const QuadraturePointData &point : data.quadraturePoints) { localAction += (m_elementDensityVariation * point.densityShape) * point.cylindricalRadiusSquared * point.mappingContext.quadrature.weight; } } return localAction; } double PreparedAngularMomentumOperator::EvaluateDisplacementMomentActionLocal( const mfem::Vector &displacementVariation ) const { MFEM_VERIFY( displacementVariation.Size() == m_fem.displacementFes->GetTrueVSize(), "Angular-momentum displacement action has the wrong true-vector size." ); true_to_local(*m_fem.displacementFes, displacementVariation, m_displacementVariationLocal); mapping::DomainMapper::Workspace workspace(m_fem.mesh->Dimension()); mapping::VolumeMappingVariation variation; double localAction = 0.0; for (const ElementPAData &data : m_elements) { m_displacementVariationLocal.GetSubVector(data.displacementDofs, m_elementDisplacementVariation); if (data.displacementDofTransformation != nullptr) { data.displacementDofTransformation->InvTransformPrimal(m_elementDisplacementVariation); } const mfem::FiniteElement &displacementElement = *m_fem.displacementFes->GetFE(data.elementId); const mfem::FiniteElement &compactificationElement = *m_fem.compactificationFes->GetFE(data.elementId); const mapping::ElementDisplacementData baseDisplacementData = mapping::ElementDisplacementDataFromElementVDofs(displacementElement, data.baseDisplacement); const mapping::ElementDisplacementData directionData = mapping::ElementDisplacementDataFromElementVDofs(displacementElement, m_elementDisplacementVariation); const mapping::ElementCompactificationData compactificationData( compactificationElement, data.compactification ); const mapping::ElementMappingData mappingData{ .displacement = baseDisplacementData, .compactification = compactificationData }; mfem::ElementTransformation *transformation = m_fem.mesh->GetElementTransformation(data.elementId); for (const QuadraturePointData &point : data.quadraturePoints) { const mapping::MappingStatus status = m_domainMapper.EvaluateVolumeVariation( mappingData, directionData, *transformation, point.integrationPoint, point.mappingContext, workspace, variation ); MFEM_VERIFY( status == mapping::MappingStatus::valid, "Mapped angular-momentum variation is invalid. Element: " << data.elementId ); const double radiusSquaredVariation = CylindricalRadiusSquaredVariation( point.mappingContext.mapping.physical_position, variation.mapping.physical_position_variation ); localAction += point.density * (radiusSquaredVariation * point.mappingContext.quadrature.weight + point.cylindricalRadiusSquared * variation.weight_variation); } } return localAction; } void PreparedAngularMomentumOperator::ApplyDensityJacobianAction( const mfem::Vector &densityVariation, mfem::Vector &action ) const { VerifyPrepared(); MFEM_VERIFY( densityVariation.Size() == m_gravityContext.GetDensityMap().reduced_size(), "Angular-momentum density action has the wrong reduced size." ); validate_finite_vector(densityVariation, "Angular-momentum density direction is non-finite."); m_gravityContext.GetDensityMap().scatter(densityVariation, m_densityVariationTrue); action.SetSize(1); action(0) = m_angularVelocity * GlobalSum(EvaluateDensityMomentActionLocal(m_densityVariationTrue)); ++m_actionStatistics.densityApplications; } void PreparedAngularMomentumOperator::ApplyDisplacementJacobianAction( const mfem::Vector &displacementVariation, mfem::Vector &action ) const { VerifyPrepared(); MFEM_VERIFY( displacementVariation.Size() == m_gravityContext.GetDisplacementMap().reduced_size(), "Angular-momentum displacement action has the wrong reduced size." ); validate_finite_vector(displacementVariation, "Angular-momentum displacement direction is non-finite."); m_gravityContext.GetDisplacementMap().scatter(displacementVariation, m_displacementVariationTrue); action.SetSize(1); action(0) = m_angularVelocity * GlobalSum(EvaluateDisplacementMomentActionLocal(m_displacementVariationTrue)); ++m_actionStatistics.displacementApplications; } void PreparedAngularMomentumOperator::ApplyAngularVelocityJacobianAction( const double angularVelocityVariation, mfem::Vector &action ) const { VerifyPrepared(); MFEM_VERIFY(std::isfinite(angularVelocityVariation), "Angular-velocity direction is non-finite."); action.SetSize(1); action(0) = m_momentOfInertia * angularVelocityVariation; ++m_actionStatistics.angularVelocityApplications; } void PreparedAngularMomentumOperator::ApplyCompleteJacobianAction( const mfem::Vector &densityVariation, const mfem::Vector &displacementVariation, const double angularVelocityVariation, mfem::Vector &action ) const { VerifyPrepared(); MFEM_VERIFY( densityVariation.Size() == m_gravityContext.GetDensityMap().reduced_size() && displacementVariation.Size() == m_gravityContext.GetDisplacementMap().reduced_size(), "Angular-momentum complete action has incompatible reduced coordinates." ); validate_finite_vector(densityVariation, "Angular-momentum density direction is non-finite."); validate_finite_vector(displacementVariation, "Angular-momentum displacement direction is non-finite."); MFEM_VERIFY(std::isfinite(angularVelocityVariation), "Angular-velocity direction is non-finite."); m_gravityContext.GetDensityMap().scatter(densityVariation, m_densityVariationTrue); m_gravityContext.GetDisplacementMap().scatter(displacementVariation, m_displacementVariationTrue); const double localMomentAction = EvaluateDensityMomentActionLocal(m_densityVariationTrue) + EvaluateDisplacementMomentActionLocal(m_displacementVariationTrue); action.SetSize(1); action(0) = m_angularVelocity * GlobalSum(localMomentAction) + m_momentOfInertia * angularVelocityVariation; ++m_actionStatistics.completeApplications; } double PreparedAngularMomentumOperator::CylindricalRadiusSquared( const mfem::Vector &physicalPosition ) const noexcept { const auto &axis = m_constraint.specification().axis(); const auto ¢er = m_constraint.specification().center(); double radiusSquared = 0.0; double axialPosition = 0.0; for (int component = 0; component < 3; ++component) { const double relative = physicalPosition(component) - center[static_cast(component)]; radiusSquared += relative * relative; axialPosition += axis[static_cast(component)] * relative; } return std::max(0.0, radiusSquared - axialPosition * axialPosition); } double PreparedAngularMomentumOperator::CylindricalRadiusSquaredVariation( const mfem::Vector &physicalPosition, const mfem::Vector &physicalPositionVariation ) const noexcept { const auto &axis = m_constraint.specification().axis(); const auto ¢er = m_constraint.specification().center(); double relativeDotVariation = 0.0; double axialPosition = 0.0; double axialVariation = 0.0; for (int component = 0; component < 3; ++component) { const double relative = physicalPosition(component) - center[static_cast(component)]; relativeDotVariation += relative * physicalPositionVariation(component); axialPosition += axis[static_cast(component)] * relative; axialVariation += axis[static_cast(component)] * physicalPositionVariation(component); } return 2.0 * (relativeDotVariation - axialPosition * axialVariation); } double PreparedAngularMomentumOperator::GlobalSum(const double localValue) const { double globalValue = 0.0; MPI_Allreduce(&localValue, &globalValue, 1, MPI_DOUBLE, MPI_SUM, m_fem.mesh->GetComm()); return globalValue; } bool PreparedAngularMomentumOperator::IsPrepared() const noexcept { if (!m_isPrepared || !m_gravityContext.IsPrepared()) { return false; } const auto &revisions = m_gravityContext.GetRevisions(); return revisions.discretization.value == m_preparedDependencies.discretization.revision && revisions.density.value == m_preparedDependencies.density.revision && revisions.displacement.value == m_preparedDependencies.displacement.revision; } double PreparedAngularMomentumOperator::GetMomentOfInertia() const { VerifyPrepared(); return m_momentOfInertia; } double PreparedAngularMomentumOperator::GetAngularVelocity() const { VerifyPrepared(); return m_angularVelocity; } double PreparedAngularMomentumOperator::GetCurrentAngularMomentum() const { VerifyPrepared(); return m_currentAngularMomentum; } double PreparedAngularMomentumOperator::GetTargetAngularMomentum() const noexcept { return m_constraint.targetAngularMomentum().value(); } physics::RigidRotation PreparedAngularMomentumOperator::GetRotation() const { VerifyPrepared(); return m_constraint.makeRotation(m_angularVelocity); } AngularMomentumConstraintReport PreparedAngularMomentumOperator::GetConstraintReport() const { VerifyPrepared(); const double target = GetTargetAngularMomentum(); const double residual = m_currentAngularMomentum - target; return { .targetAngularMomentum = target, .achievedAngularMomentum = m_currentAngularMomentum, .momentOfInertia = m_momentOfInertia, .angularVelocity = m_angularVelocity, .dimensionalResidual = residual, .scaledResidual = residual / std::max(std::abs(target), 1.0e-300) }; } std::uint64_t PreparedAngularMomentumOperator::GetPreparationCount() const noexcept { return m_preparationCount; } std::uint64_t PreparedAngularMomentumOperator::GetResidualApplicationCount() const noexcept { return m_residualApplicationCount; } const PreparedAngularMomentumActionStatistics & PreparedAngularMomentumOperator::GetActionStatistics() const noexcept { return m_actionStatistics; } const models::CompiledFixedAngularMomentum & PreparedAngularMomentumOperator::GetCompiledConstraint() const noexcept { return m_constraint; } void PreparedAngularMomentumOperator::VerifyPrepared() const { MFEM_VERIFY(IsPrepared(), "The angular-momentum invariant must be prepared before application."); } } // namespace mean_field::operators