FreeFOAM The Cross-Platform CFD Toolkit
fixedLine Class Reference

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

#include <forces/fixedLine.H>


Detailed Description

+ Inheritance diagram for fixedLine:
+ Collaboration diagram for fixedLine:

List of all members.

Public Member Functions

 TypeName ("fixedLine")
 Runtime type information.
 fixedLine (const dictionary &sDoFRBMCDict)
 Construct from components.
virtual autoPtr
< sixDoFRigidBodyMotionConstraint
clone () const
 Construct and return a clone.
virtual ~fixedLine ()
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

fixedLine ( const dictionary sDoFRBMCDict)

Construct from components.

Definition at line 50 of file fixedLine.C.

Referenced by fixedLine::clone().

~fixedLine ( )
virtual

Definition at line 64 of file fixedLine.C.


Member Function Documentation

TypeName ( "fixedLine"  )

Runtime type information.

virtual autoPtr<sixDoFRigidBodyMotionConstraint> clone ( ) const
inlinevirtual

Construct and return a clone.

Implements sixDoFRigidBodyMotionConstraint.

Definition at line 82 of file fixedLine.H.

References fixedLine::fixedLine().

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 71 of file fixedLine.C.

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

bool read ( const dictionary sDoFRBMCCoeff)
virtual

Update properties from given dictionary.

Reimplemented from sixDoFRigidBodyMotionConstraint.

Definition at line 132 of file fixedLine.C.

References Foam::abort(), Foam::FatalError, FatalErrorIn, Foam::mag(), and sixDoFRigidBodyMotionConstraint::read().

void write ( Ostream os) const
virtual

Write.

Reimplemented from sixDoFRigidBodyMotionConstraint.

Definition at line 166 of file fixedLine.C.

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


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