fixedPlane Class Reference

sixDoFRigidBodyMotionConstraint. Reference point may only move along a plane. More...

#include <forces/fixedPlane.H>

---

Detailed Description

sixDoFRigidBodyMotionConstraint. Reference point may only move along a plane.

Source files

• src/postProcessing/functionObjects/forces/pointPatchFields/derived/sixDoFRigidBodyMotion/sixDoFRigidBodyMotionConstraint/fixedPlane/fixedPlane.H
• src/postProcessing/functionObjects/forces/pointPatchFields/derived/sixDoFRigidBodyMotion/sixDoFRigidBodyMotionConstraint/fixedPlane/fixedPlane.C

Definition at line 54 of file fixedPlane.H.

Inheritance diagram for fixedPlane:

Collaboration diagram for fixedPlane:

List of all members.

Public Member Functions
	TypeName ("fixedPlane")
	Runtime type information.
	fixedPlane (const dictionary &sDoFRBMCDict)
	Construct from components.
virtual autoPtr < sixDoFRigidBodyMotionConstraint >	clone () const
	Construct and return a clone.
virtual	~fixedPlane ()
virtual bool	constrain (const sixDoFRigidBodyMotion &motion, const vector &existingConstraintForce, const vector &existingConstraintMoment, scalar deltaT, vector &constraintPosition, vector &constraintForceIncrement, vector &constraintMomentIncrement) const
	Calculate the constraint position, force and moment.
virtual bool	read (const dictionary &sDoFRBMCCoeff)
	Update properties from given dictionary.
virtual void	write (Ostream &) const
	Write.

---

Constructor & Destructor Documentation

fixedPlane

(

const dictionary &

sDoFRBMCDict  )

Construct from components.

Definition at line 50 of file fixedPlane.C.

Referenced by fixedPlane::clone().

~fixedPlane

(

)

[virtual]

Definition at line 63 of file fixedPlane.C.

---

Member Function Documentation

TypeName

(

"fixedPlane"

)

Runtime type information.

virtual autoPtr<sixDoFRigidBodyMotionConstraint> clone

(

)

const [inline, virtual]

Construct and return a clone.

Implements sixDoFRigidBodyMotionConstraint.

Definition at line 80 of file fixedPlane.H.

References fixedPlane::fixedPlane().

bool constrain	(	const sixDoFRigidBodyMotion &	motion,
		const vector &	existingConstraintForce,
		const vector &	existingConstraintMoment,
		scalar	deltaT,
		vector &	constraintPosition,
		vector &	constraintForceIncrement,
		vector &	constraintMomentIncrement
	)		const [virtual]

Calculate the constraint position, force and moment.

Global reference frame vectors. Returns boolean stating whether the constraint been converged to tolerance.

Implements sixDoFRigidBodyMotionConstraint.

Definition at line 70 of file fixedPlane.C.

References sixDoFRigidBodyMotion::currentPosition(), Foam::endl(), Foam::Info, Foam::mag(), sixDoFRigidBodyMotion::mass(), sixDoFRigidBodyMotion::predictedPosition(), Foam::sqr(), and Vector< Cmpt >::zero.

bool read

(

const dictionary &

sDoFRBMCCoeff  )

[virtual]

Update properties from given dictionary.

Reimplemented from sixDoFRigidBodyMotionConstraint.

Definition at line 132 of file fixedPlane.C.

References sixDoFRigidBodyMotionConstraint::read().

void write

(

Ostream &

os  )

const [virtual]

Write.

Reimplemented from sixDoFRigidBodyMotionConstraint.

Definition at line 149 of file fixedPlane.C.

References token::END_STATEMENT, Foam::nl, and Ostream::writeKeyword().

---

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

• src/postProcessing/functionObjects/forces/pointPatchFields/derived/sixDoFRigidBodyMotion/sixDoFRigidBodyMotionConstraint/fixedPlane/fixedPlane.H
• src/postProcessing/functionObjects/forces/pointPatchFields/derived/sixDoFRigidBodyMotion/sixDoFRigidBodyMotionConstraint/fixedPlane/fixedPlane.C