A 2D grid class with X-point topology. More...

Inheritance diagram for dg::aRealTopologyX2d< real_type >:

Public Types
using	value_type = real_type

using	host_vector = thrust::host_vector<real_type>
	The host vector type used by host functions like evaluate.

using	host_grid = RealGridX2d<real_type>

Public Member Functions
host_vector	abscissas (unsigned u=0) const

host_vector	weights (unsigned u=0) const

unsigned	shape (unsigned u=0) const

auto	get_shape () const

real_type	x0 () const
	Left boundary in x.

real_type	x1 () const
	Right boundary in x.

real_type	y0 () const
	left boundary in y

real_type	y1 () const
	Right boundary in y.

real_type	lx () const
	length of x

real_type	ly () const
	length of y

real_type	hx () const
	cell size in x

real_type	hy () const
	cell size in y

real_type	fx () const
	partition factor in x

real_type	fy () const
	partition factor in y

unsigned	n () const
	number of polynomial coefficients in x and y

unsigned	Nx () const
	number of cells in x

unsigned	inner_Nx () const
	number of topological cells in x

unsigned	outer_Nx () const
	number of smooth rows in x

unsigned	Ny () const
	number of cells in y

unsigned	inner_Ny () const
	number of cells in the inner region of y

unsigned	outer_Ny () const
	number of cells in one of the outer regions of y

bc	bcx () const
	boundary conditions in x

bc	bcy () const
	boundary conditions in y

RealGrid< real_type, 2 >	grid () const
	Return a copy without topology.

unsigned	size () const
	real_typehe total number of points

void	display (std::ostream &os=std::cout) const
	Display.

void	shift_topologic (real_type x0, real_type y0, real_type &x1, real_type &y1) const
	Shifts a point coordinate due to topology.

bool	contains (real_type x, real_type y) const
	Check if the grid contains a point.

Static Public Member Functions
static constexpr unsigned	ndim ()
	number of dimensions : 2

Protected Member Functions
	~aRealTopologyX2d ()=default
	disallow destruction through base class pointer

	aRealTopologyX2d ()=default

	aRealTopologyX2d (real_type x0, real_type x1, real_type y0, real_type y1, real_type fx, real_type fy, unsigned n, unsigned Nx, unsigned Ny, bc bcx, bc bcy)
	Construct a 2D X-point grid.

	aRealTopologyX2d (const aRealTopologyX2d &src)=default

aRealTopologyX2d &	operator= (const aRealTopologyX2d &src)=default

Detailed Description

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

A 2D grid class with X-point topology.

is of the form

| -----> y
|  |---x----------x---|
|  |---x----------x---|
v  |--- ---------- ---|
x  |--- ---------- ---| fx*lx
   |--- ---------- ---|
   fy*ly

Member Typedef Documentation

◆ host_grid

template<class real_type >

using dg::aRealTopologyX2d< real_type >::host_grid = RealGridX2d<real_type>

◆ host_vector

template<class real_type >

using dg::aRealTopologyX2d< real_type >::host_vector = thrust::host_vector<real_type>

The host vector type used by host functions like evaluate.

◆ value_type

template<class real_type >

using dg::aRealTopologyX2d< real_type >::value_type = real_type

Constructor & Destructor Documentation

◆ ~aRealTopologyX2d()

template<class real_type >

dg::aRealTopologyX2d< real_type >::~aRealTopologyX2d ( )

protecteddefault

disallow destruction through base class pointer

◆ aRealTopologyX2d() [1/3]

template<class real_type >

dg::aRealTopologyX2d< real_type >::aRealTopologyX2d ( )

protecteddefault

◆ aRealTopologyX2d() [2/3]

template<class real_type >

dg::aRealTopologyX2d< real_type >::aRealTopologyX2d	(	real_type	x0,
		real_type	x1,
		real_type	y0,
		real_type	y1,
		real_type	fx,
		real_type	fy,
		unsigned	n,
		unsigned	Nx,
		unsigned	Ny,
		bc	bcx,
		bc	bcy )

inlineprotected

Construct a 2D X-point grid.

Parameters

x0	left boundary in x
x1	right boundary in x
y0	lower boundary in y
y1	upper boundary in y
fx	factor for the partition in x-direction (fx*Nx will be rounded)
fy	factor for the partition in y-direction (fy*Ny will be rounded)
n	# of polynomial coefficients per dimension (1<=n<=20, note that the library is optimized for n=3 )
Nx	# of points in x
Ny	# of points in y

Parameters

bcx	boundary condition in x
bcy	boundary condition in y

◆ aRealTopologyX2d() [3/3]

template<class real_type >

dg::aRealTopologyX2d< real_type >::aRealTopologyX2d ( const aRealTopologyX2d< real_type > & src )

protecteddefault

explicit copy constructor (default)

Parameters

src source

Member Function Documentation

◆ abscissas()

template<class real_type >

host_vector dg::aRealTopologyX2d< real_type >::abscissas ( unsigned u = 0 ) const

inline

◆ bcx()

template<class real_type >

bc dg::aRealTopologyX2d< real_type >::bcx ( ) const

inline

boundary conditions in x

Returns

◆ bcy()

template<class real_type >

bc dg::aRealTopologyX2d< real_type >::bcy ( ) const

inline

boundary conditions in y

Returns

◆ contains()

template<class real_type >

bool dg::aRealTopologyX2d< real_type >::contains	(	real_type	x,
		real_type	y ) const

inline

Check if the grid contains a point.

Note: doesn't check periodicity!!

Parameters

x	x-point to check
y	y-point to check

Returns: true if x0()<=x<=x1() and y0()<=y<=y1(), false else

