Gyselalib++
CoordinateConverter< CoordinateStart, CoordinateEnd > Class Template Referenceabstract

An operator to convert from the start coordinate type to the end coordinate type. More...

Inheritance diagram for CoordinateConverter< CoordinateStart, CoordinateEnd >:
CartesianToBarycentricCoordinates< Tag1, Tag2, Corner1Tag, Corner2Tag, Corner3Tag > CartesianToBarycentricCoordinates< Tag1, Tag2, Corner1Tag, Corner2Tag, Corner3Tag >

Public Member Functions

virtual KOKKOS_FUNCTION CoordinateEnd operator() (CoordinateStart const &coord) const =0
 Convert the coordinate to the equivalent coordinate in a different coordinate system. More...
 

Detailed Description

template<class CoordinateStart, class CoordinateEnd>
class CoordinateConverter< CoordinateStart, CoordinateEnd >

An operator to convert from the start coordinate type to the end coordinate type.

All operators which can convert between coordinates should inherit from this class.

Template Parameters
CoordinateStartThe type of the coordinate to be converted from.
CoordinateEndThe type of the coordinate to be converted to.

Member Function Documentation

◆ operator()()

template<class CoordinateStart , class CoordinateEnd >
virtual KOKKOS_FUNCTION CoordinateEnd CoordinateConverter< CoordinateStart, CoordinateEnd >::operator() ( CoordinateStart const &  coord) const
pure virtual

Convert the coordinate to the equivalent coordinate in a different coordinate system.

Parameters
[in]coordThe coordinate to be converted.
Returns
The equivalent coordinate.

Implemented in CzarnyToCartesian< X, Y, R, Theta >, CircularToCartesian< X, Y, R, Theta >, CartesianToBarycentricCoordinates< X, Y, Corner1Tag, Corner2Tag, Corner3Tag >, and CartesianToBarycentricCoordinates< X, Y, Corner1Tag, Corner2Tag, Corner3Tag >.


The documentation for this class was generated from the following file: