olb::HyperplaneLattice2D< T > Class Template Reference

Parametrization of a hyperplane lattice (i.e. a line lattice). More...

#include <hyperplaneLattice2D.h>

Inheritance diagram for olb::HyperplaneLattice2D< T >:

Collaboration diagram for olb::HyperplaneLattice2D< T >:

Public Member Functions
	HyperplaneLattice2D (CuboidGeometry2D< T > &geometry, Hyperplane2D< T > hyperplane)
	Constructor for automatic discretization.
	HyperplaneLattice2D (CuboidGeometry2D< T > &geometry, Hyperplane2D< T > hyperplane, int resolution)
	Constructor for discretization of a given resolution.
	HyperplaneLattice2D (CuboidGeometry2D< T > &geometry, Hyperplane2D< T > hyperplane, T h)
	Constructor for discretization of a given grid width.
	HyperplaneLattice2D (const HyperplaneLattice2D &)=default
const Hyperplane2D< T > &	getHyperplane () const
Vector< T, 2 >	getPhysR (const int &n) const
	Transform 1d lattice coordinates to their physical 2d location.
int	getN () const
T	getPhysSpacing () const
Vector< T, 2 >	getPhysOrigin () const
Vector< T, 2 >	getVectorU () const

Protected Attributes
const Hyperplane2D< T >	_hyperplane
Vector< T, 2 >	_origin
	Origin vector of the lattice.
Vector< T, 2 >	_u
	Direction vector of the lattice, normalized to grid width _h.
T	_h
	Distance between discrete lattice points.
int	_n
	Number of lattice points in the direction of _u.

Detailed Description

template<typename T>
class olb::HyperplaneLattice2D< T >

Parametrization of a hyperplane lattice (i.e. a line lattice).

This class provides a common interface for describing how to discretize the intersection of a hyperplane given by Hyperplane2D<T> and the mother cuboid of CuboidGeometry2D<T>.

Definition at line 39 of file hyperplaneLattice2D.h.

Constructor & Destructor Documentation

HyperplaneLattice2D() [1/4]

template<typename T >

olb::HyperplaneLattice2D< T >::HyperplaneLattice2D	(	CuboidGeometry2D< T > &	geometry,
		Hyperplane2D< T >	hyperplane )

Constructor for automatic discretization.

i.e. the grid width is set to CuboidGeometry2D<T>::getMinDeltaR.

Definition at line 103 of file hyperplaneLattice2D.hh.

  : _geometry(geometry),
    _hyperplane(hyperplane),
    _origin(hyperplane.origin),
    _u(hyperplane.u),
    _h(geometry.getMinDeltaR())
{
  _u = normalize(_u, _h);
 
  const int maxLatticeDistance = computeMaxLatticeDistance();
  // compute _hyperplane.origin, _nx, _ny so that the cuboid is right inside the geometry
  constructCuboid(maxLatticeDistance);
}

References olb::HyperplaneLattice2D< T >::_h, olb::HyperplaneLattice2D< T >::_u, and olb::normalize().

Here is the call graph for this function:

HyperplaneLattice2D() [2/4]

template<typename T >

olb::HyperplaneLattice2D< T >::HyperplaneLattice2D	(	CuboidGeometry2D< T > &	geometry,
		Hyperplane2D< T >	hyperplane,
		int	resolution )

Constructor for discretization of a given resolution.

Definition at line 119 of file hyperplaneLattice2D.hh.

  : _geometry(geometry),
    _hyperplane(hyperplane),
    _origin(hyperplane.origin),
    _u(hyperplane.u),
    _h(geometry.getMinDeltaR())
{
  _u = normalize(_u, _h);
 
  const int maxLatticeDistance = computeMaxLatticeDistance();
  // compute _hyperplane.origin, _nx, _ny so that the cuboid is right inside the geometry
  constructCuboid(maxLatticeDistance);
 
  if ( resolution > 0 ) {
    setToResolution(resolution);
  }
}

References olb::HyperplaneLattice2D< T >::_h, olb::HyperplaneLattice2D< T >::_u, and olb::normalize().

Here is the call graph for this function:

HyperplaneLattice2D() [3/4]

template<typename T >

