domain::Tags::RadiallyCompressedCoordinatesCompute< Dim, CoordsFrame, RadialDim > Struct Template Reference

Coordinates suitable for visualizing large radii by compressing them logarithmically or inversely. More...

#include <RadiallyCompressedCoordinates.hpp>

Public Types
using	base = RadiallyCompressedCoordinates<Dim, CoordsFrame>
using	return_type = tnsr::I<DataVector, Dim, CoordsFrame>
using	argument_tags
Public Types inherited from domain::Tags::RadiallyCompressedCoordinates< Dim, CoordsFrame >
using	type = tnsr::I<DataVector, Dim, CoordsFrame>

Static Public Member Functions
static void	function (const gsl::not_null< tnsr::I< DataVector, Dim, CoordsFrame > * > result, const tnsr::I< DataVector, Dim, CoordsFrame > &coords, const std::optional< domain::RadiallyCompressedCoordinatesOptions > &options)

Detailed Description

template<size_t Dim, typename CoordsFrame, typename RadialDim = void>
struct domain::Tags::RadiallyCompressedCoordinatesCompute< Dim, CoordsFrame, RadialDim >

Coordinates suitable for visualizing large radii by compressing them logarithmically or inversely.

The coordinate map reduces to the identity if no options for radially compressed coordinates were specified in the input file.

The template parameter RadialDim on the compute tag determines which dimensions to compress. If RadialDim is void, all dimensions are compressed radially (Cartesian coordinates). If RadialDim is a tmpl::size_t, only that dimension is compressed.

See also

radially_compressed_coordinates

Member Typedef Documentation

argument_tags

template<size_t Dim, typename CoordsFrame, typename RadialDim = void>

using domain::Tags::RadiallyCompressedCoordinatesCompute< Dim, CoordsFrame, RadialDim >::argument_tags

Initial value:

 tmpl::list<Tags::Coordinates<Dim, CoordsFrame>,
                                   Tags::RadiallyCompressedCoordinatesOptions>

---

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

• src/Domain/RadiallyCompressedCoordinates.hpp