SpECTRE  v2024.04.12
Direction< VolumeDim > Class Template Reference

A particular Side along a particular coordinate Axis. More...

#include <Direction.hpp>

Public Member Functions

 Direction (Axis axis, Side side)
 Construct by specifying an Axis and a Side.
 
 Direction (size_t dimension, Side side)
 Construct by specifying a dimension and a Side.
 
 Direction ()
 Default constructor for Charm++ serialization.
 
size_t dimension () const
 The dimension of the Direction.
 
Axis axis () const
 The Axis of the Direction.
 
Side side () const
 The side of the Direction.
 
double sign () const
 The sign for the normal to the Side.
 
Direction< VolumeDim > opposite () const
 The opposite Direction.
 
void pup (PUP::er &p)
 Serialization for Charm++.
 

Static Public Member Functions

static const std::array< Direction< VolumeDim >, 2 *VolumeDim > & all_directions ()
 
static Direction< VolumeDim > lower_xi ()
 Helper functions for creating specific Directions. These are labeled by the logical-coordinate names (Xi,Eta,Zeta).
 
static Direction< VolumeDim > upper_xi ()
 Helper functions for creating specific Directions. These are labeled by the logical-coordinate names (Xi,Eta,Zeta).
 
static Direction< VolumeDim > lower_eta ()
 Helper functions for creating specific Directions. These are labeled by the logical-coordinate names (Xi,Eta,Zeta).
 
static Direction< VolumeDim > upper_eta ()
 Helper functions for creating specific Directions. These are labeled by the logical-coordinate names (Xi,Eta,Zeta).
 
static Direction< VolumeDim > lower_zeta ()
 Helper functions for creating specific Directions. These are labeled by the logical-coordinate names (Xi,Eta,Zeta).
 
static Direction< VolumeDim > upper_zeta ()
 Helper functions for creating specific Directions. These are labeled by the logical-coordinate names (Xi,Eta,Zeta).
 

Static Public Attributes

static constexpr const size_t volume_dim = VolumeDim
 

Detailed Description

template<size_t VolumeDim>
class Direction< VolumeDim >

A particular Side along a particular coordinate Axis.


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