SHiP::FieldMapSymmetry Struct Reference

Reflection symmetry. More...

#include <FieldMap.h>

Public Member Functions
bool	any () const

Static Public Member Functions
static FieldMapSymmetry	quadrantDipole ()
	FairShip's quadrant-symmetric dipole (ShipBFieldMap with isSymmetric): mirrored in x and y; Bx flips sign under both reflections, Bz flips under y, By is even.

Public Attributes
std::array< bool, 3 >	mirror {}
std::array< std::int8_t, 9 >	parity {1, 1, 1, 1, 1, 1, 1, 1, 1}

Detailed Description

Reflection symmetry.

A mirrored axis stores only coordinates >= 0 (its grid starts at 0); a query at a negative coordinate on that axis is evaluated at the reflected point and component c is multiplied by parity[3 * axis + c] (+1 or -1). Rows of non-mirrored axes are ignored.

Member Function Documentation

any()

bool SHiP::FieldMapSymmetry::any ( ) const

inline

quadrantDipole()

FieldMapSymmetry SHiP::FieldMapSymmetry::quadrantDipole ( )

static

FairShip's quadrant-symmetric dipole (ShipBFieldMap with isSymmetric): mirrored in x and y; Bx flips sign under both reflections, Bz flips under y, By is even.

Member Data Documentation

mirror

std::array<bool, 3> SHiP::FieldMapSymmetry::mirror {}

parity

std::array<std::int8_t, 9> SHiP::FieldMapSymmetry::parity {1, 1, 1, 1, 1, 1, 1, 1, 1}

---

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

• include/SHiP/FieldService/FieldMap.h
• src/FieldMap.cpp