Discontinuous Galerkin Library
#include "dg/algorithm.h"
dg::aRealGeometry2d< real_type > Struct Template Referenceabstract

This is the abstract interface class for a two-dimensional Geometry. More...

Inheritance diagram for dg::aRealGeometry2d< real_type >:
[legend]

Public Member Functions

SparseTensor< thrust::host_vector< real_type > > jacobian () const
 The Jacobian of the coordinate transformation from physical to computational space. More...
 
SparseTensor< thrust::host_vector< real_type > > metric () const
 The (inverse) metric tensor of the coordinate system. More...
 
std::vector< thrust::host_vector< real_type > > map () const
 The coordinate map from computational to physical space. More...
 
virtual aRealGeometry2dclone () const =0
 Geometries are cloneable. More...
 
virtual ~aRealGeometry2d ()=default
 allow deletion through base class pointer More...
 
- Public Member Functions inherited from dg::aRealTopology2d< real_type >
real_type x0 () const
 Left boundary in x. More...
 
real_type x1 () const
 Right boundary in x. More...
 
real_type y0 () const
 left boundary in y More...
 
real_type y1 () const
 Right boundary in y. More...
 
real_type lx () const
 length of x More...
 
real_type ly () const
 length of y More...
 
real_type hx () const
 cell size in x More...
 
real_type hy () const
 cell size in y More...
 
unsigned n () const
 number of polynomial coefficients in x More...
 
unsigned nx () const
 number of polynomial coefficients in x More...
 
unsigned ny () const
 number of polynomial coefficients in y More...
 
unsigned Nx () const
 number of cells in x More...
 
unsigned Ny () const
 number of cells in y More...
 
bc bcx () const
 boundary conditions in x More...
 
bc bcy () const
 boundary conditions in y More...
 
const DLT< real_type > & dltx () const
 discrete legendre trafo More...
 
const DLT< real_type > & dlty () const
 discrete legendre transformation in y More...
 
const RealGrid1d< real_type > & gx () const
 The x-axis grid. More...
 
const RealGrid1d< real_type > & gy () const
 The y-axis grid. More...
 
void multiplyCellNumbers (real_type fx, real_type fy)
 Multiply the number of cells with a given factor. More...
 
void set (unsigned new_n, unsigned new_Nx, unsigned new_Ny)
 Set the number of polynomials and cells. More...
 
void set (unsigned new_nx, unsigned new_Nx, unsigned new_ny, unsigned new_Ny)
 Set the number of polynomials and cells. More...
 
unsigned size () const
 The total number of points. More...
 
void display (std::ostream &os=std::cout) const
 Display. More...
 
void shift (bool &negative, real_type &x, real_type &y) const
 Shift any point coordinate to a corresponding grid coordinate according to the boundary condition. More...
 
void shift (bool &negative, real_type &x, real_type &y, bc bcx, bc bcy) const
 Shift any point coordinate to a corresponding grid coordinate according to the boundary condition. More...
 
bool contains (real_type x, real_type y) const
 Check if the grid contains a point. More...
 
template<class Vector >
bool contains (const Vector &x) const
 Shortcut for contains( x[0], x[1]) More...
 

Protected Member Functions

 aRealGeometry2d (const aRealGeometry2d &src)=default
 
aRealGeometry2doperator= (const aRealGeometry2d &src)=default
 
- Protected Member Functions inherited from dg::aRealTopology2d< real_type >
 ~aRealTopology2d ()=default
 disallow destruction through base class pointer More...
 
 aRealTopology2d (RealGrid1d< real_type > gx, RealGrid1d< real_type > gy)
 Construct a 2d grid as the product of two 1d grids. More...
 
 aRealTopology2d (const aRealTopology2d &src)=default
 
aRealTopology2doperator= (const aRealTopology2d &src)=default
 
virtual void do_set (unsigned new_nx, unsigned new_Nx, unsigned new_ny, unsigned new_Ny)=0
 

Additional Inherited Members

- Public Types inherited from dg::aRealTopology2d< real_type >
using value_type = real_type
 
using host_vector = thrust::host_vector< real_type >
 The host vector type used by host functions like evaluate. More...
 
using host_grid = RealGrid2d< real_type >
 

Detailed Description

template<class real_type>
struct dg::aRealGeometry2d< real_type >

This is the abstract interface class for a two-dimensional Geometry.

Constructor & Destructor Documentation

◆ ~aRealGeometry2d()

template<class real_type >
virtual dg::aRealGeometry2d< real_type >::~aRealGeometry2d ( )
virtualdefault

allow deletion through base class pointer

◆ aRealGeometry2d()

template<class real_type >
dg::aRealGeometry2d< real_type >::aRealGeometry2d ( const aRealGeometry2d< real_type > &  src)
protecteddefault

explicit copy constructor (default)

Parameters
srcsource

Member Function Documentation

◆ clone()

template<class real_type >
virtual aRealGeometry2d * dg::aRealGeometry2d< real_type >::clone ( ) const
pure virtual

◆ jacobian()

template<class real_type >
SparseTensor< thrust::host_vector< real_type > > dg::aRealGeometry2d< real_type >::jacobian ( ) const
inline

The Jacobian of the coordinate transformation from physical to computational space.

The elements of the Tensor are (if x,y are the coordinates in computational space and R,Z are the physical space coordinates)

\[ J = \begin{pmatrix} x_R(x,y) & x_Z(x,y) \\ y_R(x,y) & y_Z(x,y) \end{pmatrix} \]

Returns
Jacobian
Note
per default this will be the identity tensor

◆ map()

template<class real_type >
std::vector< thrust::host_vector< real_type > > dg::aRealGeometry2d< real_type >::map ( ) const
inline

The coordinate map from computational to physical space.

The elements of the map are (if x,y are the coordinates in computational space and R,Z are the physical space coordinates)

\[ R(x,y) \\ Z(x,y) \]

Returns
a vector of size 2
Note
per default this will be the identity map

◆ metric()

template<class real_type >
SparseTensor< thrust::host_vector< real_type > > dg::aRealGeometry2d< real_type >::metric ( ) const
inline

The (inverse) metric tensor of the coordinate system.

The elements of the inverse metric tensor are the contravariant elements of the metric \(g\). If x,y are the coordinates, then

\[ g^{-1} = \begin{pmatrix} g^{xx}(x,y) & g^{xy}(x,y) \\ & g^{yy}(x,y) \end{pmatrix} \]

Returns
symmetric tensor
Note
use the dg::tensor::volume2d function to compute the volume element from here
per default this will be the identity tensor

◆ operator=()

template<class real_type >
aRealGeometry2d & dg::aRealGeometry2d< real_type >::operator= ( const aRealGeometry2d< real_type > &  src)
protecteddefault

explicit assignment operator (default)

Parameters
srcsource

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