SpECTRE  v2026.04.01
Loading...
Searching...
No Matches
domain::Tags::JacobianDiagnosticCompute< Dim, TargetFrame > Struct Template Reference

Computes the Jacobian diagnostic, which compares the analytic Jacobian (provided by some coordinate map) to a numerical Jacobian computed using numerical partial derivatives. The coordinates must be in the target frame of the map. See domain::jacobian_diagnostic for details of the calculation. More...

#include <JacobianDiagnostic.hpp>

Public Types

using base = JacobianDiagnostic<Dim>
using return_type = typename base::type
using argument_tags
Public Types inherited from domain::Tags::JacobianDiagnostic< Dim >
using type = tnsr::i<DataVector, Dim, typename Frame::ElementLogical>

Static Public Attributes

static constexpr auto function

Detailed Description

template<size_t Dim, typename TargetFrame>
struct domain::Tags::JacobianDiagnosticCompute< Dim, TargetFrame >

Computes the Jacobian diagnostic, which compares the analytic Jacobian (provided by some coordinate map) to a numerical Jacobian computed using numerical partial derivatives. The coordinates must be in the target frame of the map. See domain::jacobian_diagnostic for details of the calculation.

Member Typedef Documentation

◆ argument_tags

template<size_t Dim, typename TargetFrame>
using domain::Tags::JacobianDiagnosticCompute< Dim, TargetFrame >::argument_tags
Initial value:
tmpl::list<
The coordinates in a given frame.
Definition Tags.hpp:85
The Jacobian from the source frame to the target frame.
Definition Tags.hpp:157
The computational grid of the Element in the DataBox.
Definition Tags.hpp:62

Member Data Documentation

◆ function

template<size_t Dim, typename TargetFrame>
auto domain::Tags::JacobianDiagnosticCompute< Dim, TargetFrame >::function
staticconstexpr
Initial value:
= static_cast<void (*)(
tnsr::i<DataVector, Dim, typename Frame::ElementLogical>*>,
const ::Jacobian<DataVector, Dim, Frame::ElementLogical, TargetFrame>&,
const tnsr::I<DataVector, Dim, TargetFrame>&, const ::Mesh<Dim>&)>(
Require a pointer to not be a nullptr
Definition Gsl.hpp:197
void jacobian_diagnostic(const gsl::not_null< tnsr::i< DataVector, Dim, typename Frame::ElementLogical > * > jacobian_diag, const Jacobian< DataVector, Dim, typename Frame::ElementLogical, Fr > &analytic_jacobian, const TensorMetafunctions::prepend_spatial_index< tnsr::I< DataVector, Dim, Fr >, Dim, UpLo::Lo, typename Frame::ElementLogical > &numeric_jacobian_transpose)
A diagnostic comparing the analytic and numerical Jacobians for a map.

The documentation for this struct was generated from the following file:
  • src/Domain/JacobianDiagnostic.hpp