◆ display()

template<class real_type >

void dg::aRealTopologyX2d< real_type >::display ( std::ostream & os = std::cout ) const

inline

Display.

Parameters

os	output stream

◆ fx()

template<class real_type >

real_type dg::aRealTopologyX2d< real_type >::fx ( ) const

inline

partition factor in x

Returns

◆ fy()

template<class real_type >

real_type dg::aRealTopologyX2d< real_type >::fy ( ) const

inline

partition factor in y

Returns

◆ get_shape()

template<class real_type >

auto dg::aRealTopologyX2d< real_type >::get_shape ( ) const

inline

◆ grid()

template<class real_type >

RealGrid< real_type, 2 > dg::aRealTopologyX2d< real_type >::grid ( ) const

inline

Return a copy without topology.

Returns

◆ hx()

template<class real_type >

real_type dg::aRealTopologyX2d< real_type >::hx ( ) const

inline

cell size in x

Returns

◆ hy()

template<class real_type >

real_type dg::aRealTopologyX2d< real_type >::hy ( ) const

inline

cell size in y

Returns

◆ inner_Nx()

template<class real_type >

unsigned dg::aRealTopologyX2d< real_type >::inner_Nx ( ) const

inline

number of topological cells in x

Returns

◆ inner_Ny()

template<class real_type >

unsigned dg::aRealTopologyX2d< real_type >::inner_Ny ( ) const

inline

number of cells in the inner region of y

Returns

◆ lx()

template<class real_type >

real_type dg::aRealTopologyX2d< real_type >::lx ( ) const

inline

length of x

Returns

◆ ly()

template<class real_type >

real_type dg::aRealTopologyX2d< real_type >::ly ( ) const

inline

length of y

Returns

◆ n()

template<class real_type >

unsigned dg::aRealTopologyX2d< real_type >::n ( ) const

inline

number of polynomial coefficients in x and y

Returns

◆ ndim()

template<class real_type >

static constexpr unsigned dg::aRealTopologyX2d< real_type >::ndim ( )

inlinestaticconstexpr

number of dimensions : 2

◆ Nx()

template<class real_type >

unsigned dg::aRealTopologyX2d< real_type >::Nx ( ) const

inline

number of cells in x

Returns

◆ Ny()

template<class real_type >

unsigned dg::aRealTopologyX2d< real_type >::Ny ( ) const

inline

number of cells in y

Returns

◆ operator=()

template<class real_type >

aRealTopologyX2d & dg::aRealTopologyX2d< real_type >::operator= ( const aRealTopologyX2d< real_type > & src )

protecteddefault

explicit assignment operator (default)

Parameters

src source

◆ outer_Nx()

template<class real_type >

unsigned dg::aRealTopologyX2d< real_type >::outer_Nx ( ) const

inline

number of smooth rows in x

Returns

◆ outer_Ny()

template<class real_type >

unsigned dg::aRealTopologyX2d< real_type >::outer_Ny ( ) const

inline

number of cells in one of the outer regions of y

Returns

◆ shape()

template<class real_type >

unsigned dg::aRealTopologyX2d< real_type >::shape ( unsigned u = 0 ) const

inline

◆ shift_topologic()

template<class real_type >

void dg::aRealTopologyX2d< real_type >::shift_topologic	(	real_type	x0,
		real_type	y0,
		real_type &	x1,
		real_type &	y1 ) const

inline

Shifts a point coordinate due to topology.

If you want to construct a point by adding (delta X, delta Y) to a given point (x0, y0) then the resulting coordinate x1 might be incorrect due to topologic reasons (periodic boundaries). This function corrects this coordinate

Parameters

x0	starting x-point (must lie inside of the grid)
y0	starting y-point (must lie inside of the grid)
x1	end x-point (inout)
y1	end y-point (inout)

◆ size()

template<class real_type >

unsigned dg::aRealTopologyX2d< real_type >::size ( ) const

inline

real_typehe total number of points

Returns: n*n*Nx*Ny

◆ weights()

template<class real_type >

host_vector dg::aRealTopologyX2d< real_type >::weights ( unsigned u = 0 ) const

inline

◆ x0()

template<class real_type >

real_type dg::aRealTopologyX2d< real_type >::x0 ( ) const

inline

Left boundary in x.

Returns

◆ x1()

template<class real_type >

real_type dg::aRealTopologyX2d< real_type >::x1 ( ) const

inline

Right boundary in x.

Returns

◆ y0()

template<class real_type >

real_type dg::aRealTopologyX2d< real_type >::y0 ( ) const

inline

left boundary in y

Returns

◆ y1()

template<class real_type >

real_type dg::aRealTopologyX2d< real_type >::y1 ( ) const

inline

Right boundary in y.

Returns

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

topology/gridX.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ host_grid

◆ host_vector

◆ value_type

Constructor & Destructor Documentation

◆ ~aRealTopologyX2d()

◆ aRealTopologyX2d() [1/3]

◆ aRealTopologyX2d() [2/3]

◆ aRealTopologyX2d() [3/3]

Member Function Documentation

◆ abscissas()

◆ bcx()

◆ bcy()

◆ contains()

◆ display()

◆ fx()

◆ fy()

◆ get_shape()

◆ grid()

◆ hx()

◆ hy()

◆ inner_Nx()

◆ inner_Ny()

◆ lx()

◆ ly()

◆ n()

◆ ndim()

◆ Nx()

◆ Ny()

◆ operator=()

◆ outer_Nx()

◆ outer_Ny()

◆ shape()

◆ shift_topologic()

◆ size()

◆ weights()

◆ x0()

◆ x1()

◆ y0()

◆ y1()