indicatorF3D.h File Reference

This file contains indicator functions. More...

#include "indicatorBaseF3D.h"
#include "io/xmlReader.h"
#include "utilities/functorPtr.h"

Include dependency graph for indicatorF3D.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	olb::IndicatorTranslate3D< S >
class	olb::IndicatorCircle3D< S >
	indicator function for a 3D circle More...
class	olb::IndicatorSphere3D< S >
	indicator function for a 3D-sphere More...
class	olb::IndicatorLayer3D< S >
	indicator function for a layer More...
class	olb::IndicatorInternal3D< S >
	indicator function for the internal part of an input indicator More...
class	olb::IndicatorCylinder3D< S >
	indicator function for a 3d-cylinder More...
class	olb::IndicatorCone3D< S >
	indicator function for a 3d frustum More...
class	olb::IndicatorEllipsoid3D< S >
	indicator function for an ellipsoid More...
class	olb::IndicatorSuperEllipsoid3D< S >
	indicator function for a super ellipsoid More...
class	olb::IndicatorCuboid3D< T >
	indicator function for a 3d-cuboid, parallel to the planes x=0, y=0, z=0. More...
class	olb::IndicatorPolygon3D< S >
	indicator function for a 3d-polygon More...
class	olb::IndicatorCuboidRotate3D< S >
	indicator function for a 3d-cuboid, turned by an angle theta around an axis of rotation More...
class	olb::IndicatorSDF3D< T >

Namespaces
namespace	olb
	Top level namespace for all of OpenLB.

Functions
template<typename S >
std::shared_ptr< IndicatorF3D< S > >	olb::createIndicatorCircle3D (XMLreader const &params, bool verbose=false)
template<typename S >
std::shared_ptr< IndicatorF3D< S > >	olb::createIndicatorSphere3D (XMLreader const &params, bool verbose=false)
template<typename S >
std::shared_ptr< IndicatorF3D< S > >	olb::createIndicatorCylinder3D (XMLreader const &params, bool verbose=false)
template<typename S >
std::shared_ptr< IndicatorF3D< S > >	olb::createIndicatorCone3D (XMLreader const &params, bool verbose=false)
template<typename S >
std::shared_ptr< IndicatorF3D< S > >	olb::createIndicatorCuboid3D (XMLreader const &params, bool verbose=false)
template<typename S >
std::shared_ptr< IndicatorF3D< S > >	olb::createIndicatorUnion3D (XMLreader const &params, bool verbose=false)
template<typename S >
std::shared_ptr< IndicatorF3D< S > >	olb::createIndicatorWithout3D (XMLreader const &params, bool verbose=false)
template<typename S >
std::shared_ptr< IndicatorF3D< S > >	olb::createIndicatorIntersection3D (XMLreader const &params, bool verbose=false)
template<typename S >
std::shared_ptr< IndicatorF3D< S > >	olb::createIndicatorF3D (XMLreader const &params, bool verbose=false)

Detailed Description

This file contains indicator functions.

These return 1 if the given coordinates are inside, and 0 if they are outside of the defined set. Implemented are :

• Sphere
• Cylinder
• Cone
• Ellipsoid
• Pipe (not yet)
• Cube (not yet)
• Cuboid

• Circle

  The smoothIndicator functors return values in [0,1]. In particular there is an epsilon enclosure of the set, wherein the return values are smooth and do not jump from 0 to 1.

Boolean operators allow to create unions and intersections. They can be used for example for initialization of a SuperGeometry.

Definition in file indicatorF3D.h.