olb::HyperplaneLattice3D< T > Class Template Reference

Parametrization of a hyperplane lattice. More...

#include <hyperplaneLattice3D.h>

Inheritance diagram for olb::HyperplaneLattice3D< T >:

Collaboration diagram for olb::HyperplaneLattice3D< T >:

Public Member Functions
	HyperplaneLattice3D (CuboidGeometry3D< T > &geometry, Hyperplane3D< T > hyperplane)
	Constructor for automatic discretization.
	HyperplaneLattice3D (CuboidGeometry3D< T > &geometry, Hyperplane3D< T > hyperplane, int resolution)
	Constructor for discretization of a given resolution.
	HyperplaneLattice3D (CuboidGeometry3D< T > &geometry, Hyperplane3D< T > hyperplane, T h)
	Constructor for discretization of a given grid width.
	HyperplaneLattice3D (Hyperplane3D< T > hyperplane, T h, int nx, int ny)
	Constructor for manual discretization.
	HyperplaneLattice3D (const HyperplaneLattice3D &)=default
const Hyperplane3D< T > &	getHyperplane () const
Vector< T, 3 >	getPhysR (const int &planeX, const int &planeY) const
	Transform 2d lattice coordinates to their physical 3d location.
int	getNx () const
int	getNy () const
T	getPhysSpacing () const
Vector< T, 3 >	getPhysOrigin () const
Vector< T, 3 >	getVectorU () const
Vector< T, 3 >	getVectorV () const

Protected Attributes
const Hyperplane3D< T >	_hyperplane
Vector< T, 3 >	_origin
	Origin vector of the lattice.
Vector< T, 3 >	_u
	Span vector of the lattice, normalized to grid width _h.
Vector< T, 3 >	_v
	Span vector of the lattice, normalized to grid width _h.
T	_h
	Distance between discrete lattice points.
int	_nx
	Number of lattice points in the direction of _u.
int	_ny
	Number of lattice points in the direction of _v.

Detailed Description

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

Parametrization of a hyperplane lattice.

i.e. the resolution / grid width of the discretization of a given hyperplane.

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

Definition at line 41 of file hyperplaneLattice3D.h.

Constructor & Destructor Documentation

HyperplaneLattice3D() [1/5]

template<typename T >

olb::HyperplaneLattice3D< T >::HyperplaneLattice3D	(	CuboidGeometry3D< T > &	geometry,
		Hyperplane3D< T >	hyperplane )

Constructor for automatic discretization.

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

Definition at line 173 of file hyperplaneLattice3D.hh.

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

References olb::HyperplaneLattice3D< T >::_h, olb::HyperplaneLattice3D< T >::_u, olb::HyperplaneLattice3D< T >::_v, olb::CuboidGeometry3D< T >::getMotherCuboid(), and olb::normalize().

Here is the call graph for this function:

HyperplaneLattice3D() [2/5]

template<typename T >

olb::HyperplaneLattice3D< T >::HyperplaneLattice3D	(	CuboidGeometry3D< T > &	geometry,
		Hyperplane3D< T >	hyperplane,
		int	resolution )

Constructor for discretization of a given resolution.

Definition at line 190 of file hyperplaneLattice3D.hh.

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

References olb::HyperplaneLattice3D< T >::_h, olb::HyperplaneLattice3D< T >::_u, olb::HyperplaneLattice3D< T >::_v, olb::CuboidGeometry3D< T >::getMotherCuboid(), and olb::normalize().

Here is the call graph for this function:

HyperplaneLattice3D() [3/5]

template<typename T >

olb::HyperplaneLattice3D< T >::HyperplaneLattice3D	(	CuboidGeometry3D< T > &	geometry,
		Hyperplane3D< T >	hyperplane,
		T	h )

Constructor for discretization of a given grid width.

Definition at line 211 of file hyperplaneLattice3D.hh.

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

References olb::HyperplaneLattice3D< T >::_h, olb::HyperplaneLattice3D< T >::_u, olb::HyperplaneLattice3D< T >::_v, olb::CuboidGeometry3D< T >::getMinDeltaR(), olb::CuboidGeometry3D< T >::getMotherCuboid(), olb::util::nearZero(), and olb::normalize().

Here is the call graph for this function:

HyperplaneLattice3D() [4/5]

template<typename T >

