This is the abstract interface class for a three-dimensional RealGeometryX. More...
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 aRealGeometryX3d * | clone () const =0 |
| Geometries are cloneable. More... | |
| virtual | ~aRealGeometryX3d ()=default |
| allow deletion through base class pointer More... | |
 Public Member Functions inherited from dg::aRealTopologyX3d< 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 | z0 () const |
| left boundary in z More... | |
| real_type | z1 () const |
| right boundary in z More... | |
| real_type | lx () const |
| length in x More... | |
| real_type | ly () const |
| length in y More... | |
| real_type | lz () const |
| length in z More... | |
| real_type | hx () const |
| cell size in x More... | |
| real_type | hy () const |
| cell size in y More... | |
| real_type | hz () const |
| cell size in z More... | |
| real_type | fx () const |
| partition factor in x More... | |
| real_type | fy () const |
| partition factor in y More... | |
| unsigned | n () const |
| number of polynomial coefficients in x and y More... | |
| unsigned | Nx () const |
| number of points in x More... | |
| unsigned | inner_Nx () const |
| number of topological cells in x More... | |
| unsigned | outer_Nx () const |
| number of smooth rows in x More... | |
| unsigned | Ny () const |
| number of cells in y More... | |
| unsigned | inner_Ny () const |
| number of cells in the inner region of y More... | |
| unsigned | outer_Ny () const |
| number of cells in one of the outer regions of y More... | |
| unsigned | Nz () const |
| number of points in z More... | |
| bc | bcx () const |
| boundary conditions in x More... | |
| bc | bcy () const |
| boundary conditions in y More... | |
| bc | bcz () const |
| boundary conditions in z More... | |
| RealGrid3d< real_type > | grid () const |
| Return a copy without topology. More... | |
| const DLT< real_type > & | dlt () const |
| discrete legendre transformation More... | |
| unsigned | size () const |
| real_typehe total number of points More... | |
| void | display (std::ostream &os=std::cout) const |
| Display. More... | |
| bool | contains (real_type x, real_type y, real_type z) const |
| Check if the grid contains a point. More... | |
Protected Member Functions | |
| aRealGeometryX3d (const aRealGeometryX3d &src)=default | |
| aRealGeometryX3d & | operator= (const aRealGeometryX3d &src)=default |
| Protected Member Functions inherited from dg::aRealTopologyX3d< real_type > | |
| ~aRealTopologyX3d ()=default | |
| disallow destruction through base class pointer More... | |
| aRealTopologyX3d (real_type x0, real_type x1, real_type y0, real_type y1, real_type z0, real_type z1, real_type fx, real_type fy, unsigned n, unsigned Nx, unsigned Ny, unsigned Nz, bc bcx, bc bcy, bc bcz) | |
| Construct a 3D X-point grid. More... | |
| aRealTopologyX3d (const aRealTopologyX3d &src)=default | |
| aRealTopologyX3d & | operator= (const aRealTopologyX3d &src)=default |
Additional Inherited Members | |
| Public Types inherited from dg::aRealTopologyX3d< 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 = RealGridX3d< real_type > |
Detailed Description
struct dg::aRealGeometryX3d< real_type >
This is the abstract interface class for a three-dimensional RealGeometryX.
Constructor & Destructor Documentation
◆ ~aRealGeometryX3d()
|
virtualdefault |
allow deletion through base class pointer
◆ aRealGeometryX3d()
|
protecteddefault |
explicit copy constructor (default)
- Parameters
-
src source
Member Function Documentation
◆ clone()
|
pure virtual |
Geometries are cloneable.
Implemented in dg::RealCartesianRefinedGridX3d< real_type >, and dg::RealCartesianGridX3d< real_type >.
◆ jacobian()
|
inline |
The Jacobian of the coordinate transformation from physical to computational space.
The elements of the Tensor are (if x,y,z are the coordinates in computational space and R,Z,P are the physical space coordinates)
\[ J = \begin{pmatrix} x_R(x,y,z) & x_Z(x,y,z) & x_\varphi(x,y,z) \\ y_R(x,y,z) & y_Z(x,y,z) & y_\varphi(x,y,z) \\ z_R(x,y,z) & z_Z(x,y,z) & z_\varphi(x,y,z) \end{pmatrix} \]
- Returns
- Jacobian
- Note
- per default this will be the identity tensor
◆ map()
|
inline |
The coordinate map from computational to physical space.
The elements of the map are (if x,y,z are the coordinates in computational space and R,Z,P are the physical space coordinates)
\[ R(x,y,z) \\ Z(x,y,z) \\ \varphi(x,y,z) \]
- Returns
- a vector of size 3
- Note
- per default this will be the identity map
◆ metric()
|
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,z are the coordinates, then
\[ g^{-1} = \begin{pmatrix} g^{xx}(x,y,z) & g^{xy}(x,y,z) & g^{zz}(x,y,z)\\ & g^{yy}(x,y,z) & g^{yz}(x,y,z) \\ & & g^{zz}(x,y,z)\end{pmatrix} \]
- Returns
- symmetric tensor
- Note
- use the
dg::tensor::volumefunction to compute the volume element from here - per default this will be the identity tensor
◆ operator=()
|
protecteddefault |
explicit assignment operator (default)
- Parameters
-
src source
The documentation for this struct was generated from the following file:
- topology/base_geometryX.h
