Extension: Geometries
#include "dg/geometries/geometries.h"
dg::geo::aCylindricalFunctor< Derived > Struct Template Reference

Represent functions written in cylindrical coordinates that are independent of the angle phi serving as both 2d and 3d functions. More...

Public Member Functions

double operator() (double R, double Z) const
  do_compute(R,Z) More...
 
double operator() (double R, double Z, double phi) const
  do_compute(R,Z) More...
 

Detailed Description

template<class Derived>
struct dg::geo::aCylindricalFunctor< Derived >

Represent functions written in cylindrical coordinates that are independent of the angle phi serving as both 2d and 3d functions.

The rational is that these functors can serve as both 2d and 3d functors where the 3d functor trivially redirects to the 2d version. This behaviour is injected into all classes that derive from this class via the Curiously Recurring Template Pattern (CRTP).

See also
aCylindricalFunctor
An alternative is RealCylindricalFunctor
Template Parameters
DerivedInterface: double do_compute(double,double) const

Member Function Documentation

◆ operator()() [1/2]

template<class Derived >
double dg::geo::aCylindricalFunctor< Derived >::operator() ( double  R,
double  Z 
) const
inline

do_compute(R,Z)

Parameters
Rradius (cylindrical coordinate)
Zheight (cylindrical coordinate)
Returns
f(R,Z)

◆ operator()() [2/2]

template<class Derived >
double dg::geo::aCylindricalFunctor< Derived >::operator() ( double  R,
double  Z,
double  phi 
) const
inline

do_compute(R,Z)

Parameters
Rradius (cylindrical coordinate)
Zheight (cylindrical coordinate)
phiangle (cylindrical coordinate)
Returns
f(R,Z)

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