SpECTRE Documentation Coverage Report
Current view: top level - PointwiseFunctions/GeneralRelativity/GeneralizedHarmonic - TimeDerivOfLowerShift.hpp Hit Total Coverage
Commit: 664546099c4dbf27a1b708fac45e39c82dd743d2 Lines: 2 3 66.7 %
Date: 2024-04-19 16:28:01
Legend: Lines: hit not hit

          Line data    Source code
       1           0 : // Distributed under the MIT License.
       2             : // See LICENSE.txt for details.
       3             : 
       4             : #pragma once
       5             : 
       6             : #include <cstddef>
       7             : 
       8             : #include "DataStructures/DataBox/Prefixes.hpp"
       9             : #include "DataStructures/DataBox/Tag.hpp"
      10             : #include "DataStructures/DataVector.hpp"
      11             : #include "DataStructures/Tensor/Tensor.hpp"
      12             : #include "Evolution/Systems/GeneralizedHarmonic/Tags.hpp"
      13             : #include "NumericalAlgorithms/LinearOperators/PartialDerivatives.hpp"
      14             : #include "PointwiseFunctions/GeneralRelativity/Tags.hpp"
      15             : #include "Utilities/ContainerHelpers.hpp"
      16             : #include "Utilities/Gsl.hpp"
      17             : #include "Utilities/TMPL.hpp"
      18             : 
      19             : // IWYU pragma: no_forward_declare Tags::deriv
      20             : 
      21             : /// \cond
      22             : namespace domain {
      23             : namespace Tags {
      24             : template <size_t Dim, typename Frame>
      25             : struct Coordinates;
      26             : }  // namespace Tags
      27             : }  // namespace domain
      28             : class DataVector;
      29             : template <typename X, typename Symm, typename IndexList>
      30             : class Tensor;
      31             : /// \endcond
      32             : 
      33             : namespace gh {
      34             : /// @{
      35             : /*!
      36             :  * \ingroup GeneralRelativityGroup
      37             :  * \brief Computes time derivative of index lowered shift from generalized
      38             :  *        harmonic variables, spatial metric and its time derivative.
      39             :  *
      40             :  * \details The time derivative of \f$ \beta_i \f$ is given by:
      41             :  * \f{align*}
      42             :  *  \partial_0 \beta_i =
      43             :  *      \gamma_{ij} \partial_0 \beta^j + \beta^j \partial_0 \gamma_{ij}
      44             :  * \f}
      45             :  * where the first term is obtained from `time_deriv_of_shift()`, and the latter
      46             :  * is a user input.
      47             :  */
      48             : template <typename DataType, size_t SpatialDim, typename Frame>
      49           1 : void time_deriv_of_lower_shift(
      50             :     gsl::not_null<tnsr::i<DataType, SpatialDim, Frame>*> dt_lower_shift,
      51             :     const Scalar<DataType>& lapse,
      52             :     const tnsr::I<DataType, SpatialDim, Frame>& shift,
      53             :     const tnsr::ii<DataType, SpatialDim, Frame>& spatial_metric,
      54             :     const tnsr::A<DataType, SpatialDim, Frame>& spacetime_unit_normal,
      55             :     const tnsr::iaa<DataType, SpatialDim, Frame>& phi,
      56             :     const tnsr::aa<DataType, SpatialDim, Frame>& pi);
      57             : 
      58             : template <typename DataType, size_t SpatialDim, typename Frame>
      59           1 : tnsr::i<DataType, SpatialDim, Frame> time_deriv_of_lower_shift(
      60             :     const Scalar<DataType>& lapse,
      61             :     const tnsr::I<DataType, SpatialDim, Frame>& shift,
      62             :     const tnsr::ii<DataType, SpatialDim, Frame>& spatial_metric,
      63             :     const tnsr::A<DataType, SpatialDim, Frame>& spacetime_unit_normal,
      64             :     const tnsr::iaa<DataType, SpatialDim, Frame>& phi,
      65             :     const tnsr::aa<DataType, SpatialDim, Frame>& pi);
      66             : /// @}
      67             : }  // namespace gh

Generated by: LCOV version 1.14