olb::HyperplaneLattice3D< T >::HyperplaneLattice3D	(	Hyperplane3D< T >	hyperplane,
		T	h,
		int	nx,
		int	ny )

Constructor for manual discretization.

Parameters

hyperplane	Hyperplane in 3D space
h	lattice point spacing
nx	X axis resolution
ny	Y axis resolution

Definition at line 232 of file hyperplaneLattice3D.hh.

  : _hyperplane(hyperplane),
    _origin(hyperplane.origin),
    _u(hyperplane.u),
    _v(hyperplane.v),
    _h(h),
    _nx(nx),
    _ny(ny)
{
  _u = normalize(_u, _h);
  _v = normalize(_v, _h);
}

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

Here is the call graph for this function:

HyperplaneLattice3D() [5/5]

template<typename T >

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

default

Member Function Documentation

getHyperplane()

template<typename T >

const Hyperplane3D< T > & olb::HyperplaneLattice3D< T >::getHyperplane

(

)

const

Definition at line 248 of file hyperplaneLattice3D.hh.

{
  return _hyperplane;
}

Here is the caller graph for this function:

getNx()

template<typename T >

int olb::HyperplaneLattice3D< T >::getNx

(

)

const

Returns

_nx

Definition at line 264 of file hyperplaneLattice3D.hh.

{
  return _nx;
}

getNy()

template<typename T >

int olb::HyperplaneLattice3D< T >::getNy

(

)

const

Returns

_ny

Definition at line 270 of file hyperplaneLattice3D.hh.

{
  return _ny;
}

getPhysOrigin()

template<typename T >

Vector< T, 3 > olb::HyperplaneLattice3D< T >::getPhysOrigin

(

)

const

Returns

_origin

Definition at line 282 of file hyperplaneLattice3D.hh.

{
  return _origin;
}

getPhysR()

template<typename T >

Vector< T, 3 > olb::HyperplaneLattice3D< T >::getPhysR	(	const int &	planeX,
		const int &	planeY ) const

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

Definition at line 254 of file hyperplaneLattice3D.hh.

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

getPhysSpacing()

template<typename T >

T olb::HyperplaneLattice3D< T >::getPhysSpacing

(

)

const

Returns

_h

Definition at line 276 of file hyperplaneLattice3D.hh.

{
  return _h;
}

Here is the caller graph for this function:

getVectorU()

template<typename T >

Vector< T, 3 > olb::HyperplaneLattice3D< T >::getVectorU

(

)

const

Returns

_u

Definition at line 288 of file hyperplaneLattice3D.hh.

{
  return _u;
}

getVectorV()

template<typename T >

Vector< T, 3 > olb::HyperplaneLattice3D< T >::getVectorV

(

)

const

Returns

_v

Definition at line 294 of file hyperplaneLattice3D.hh.

{
  return _v;
}

Member Data Documentation

_h

template<typename T >

T olb::HyperplaneLattice3D< T >::_h

protected

Distance between discrete lattice points.

Definition at line 66 of file hyperplaneLattice3D.h.

_hyperplane

template<typename T >

const Hyperplane3D<T> olb::HyperplaneLattice3D< T >::_hyperplane

protected

Definition at line 51 of file hyperplaneLattice3D.h.

_nx

template<typename T >

int olb::HyperplaneLattice3D< T >::_nx

protected

Number of lattice points in the direction of _u.

Definition at line 68 of file hyperplaneLattice3D.h.

_ny

template<typename T >

int olb::HyperplaneLattice3D< T >::_ny

protected

Number of lattice points in the direction of _v.

Definition at line 70 of file hyperplaneLattice3D.h.

_origin

template<typename T >

Vector<T,3> olb::HyperplaneLattice3D< 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 Hyperplane3D<T> origin vector in the general case.

Definition at line 59 of file hyperplaneLattice3D.h.

_u

template<typename T >

Vector<T,3> olb::HyperplaneLattice3D< T >::_u

protected

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

Definition at line 61 of file hyperplaneLattice3D.h.

_v

template<typename T >

Vector<T,3> olb::HyperplaneLattice3D< T >::_v

protected

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

Definition at line 63 of file hyperplaneLattice3D.h.

---

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

• src/utilities/hyperplaneLattice3D.h
• src/utilities/hyperplaneLattice3D.hh