Detailed Description

Class for calculating the index to given 3d position within the structured grid.

Definition at line 23 of file IndexCalculator.h.

#include <IndexCalculator.h>

Public Member Functions
	IndexCalculator (std::size_t x_dim, std::size_t y_dim, std::size_t z_dim)
	IndexCalculator ()=default
std::size_t	operator() (std::array< std::size_t, 3 > const &c) const
std::size_t	getCellIdx (std::size_t u, std::size_t v, std::size_t w) const
std::array< std::size_t, 3 >	getCoordsForID (std::size_t id) const

Public Attributes
std::size_t	_x_dim {0}
std::size_t	_y_dim {0}
std::size_t	_z_dim {0}
std::size_t	_n_nodes {0}
std::size_t	_n_cells {0}

Constructor & Destructor Documentation

◆ IndexCalculator() [1/2]

FileIO::Gocad::IndexCalculator::IndexCalculator	(	std::size_t	x_dim,
		std::size_t	y_dim,
		std::size_t	z_dim )

inline

Constructor initializes the dimensions.

Parameters

x_dim
y_dim
z_dim

Definition at line 32 of file IndexCalculator.h.

        : _x_dim(x_dim),
          _y_dim(y_dim),
          _z_dim(z_dim),
          _n_nodes(x_dim * y_dim * z_dim),
          _n_cells((_x_dim - 1) * (_y_dim - 1) * (_z_dim - 1))
    {
    }

References _n_cells, _n_nodes, _x_dim, _y_dim, and _z_dim.

◆ IndexCalculator() [2/2]

FileIO::Gocad::IndexCalculator::IndexCalculator ( )

default

Member Function Documentation

◆ getCellIdx()

std::size_t FileIO::Gocad::IndexCalculator::getCellIdx	(	std::size_t	u,
		std::size_t	v,
		std::size_t	w ) const

inline

Definition at line 53 of file IndexCalculator.h.

    {
        // ensure (u,v,w) is a valid cell
        if (u >= _x_dim - 1 || v >= _y_dim - 1 || w >= _z_dim - 1)
        {
            ERR("GocadSGridReader::IndexCalculator::getCellIdx(): At least "
                "one grid coordinate to big.");
            ERR("\t Given: ({:d}, {:d}, {:d}), max allowed cell grid coords: "
                "({:d}, {:d}, {:d}).",
                u, v, w, _x_dim - 1, _y_dim - 1, _z_dim - 1);
            return std::numeric_limits<std::size_t>::max();
        }
 
        return (_x_dim - 1) * (_y_dim - 1) + v * (_x_dim - 1) + u;
    }

References _x_dim, _y_dim, _z_dim, and ERR().

◆ getCoordsForID()

std::array< std::size_t, 3 > FileIO::Gocad::IndexCalculator::getCoordsForID ( std::size_t id ) const

inline

Definition at line 69 of file IndexCalculator.h.

    {
        std::array<std::size_t, 3> const coords{
            (id % (_x_dim * _y_dim)) % _x_dim,
            (id % (_x_dim * _y_dim)) / _x_dim, id / (_x_dim * _y_dim)};
        return coords;
    }

References _x_dim, and _y_dim.

◆ operator()()

std::size_t FileIO::Gocad::IndexCalculator::operator() ( std::array< std::size_t, 3 > const & c ) const

inline

Definition at line 43 of file IndexCalculator.h.

    {
        const std::size_t idx(c[2] * _x_dim * _y_dim + c[1] * _x_dim + c[0]);
        if (idx >= _n_nodes)
        {
            return std::numeric_limits<std::size_t>::max();
        }
        return idx;
    }