SpECTRE  v2025.08.19
Tags Namespace Reference

Contains objects related to Tags. More...

Classes

struct  AdaptiveSteppingDiagnostics
 
struct  Analytic
 Prefix indicating the analytic solution value for a quantity. More...
 
struct  AnalyticData
 The analytic data, with the type of the analytic data set as the template parameter. More...
 
struct  AnalyticSolution
 The analytic solution, with the type of the analytic solution set as the template parameter. More...
 
struct  AnalyticSolutions
 The analytic solution of the FieldTags. More...
 
struct  ConcreteTimeStepper
 The evolution TimeStepper. The template parameter should be one of the time stepper base classes, such as TimeStepper or LtsTimeStepper. More...
 
struct  DataBox
 Tag used to retrieve the DataBox from the db::get function. More...
 
struct  deriv
 Prefix indicating spatial derivatives. More...
 
struct  DerivCompute
 Compute the spatial derivatives of tags in a Variables. More...
 
struct  DerivTensorCompute
 Computes the spatial derivative of a single tensor tag not in a Variables. More...
 
struct  div
 Prefix indicating the divergence. More...
 
struct  DivVariablesCompute
 Compute the divergence of a Variables. More...
 
struct  DivVectorCompute
 Compute the divergence of a tnsr::I (vector) More...
 
struct  dt
 Prefix indicating a time derivative. More...
 
struct  Error
 The error of the Tag defined as numerical - analytic. More...
 
struct  Errors
 The error of the FieldTags, defined as numerical - analytic. More...
 
struct  ErrorsCompute< tmpl::list< FieldTags... > >
 Compute tag for computing the error from the Tags::Analytic of the FieldTags. More...
 
struct  EuclideanMagnitude
 The Euclidean magnitude of a (co)vector. More...
 
struct  EventsAndDenseTriggers
 The Events to run based on DenseTriggers. More...
 
struct  EventsAndTriggers
 Contains the events and triggers. More...
 
struct  EventsRunAtCleanup
 Events to be run on elements during the Parallel::Phase::PostFailureCleanup phase. More...
 
struct  EventsRunAtCleanupObservationValue
 Observation value for Actions::RunEventsOnFailure. More...
 
struct  FixedLtsRatio
 Tag forcing a constant step size over a region in an LTS evolution. More...
 
struct  FixedSource
 Prefix indicating a source term that is independent of dynamic variables. More...
 
struct  Flux
 Prefix indicating a flux. More...
 
struct  HistoryEvolvedVariables
 Tag for the TimeStepper history. More...
 
struct  Initial
 Prefix indicating the initial value of a quantity. More...
 
struct  L2Norm
 
struct  L2NormCompute
 
struct  Limiter
 The global cache tag for the limiter. More...
 
struct  Magnitude
 The magnitude of a (co)vector. More...
 
struct  make_temp_tensor
 A struct that constructs a TempTensor given a label N and type TensorType. Call with make_temp_tensor<N>::apply<Type> More...
 
struct  Mean
 Given the Tag holding a Tensor<DataVector, ...>, swap the DataVector with a double. More...
 
struct  MinimumTimeStep
 The minimum step size without triggering an error. More...
 
struct  Modal
 Given the NodalTag holding a Tensor<DataVector, ...>, swap the DataVector with a ModalVector. More...
 
struct  Mortars
 Data on mortars, indexed by a DirectionalId. More...
 
struct  MortarSize
 Size of a mortar, relative to the element face. That is, the part of the face that it covers. More...
 
struct  Multiplies
 A prefix tag representing the product of two other tags. Note that if non-spin-weighted types are needed in this tag, the type alias detail::product_t should be generalized to give a reasonable type for those cases, or template specializations should be constructed for this tag. More...
 
struct  Next
 Prefix indicating the value a quantity will take on the next iteration of the algorithm. More...
 
struct  NonEuclideanMagnitude
 The magnitude of a (co)vector with respect to a specific metric. More...
 
struct  NormalDotFlux
 Prefix indicating a boundary unit normal vector dotted into the flux. More...
 
struct  NormalDotNumericalFlux
 Prefix indicating a boundary unit normal vector dotted into the numerical flux. More...
 
struct  Normalized
 The normalized (co)vector represented by Tag. More...
 
struct  NormalizedCompute
 Normalizes the (co)vector represented by Tag. More...
 
