SHiP::FieldMapGrid Struct Reference

Equidistant Cartesian grid in the map's local frame. More...

#include <FieldMap.h>

Public Member Functions
std::size_t	size () const
	Number of nodes, n[0] * n[1] * n[2].
std::size_t	index (std::size_t i, std::size_t j, std::size_t k) const
	Flat index of node (i, j, k): x-major, z fastest.
double	node (std::size_t axis, std::size_t i) const
	Position (mm) of node i on axis axis.

Public Attributes
std::array< double, 3 >	min {}
std::array< double, 3 >	max {}
std::array< std::uint32_t, 3 >	n {}

Detailed Description

Equidistant Cartesian grid in the map's local frame.

Axis a has n[a] nodes; node i sits at min[a] + i * (max[a] - min[a]) / (n[a] - 1), so both ends are nodes. Lengths in mm.

Member Function Documentation

index()

std::size_t SHiP::FieldMapGrid::index ( std::size_t  i, std::size_t  j, std::size_t  k  ) const

inline

Flat index of node (i, j, k): x-major, z fastest.

node()

double SHiP::FieldMapGrid::node	(	std::size_t	axis,
		std::size_t	i
	)		const

Position (mm) of node i on axis axis.

size()

std::size_t SHiP::FieldMapGrid::size

(

)

const

Number of nodes, n[0] * n[1] * n[2].

Member Data Documentation

max

std::array<double, 3> SHiP::FieldMapGrid::max {}

min

std::array<double, 3> SHiP::FieldMapGrid::min {}

n

std::array<std::uint32_t, 3> SHiP::FieldMapGrid::n {}

---

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

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