Direction Class Reference

#include <MultiFabRegister.H>

Public Member Functions
constexpr	Direction (int d)
	Direction (std::string const &s)
	Direction (char const *c)
	Direction (char const c)
	Direction (const Direction &)=default
	Direction (Direction &&)=default
bool	operator< (const Direction &other) const
	operator std::string () const
	~Direction ()=default
Direction &	operator= (const Direction &)=default
Direction &	operator= (Direction &&)=default
	operator int () const

Static Public Attributes
static const Direction	r = Direction{0}
static const Direction	theta = Direction{1}
static const Direction	x = Direction{0}
static const Direction	y = Direction{1}
static const Direction	z = Direction{2}

Private Attributes
int	dir = 0

Detailed Description

Components (base vector directions) of vector/tensor fields.

Because of different staggering, the components of vector/tensor fields are stored in separate (i)MultiFab.

Cartesian: always x,y,z in any ND RZ: r,t(heta),z (r,z over azimuthal modes) RCylinder: r,t(heta),z RSphere: r,t(heta),p(hi)

See also

https://warpx.readthedocs.io/en/latest/developers/dimensionality.html

Todo

: synchronize with AMReX "enum class Direction"

Constructor & Destructor Documentation

Direction() [1/6]

ablastr::fields::Direction::Direction ( int d )

inlineexplicitconstexpr

Direction() [2/6]

ablastr::fields::Direction::Direction ( std::string const & s )

inline

Direction() [3/6]

ablastr::fields::Direction::Direction ( char const * c )

inline

Direction() [4/6]

ablastr::fields::Direction::Direction ( char const c )

inline

Direction() [5/6]

ablastr::fields::Direction::Direction ( const Direction & )

default

Direction() [6/6]

ablastr::fields::Direction::Direction ( Direction && )

default

~Direction()

ablastr::fields::Direction::~Direction ( )

default

Member Function Documentation

operator int()

ablastr::fields::Direction::operator int ( ) const

inline

operator std::string()

ablastr::fields::Direction::operator std::string ( ) const

inline

operator<()

bool ablastr::fields::Direction::operator< ( const Direction & other ) const

inline

operator=() [1/2]

Direction & ablastr::fields::Direction::operator= ( const Direction & )

default

operator=() [2/2]

Direction & ablastr::fields::Direction::operator= ( Direction && )

default

Member Data Documentation

dir

int ablastr::fields::Direction::dir = 0

private

r

Direction ablastr::fields::Direction::r = Direction{0}

inlinestaticconstexpr

theta

Direction ablastr::fields::Direction::theta = Direction{1}

inlinestaticconstexpr

x

Direction ablastr::fields::Direction::x = Direction{0}

inlinestaticconstexpr

y

Direction ablastr::fields::Direction::y = Direction{1}

inlinestaticconstexpr

z

Direction ablastr::fields::Direction::z = Direction{2}

inlinestaticconstexpr

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/6102/Source/ablastr/fields/MultiFabRegister.H