struct  NumericalFlux
 The global cache tag for the numerical flux. More...
 
struct  ObservationBox
 Tag used to retrieve the ObservationBox from the get() function. More...
 
struct  PointwiseL2Norm
 
struct  PointwiseL2NormCompute
 
struct  Previous
 Prefix indicating the value a quantity took in the previous iteration of the algorithm. More...
 
struct  PreviousTriggerTime
 Previous time at which the trigger activated. More...
 
struct  second_deriv
 Prefix indicating symmetric second spatial derivatives. More...
 
struct  Source
 Prefix indicating a source term. More...
 
struct  spacetime_deriv
 Prefix indicating spacetime derivatives. More...
 
struct  SpinWeighted
 Given a Tag with a type of Tensor<VectorType, ...>, acts as a new version of the tag with type of Tensor<SpinWeighted<VectorType, SpinConstant::value>, ...>, which is the preferred tensor type associated with spin-weighted quantities. Here, SpinConstant must be a std::integral_constant or similar type wrapper for a compile-time constant, in order to work properly with DataBox utilities. More...
 
struct  StepChoosers
 Tag for a vector of StepChoosers. More...
 
struct  StepNumberWithinSlab
 Number of time step taken within a Slab. More...
 
struct  StepperErrorEstimatesEnabled
 A tag that is true if the time stepper should be run in error estimation mode. More...
 
struct  StepperErrorEstimatesEnabledCompute
 Searches the StepChoosers for any requesting error estimates. More...
 
struct  StepperErrors
 Tag for the stepper error measures. More...
 
struct  StepperErrorTolerances
 Tag for the stepper error tolerances. More...
 
struct  StepperErrorTolerancesCompute
 A tag that contains the error tolerances if any StepChooser requests an error estimate for the variable. More...
 
struct  Subitem
 a reference tag that refers to a particular Tag that is a subitem of an item tagged with ParentTag More...
 
struct  Subitem< FacesSubitemTag, FacesComputeTag, Requires< std::is_base_of_v< domain::Tags::Faces< FacesComputeTag::volume_dim, typename FacesComputeTag::tag >, FacesComputeTag > > >
 Specialization of a subitem tag for a compute tag that inherits off domain::Tags::Faces.
 
struct  Subitem<::domain::Tags::Interface< DirectionsTag, TensorTag >, ::domain::Tags::InterfaceCompute< DirectionsTag, VariablesTag > >
 specialization of a subitem tag for an interface compute tag of a Variables More...
 
struct  Subitem<::domain::Tags::Interface< DirectionsTag, TensorTag >, ::domain::Tags::Slice< DirectionsTag, VariablesTag > >
 specialization of a subitem tag for an interface compute tag of a sliced Variables More...
 
struct  TempTensor
 
struct  Time
 Tag for the current time as a double. More...
 
struct  TimeAndPrevious
 Tag for the current and previous time as doubles. More...
 
struct  TimeAndPreviousCompute
 
struct  TimeStep
 Tag for step size. More...
 
struct  TimeStepId
 Tag for TimeStepId for the algorithm state. More...
 
struct  TimeStepper
 Access to a time stepper through the StepperInterface interface (such as TimeStepper or LtsTimeStepper). More...
 
struct  TimeStepperRef
 Reference tag to provide access to the time stepper through its provided interfaces, such as Tags::TimeStepper<TimeStepper> and Tags::TimeStepper<LtsTimeStepper>. Usually added through the time_stepper_ref_tags alias. More...
 
struct  VariableFixer
 The global cache tag for the variable fixer. More...
 
struct  VariableOrderAlgorithm
 Algorithm for changing the time-stepper order in a variable-order evolution. More...
 
struct  Variables
 

Typedefs

template<size_t index, int spin>
using TempSpinWeightedScalar = SpinWeighted< TempScalar< index, ComplexDataVector >, std::integral_constant< int, spin > >
 Succinct alias for often-used nodal spin-weighted temp tag.
 
template<size_t index, int spin>
using ModalTempSpinWeightedScalar = SpinWeighted< TempScalar< index, ComplexModalVector >, std::integral_constant< int, spin > >
 Succinct alias for often-used modal spin-weighted temp tag.
 
template<typename List , size_t N>
using convert_to_temp_tensors = tmpl::transform< List, typename make_temp_tensor< N >::template apply< tmpl::_1 > >
 Takes a tmpl::list of Tensor types and a label N which is applied to all TempTensors in the resulting list. More...
 