olb::HyperplaneLattice2D< T >::HyperplaneLattice2D	(	CuboidGeometry2D< T > &	geometry,
		Hyperplane2D< T >	hyperplane,
		T	h )

Constructor for discretization of a given grid width.

Definition at line 139 of file hyperplaneLattice2D.hh.

  : _geometry(geometry),
    _hyperplane(hyperplane),
    _origin(hyperplane.origin),
    _u(hyperplane.u),
    _h(h)
{
  if ( util::nearZero(_h) ) {
    _h = _geometry.getMinDeltaR();
  }
 
  _u = normalize(_u, _h);
 
  const int maxLatticeDistance = computeMaxLatticeDistance();
  // compute _hyperplane.origin, _nx, _ny so that the cuboid is right inside the geometry
  constructCuboid(maxLatticeDistance);
}

References olb::HyperplaneLattice2D< T >::_h, olb::HyperplaneLattice2D< T >::_u, olb::util::nearZero(), and olb::normalize().

Here is the call graph for this function:

HyperplaneLattice2D() [4/4]

template<typename T >

olb::HyperplaneLattice2D< T >::HyperplaneLattice2D ( const HyperplaneLattice2D< T > & )

default

Member Function Documentation

getHyperplane()

template<typename T >

const Hyperplane2D< T > & olb::HyperplaneLattice2D< T >::getHyperplane

(

)

const

Definition at line 159 of file hyperplaneLattice2D.hh.

{
  return _hyperplane;
}

Here is the caller graph for this function:

getN()

template<typename T >

int olb::HyperplaneLattice2D< T >::getN

(

)

const

Returns

_n

Definition at line 174 of file hyperplaneLattice2D.hh.

{
  return _n;
}

getPhysOrigin()

template<typename T >

Vector< T, 2 > olb::HyperplaneLattice2D< T >::getPhysOrigin

(

)

const

Returns

_origin

Definition at line 186 of file hyperplaneLattice2D.hh.

{
  return _origin;
}

getPhysR()

template<typename T >

Vector< T, 2 > olb::HyperplaneLattice2D< T >::getPhysR

(

const int &

n

)

const

Transform 1d lattice coordinates to their physical 2d location.

Definition at line 165 of file hyperplaneLattice2D.hh.

{
  return Vector<T,2> {
    _origin[0] + T(n)*_u[0],
    _origin[1] + T(n)*_u[1]
  };
}

getPhysSpacing()

template<typename T >

T olb::HyperplaneLattice2D< T >::getPhysSpacing

(

)

const

Returns

_h

Definition at line 180 of file hyperplaneLattice2D.hh.

{
  return _h;
}

Here is the caller graph for this function:

getVectorU()

template<typename T >

Vector< T, 2 > olb::HyperplaneLattice2D< T >::getVectorU

(

)

const

Returns

_u

Definition at line 192 of file hyperplaneLattice2D.hh.

{
  return _u;
}

Member Data Documentation

_h

template<typename T >

T olb::HyperplaneLattice2D< T >::_h

protected

Distance between discrete lattice points.

Definition at line 64 of file hyperplaneLattice2D.h.

_hyperplane

template<typename T >

const Hyperplane2D<T> olb::HyperplaneLattice2D< T >::_hyperplane

protected

Definition at line 51 of file hyperplaneLattice2D.h.

_n

template<typename T >

int olb::HyperplaneLattice2D< T >::_n

protected

Number of lattice points in the direction of _u.

Definition at line 66 of file hyperplaneLattice2D.h.

_origin

template<typename T >

Vector<T,2> olb::HyperplaneLattice2D< T >::_origin

protected

Origin vector of the lattice.

Note that this origin is set to a outermost point of the intersection between cuboid geometry and hyperplane. Thus it is different from the Hyperplane2D<T> origin vector in the general case.

Definition at line 59 of file hyperplaneLattice2D.h.

_u

template<typename T >

Vector<T,2> olb::HyperplaneLattice2D< T >::_u

protected

Direction vector of the lattice, normalized to grid width _h.

Definition at line 61 of file hyperplaneLattice2D.h.

---

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

• src/utilities/hyperplaneLattice2D.h
• src/utilities/hyperplaneLattice2D.hh