Class GridProperties

Inheritance Relationships

Base Type

Class Documentation

class GridProperties : public Referenced

Combines parameters that uniquely define Grid class.

Public Functions

inline GridProperties(Vector3d origin, size_t N, double spacing)

Constructor for cubic grid

Parameters:

  • origin – Position of the lower left front corner of the volume

  • N – Number of grid points in one direction

  • spacing – Spacing between grid points

inline GridProperties(Vector3d origin, size_t Nx, size_t Ny, size_t Nz, double spacing)

Constructor for non-cubic grid

Parameters:

  • origin – Position of the lower left front corner of the volume

  • Nx – Number of grid points in x-direction

  • Ny – Number of grid points in y-direction

  • Nz – Number of grid points in z-direction

  • spacing – Spacing between grid points

inline GridProperties(Vector3d origin, size_t Nx, size_t Ny, size_t Nz, Vector3d spacing)

Constructor for non-cubic grid with spacing vector

Parameters:

  • origin – Position of the lower left front corner of the volume

  • Nx – Number of grid points in x-direction

  • Ny – Number of grid points in y-direction

  • Nz – Number of grid points in z-direction

  • spacing – Spacing vector between grid points

inline virtual ~GridProperties()
inline void setReflective(bool b)

If True, the repetition of the grid is refletive instead of periodic.

inline void setInterpolationType(interpolationType i)

set the type of interpolation between grid points.

Parameters:

i – interpolationType (TRILINEAR, TRICUBIC, NEAREST_NEIGHBOUR)

inline void setClipVolume(bool b)

If True, the grid is set to zero outside of the volume.

inline size_t addReference() const
inline size_t removeReference() const
inline int removeReferenceNoDelete() const
inline size_t getReferenceCount() const

Public Members

size_t Nx
size_t Ny
size_t Nz
Vector3d origin
Vector3d spacing
bool reflective
interpolationType ipol
bool clipVolume

Protected Attributes

mutable size_t _referenceCount