FreeFOAM The Cross-Platform CFD Toolkit
fixedOrientation Class Reference

sixDoFRigidBodyMotionConstraint. Orientation of body fixed global space. Only valid where the predicted deviation from alignment is < 90 degrees. More...

#include <forces/fixedOrientation.H>


Detailed Description

+ Inheritance diagram for fixedOrientation:
+ Collaboration diagram for fixedOrientation:

List of all members.

Public Member Functions

 TypeName ("fixedOrientation")
 Runtime type information.
 fixedOrientation (const dictionary &sDoFRBMCDict)
 Construct from components.
virtual autoPtr
< sixDoFRigidBodyMotionConstraint
clone () const
 Construct and return a clone.
virtual ~fixedOrientation ()
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.
- Public Member Functions inherited from sixDoFRigidBodyMotionConstraint
 TypeName ("sixDoFRigidBodyMotionConstraint")
 Runtime type information.
 declareRunTimeSelectionTable (autoPtr, sixDoFRigidBodyMotionConstraint, dictionary,(const dictionary &sDoFRBMCDict),(sDoFRBMCDict))
 sixDoFRigidBodyMotionConstraint (const dictionary &sDoFRBMCDict)
 Construct from the sDoFRBMCDict dictionary and Time.
virtual ~sixDoFRigidBodyMotionConstraint ()
const dictionarycoeffDict () const
scalar tolerance () const
 Return access to the tolerance.
scalar relaxationFactor () const
 Return access to the relaxationFactor.

Additional Inherited Members

- Static Public Member Functions inherited from sixDoFRigidBodyMotionConstraint
static autoPtr
< sixDoFRigidBodyMotionConstraint
New (const dictionary &sDoFRBMCDict)
 Select constructed from the sDoFRBMCDict dictionary and Time.
- Protected Attributes inherited from sixDoFRigidBodyMotionConstraint
dictionary sDoFRBMCCoeffs_
 Constraint model specific coefficient dictionary.
scalar tolerance_
 Solution tolerance. Meaning depends on model, usually an.
scalar relaxationFactor_
 Relaxation factor for solution, default to one.

Constructor & Destructor Documentation

fixedOrientation ( const dictionary sDoFRBMCDict)

Construct from components.

Definition at line 50 of file fixedOrientation.C.

Referenced by fixedOrientation::clone().

~fixedOrientation ( )
virtual

Definition at line 62 of file fixedOrientation.C.


Member Function Documentation

TypeName ( "fixedOrientation"  )

Runtime type information.

virtual autoPtr<sixDoFRigidBodyMotionConstraint> clone ( ) const
inlinevirtual

Construct and return a clone.

Implements sixDoFRigidBodyMotionConstraint.

Definition at line 76 of file fixedOrientation.H.

References fixedOrientation::fixedOrientation().

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 69 of file fixedOrientation.C.

References Foam::acos(), sixDoFRigidBodyMotion::centreOfMass(), Foam::endl(), Foam::Info, Foam::mag(), Foam::min(), sixDoFRigidBodyMotion::momentOfInertia(), VectorSpace< Vector< scalar >, scalar, 3 >::nComponents, sixDoFRigidBodyMotion::predictedOrientation(), Foam::sqr(), and Vector< scalar >::zero.

bool read ( const dictionary sDoFRBMCCoeff)
virtual

Update properties from given dictionary.

Reimplemented from sixDoFRigidBodyMotionConstraint.

Definition at line 168 of file fixedOrientation.C.

References sixDoFRigidBodyMotionConstraint::read().

void write ( Ostream os) const
virtual

Write.

Reimplemented from sixDoFRigidBodyMotionConstraint.

Definition at line 179 of file fixedOrientation.C.


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