Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
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) noexcept
 Construct by specifying an Axis and a Side.
 
 Direction (size_t dimension, Side side) noexcept
 Construct by specifying a dimension and a Side.
 
 Direction () noexcept
 Default constructor for Charm++ serialization.
 
size_t dimension () const noexcept
 The dimension of the Direction.
 
Axis axis () const noexcept
 The Axis of the Direction.
 
Side side () const noexcept
 The side of the Direction.
 
double sign () const noexcept
 The sign for the normal to the Side.
 
Direction< VolumeDim > opposite () const noexcept
 The opposite Direction.
 
void pup (PUP::er &p) noexcept
 Serialization for Charm++.
 

Static Public Member Functions

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

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: