SymmetryPointGenerator Class Reference

#include <SymmetryPointGenerator.h>

Inheritance diagram for SymmetryPointGenerator:

Public Member Functions
	SymmetryPointGenerator (const InputParameters &parameters)
virtual void	initialize ()
virtual void	finalize ()
virtual void	execute ()
bool	onPositiveSideOfPlane (const Point &p, const Point &normal) const
Point	reflectPointAcrossPlane (const Point &p, const Point &normal) const
Point	transformPoint (const Point &p) const
int	sector (const Point &p) const

Static Public Member Functions
static InputParameters	validParams ()

Protected Attributes
const bool	_rotational_symmetry
	Whether rotational symmetry is applied; otherwise, the domain is mirror-symmetric. More...
Point	_normal
	Normal defining the first symmetry plane. More...
Point	_rotational_axis
	Axis of angular rotation symmetry. More...
Real	_angle
	Rotation angle. More...
Point	_zero_theta
	Line defining the "zero-theta" line for rotational symmetry. More...
Point	_reflection_normal
	Normal defining the reflection plane, for odd-numbered sectors. More...

Detailed Description

Class that maps from a point (x, y, z) to a new point that is either rotationally symmetry or mirrored. The origin for reflection and rotation is (0, 0, 0).

Constructor & Destructor Documentation

SymmetryPointGenerator()

SymmetryPointGenerator::SymmetryPointGenerator

(

const InputParameters &

parameters

)

Member Function Documentation

execute()

virtual void SymmetryPointGenerator::execute ( )

inlinevirtual

finalize()

virtual void SymmetryPointGenerator::finalize ( )

inlinevirtual

initialize()

virtual void SymmetryPointGenerator::initialize ( )

inlinevirtual

onPositiveSideOfPlane()

bool SymmetryPointGenerator::onPositiveSideOfPlane	(	const Point &	p,
		const Point &	normal
	)		const

Whether point is on the positive side of a plane; points exactly on plane return false

Parameters

[in]	p	point
[in]	normal	unit normal defining the plane

Returns

whether on positive side of plane

reflectPointAcrossPlane()

Point SymmetryPointGenerator::reflectPointAcrossPlane	(	const Point &	p,
		const Point &	normal
	)		const

Reflect point across a plane

Parameters

[in]	p	point
[in]	normal	unit normal defining the plane

Returns

reflected point

sector()

int SymmetryPointGenerator::sector

(

const Point &

p

)

const

Sector of point

Parameters

[in]

p

point

Returns

sector

transformPoint()

Point SymmetryPointGenerator::transformPoint

(

const Point &

p

)

const

Transform point coordinates according to class settings

Parameters

[in]

p

point

Returns

transformed point

validParams()

InputParameters SymmetryPointGenerator::validParams ( )

static

Member Data Documentation

_angle

Real SymmetryPointGenerator::_angle

protected

Rotation angle.

_normal

Point SymmetryPointGenerator::_normal

protected

Normal defining the first symmetry plane.

_reflection_normal

Point SymmetryPointGenerator::_reflection_normal

protected

Normal defining the reflection plane, for odd-numbered sectors.

_rotational_axis

Point SymmetryPointGenerator::_rotational_axis

protected

Axis of angular rotation symmetry.

_rotational_symmetry

const bool SymmetryPointGenerator::_rotational_symmetry

protected

Whether rotational symmetry is applied; otherwise, the domain is mirror-symmetric.

_zero_theta

Point SymmetryPointGenerator::_zero_theta

protected

Line defining the "zero-theta" line for rotational symmetry.

---

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

• include/userobjects/SymmetryPointGenerator.h
• src/userobjects/SymmetryPointGenerator.C