template<typename TagList >
using get_all_history_tags = tmpl::filter< TagList, tt::is_a<::Tags::HistoryEvolvedVariables, tmpl::_1 > >
 From a list of tags TagList, extract all tags that are template specializations of HistoryEvolvedVariables.
 
template<size_t N, typename DataType = DataVector>
using TempScalar = TempTensor< N, Scalar< DataType > >
 Variables Tags for temporary tensors inside a function.
 
template<size_t N, size_t SpatialDim, typename Fr = Frame::Inertial, typename DataType = DataVector>
using Tempa = TempTensor< N, tnsr::a< DataType, SpatialDim, Fr > >
 Variables Tags for temporary tensors inside a function.
 
template<size_t N, size_t SpatialDim, typename Fr = Frame::Inertial, typename DataType = DataVector>
using TempA = TempTensor< N, tnsr::A< DataType, SpatialDim, Fr > >
 Variables Tags for temporary tensors inside a function.
 
template<size_t N, size_t SpatialDim, typename Fr = Frame::Inertial, typename DataType = DataVector>
using Tempi = TempTensor< N, tnsr::i< DataType, SpatialDim, Fr > >
 Variables Tags for temporary tensors inside a function.
 
template<size_t N, size_t SpatialDim, typename Fr = Frame::Inertial, typename DataType = DataVector>
using TempI = TempTensor< N, tnsr::I< DataType, SpatialDim, Fr > >
 Variables Tags for temporary tensors inside a function.
 
template<size_t N, size_t SpatialDim, typename Fr = Frame::Inertial, typename DataType = DataVector>
using Tempab = TempTensor< N, tnsr::ab< DataType, SpatialDim, Fr > >
 Variables Tags for temporary tensors inside a function.
 
template<size_t N, size_t SpatialDim, typename Fr = Frame::Inertial, typename DataType = DataVector>
using TempaB = TempTensor< N, tnsr::aB< DataType, SpatialDim, Fr > >
 Variables Tags for temporary tensors inside a function.
 
template<size_t N, size_t SpatialDim, typename Fr = Frame::Inertial, typename DataType = DataVector>
using TempAb = TempTensor< N, tnsr::Ab< DataType, SpatialDim, Fr > >
 Variables Tags for temporary tensors inside a function.
 
template<size_t N, size_t SpatialDim, typename Fr = Frame::Inertial, typename DataType = DataVector>
using TempAB = TempTensor< N, tnsr::AB< DataType, SpatialDim, Fr > >
 Variables Tags for temporary tensors inside a function.
 
template<size_t N, size_t SpatialDim, typename Fr = Frame::Inertial, typename DataType = DataVector>
using Tempij = TempTensor< N, tnsr::ij< DataType, SpatialDim, Fr > >
 Variables Tags for temporary tensors inside a function.
 
template<size_t N, size_t SpatialDim, typename Fr = Frame::Inertial, typename DataType = DataVector>
using TempiJ = TempTensor< N, tnsr::iJ< DataType, SpatialDim, Fr > >
 Variables Tags for temporary tensors inside a function.
 
template<size_t N, size_t SpatialDim, typename Fr = Frame::Inertial, typename DataType = DataVector>
using TempIj = TempTensor< N, tnsr::Ij< DataType, SpatialDim, Fr > >
 Variables Tags for temporary tensors inside a function.
 
template<size_t N, size_t SpatialDim, typename Fr = Frame::Inertial, typename DataType = DataVector>
using TempIJ = TempTensor< N, tnsr::IJ< DataType, SpatialDim, Fr > >
 Variables Tags for temporary tensors inside a function.
 
template<size_t N, size_t SpatialDim, typename Fr = Frame::Inertial, typename DataType = DataVector>
using Tempia = TempTensor< N, tnsr::ia< DataType, SpatialDim, Fr > >
 Variables Tags for temporary tensors inside a function.
 
template<size_t N, size_t SpatialDim, typename Fr = Frame::Inertial, typename DataType = DataVector>
using Tempaa = TempTensor< N, tnsr::aa< DataType, SpatialDim, Fr > >
 Variables Tags for temporary tensors inside a function.
 
