madness::SDFPlane Class Reference

A plane surface (3 dimensions) More...

#include <sdf_shape_3D.h>

Inheritance diagram for madness::SDFPlane:

Collaboration diagram for madness::SDFPlane:

Public Member Functions
	SDFPlane (const coord_3d &normal, const coord_3d &point)
	SDF for a plane transecting the entire simulation volume.
coord_3d	grad_sdf (const coord_3d &pt) const
	Computes the gradient of the SDF.
double	sdf (const coord_3d &pt) const
	Computes the normal distance.
Public Member Functions inherited from madness::SignedDFInterface< 3 >
virtual	~SignedDFInterface ()
virtual Vector< double, NDIM >	grad_sdf (const Vector< double, NDIM > &x) const=0
	Returns the gradient of the signed distance from the surface (i.e., dsdf(x)/dx[i] )
virtual double	sdf (const Vector< double, NDIM > &x) const=0
	Returns the signed distance from the surface,.

Protected Attributes
const coord_3d	normal
	The normal vector pointing OUTSIDE the surface.
const coord_3d	point
	A point in the plane.

Detailed Description

A plane surface (3 dimensions)

Constructor & Destructor Documentation

SDFPlane()

madness::SDFPlane::SDFPlane ( const coord_3d &  normal, const coord_3d &  point  )

inline

SDF for a plane transecting the entire simulation volume.

Parameters

normal	The outward normal definining the plane
point	A point in the plane

Member Function Documentation

grad_sdf()

coord_3d madness::SDFPlane::grad_sdf ( const coord_3d &  pt ) const

inline

Computes the gradient of the SDF.

Parameters

pt	Point at which to compute the gradient

Returns

the gradient

References MADNESS_EXCEPTION.

sdf()

double madness::SDFPlane::sdf ( const coord_3d &  pt ) const

inline

Computes the normal distance.

This SDF is exact, and easy to show.

Parameters

pt	Point at which to compute the distance from the surface

Returns

The signed distance from the surface

References normal, and point.

Member Data Documentation

normal

const coord_3d madness::SDFPlane::normal

protected

The normal vector pointing OUTSIDE the surface.

Referenced by sdf().

point

const coord_3d madness::SDFPlane::point

protected

A point in the plane.

Referenced by sdf().

---

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

• sdf_shape_3D.h