Class GridCoord

Defined in File grid.h

Inheritance Relationships

Base Type

public kami::Coord (Class Coord)

Derived Types

public kami::GridCoord1D (Class GridCoord1D)
public kami::GridCoord2D (Class GridCoord2D)

Class Documentation

class GridCoord : public kami::Coord 

An abstract for gridded coordinates.

All gridded coordinates are expected to subclass GridCoord.

Subclassed by kami::GridCoord1D, kami::GridCoord2D

Public Functions

virtual double distance(std::shared_ptr<Coord> &p) const = 0

Find the distance between two points.

Find the distance between two points using the specified metric.

However, the coordinate class is not aware of the properties of the GridDomain it is operating on. Accordingly, if the direct path is measured, without accounting for and toroidal wrapping of the underlying GridDomain.

Parameters: p – the point to measure the distance to
Returns: the distance as a double