template<size_t N, size_t SpatialDim, typename Fr = Frame::Inertial, typename DataType = DataVector>
using TempAA = TempTensor< N, tnsr::AA< DataType, SpatialDim, Fr > >
 Variables Tags for temporary tensors inside a function.
 
template<size_t N, size_t SpatialDim, typename Fr = Frame::Inertial, typename DataType = DataVector>
using Tempii = TempTensor< N, tnsr::ii< DataType, SpatialDim, Fr > >
 Variables Tags for temporary tensors inside a function.
 
template<size_t N, size_t SpatialDim, typename Fr = Frame::Inertial, typename DataType = DataVector>
using TempII = TempTensor< N, tnsr::II< DataType, SpatialDim, Fr > >
 Variables Tags for temporary tensors inside a function.
 
template<size_t N, size_t SpatialDim, typename Fr = Frame::Inertial, typename DataType = DataVector>
using Tempijj = TempTensor< N, tnsr::ijj< DataType, SpatialDim, Fr > >
 Variables Tags for temporary tensors inside a function.
 
template<size_t N, size_t SpatialDim, typename Fr = Frame::Inertial, typename DataType = DataVector>
using TempIjj = TempTensor< N, tnsr::Ijj< DataType, SpatialDim, Fr > >
 Variables Tags for temporary tensors inside a function.
 
template<size_t N, size_t SpatialDim, typename Fr = Frame::Inertial, typename DataType = DataVector>
using Tempijk = TempTensor< N, tnsr::ijk< DataType, SpatialDim, Fr > >
 Variables Tags for temporary tensors inside a function.
 
template<size_t N, size_t SpatialDim, typename Fr = Frame::Inertial, typename DataType = DataVector>
using TempiJk = TempTensor< N, tnsr::iJk< DataType, SpatialDim, Fr > >
 Variables Tags for temporary tensors inside a function.
 
template<size_t N, size_t SpatialDim, typename Fr = Frame::Inertial, typename DataType = DataVector>
using TempijK = TempTensor< N, tnsr::ijK< DataType, SpatialDim, Fr > >
 Variables Tags for temporary tensors inside a function.
 
template<size_t N, size_t SpatialDim, typename Fr = Frame::Inertial, typename DataType = DataVector>
using Tempiii = TempTensor< N, tnsr::iii< DataType, SpatialDim, Fr > >
 Variables Tags for temporary tensors inside a function.
 
template<size_t N, size_t SpatialDim, typename Fr = Frame::Inertial, typename DataType = DataVector>
using Tempiaa = TempTensor< N, tnsr::iaa< DataType, SpatialDim, Fr > >
 Variables Tags for temporary tensors inside a function.
 
template<size_t N, size_t SpatialDim, typename Fr = Frame::Inertial, typename DataType = DataVector>
using TempIaa = TempTensor< N, tnsr::Iaa< DataType, SpatialDim, Fr > >
 Variables Tags for temporary tensors inside a function.
 
template<size_t N, size_t SpatialDim, typename Fr = Frame::Inertial, typename DataType = DataVector>
using TempiaB = TempTensor< N, tnsr::iaB< DataType, SpatialDim, Fr > >
 Variables Tags for temporary tensors inside a function.
 
template<size_t N, size_t SpatialDim, typename Fr = Frame::Inertial, typename DataType = DataVector>
using Tempabb = TempTensor< N, tnsr::abb< DataType, SpatialDim, Fr > >
 Variables Tags for temporary tensors inside a function.
 
template<size_t N, size_t SpatialDim, typename Fr = Frame::Inertial, typename DataType = DataVector>
using TempabC = TempTensor< N, tnsr::abC< DataType, SpatialDim, Fr > >
 Variables Tags for temporary tensors inside a function.
 
template<size_t N, size_t SpatialDim, typename Fr = Frame::Inertial, typename DataType = DataVector>
using Tempijaa = TempTensor< N, tnsr::ijaa< DataType, SpatialDim, Fr > >
 Variables Tags for temporary tensors inside a function.
 

Detailed Description

Contains objects related to Tags.

Typedef Documentation

◆ convert_to_temp_tensors

template<typename List , size_t N>
using Tags::convert_to_temp_tensors = typedef tmpl::transform<List, typename make_temp_tensor<N>::template apply<tmpl::_1> >

Takes a tmpl::list of Tensor types and a label N which is applied to all TempTensors in the resulting list.

See also
make_temp_tensor