A coordinateRotation specified by a rotation axis and a rotation angle about that axis. More...
Public Member Functions | |
TypeNameNoDebug ("axisAngle") | |
Runtime type information. More... | |
axisAngle () | |
Default construct. Axis = Z, angle = 0. More... | |
axisAngle (const axisAngle &crot) | |
Copy construct. More... | |
axisAngle (const vector &axis, scalar angle, bool degrees) | |
Construct from axis and angle. More... | |
axisAngle (const vector::components axis, scalar angle, bool degrees) | |
Construct from x/y/z axis enumeration and angle. More... | |
axisAngle (const dictionary &dict) | |
Construct from dictionary. More... | |
autoPtr< coordinateRotation > | clone () const |
Return clone. More... | |
virtual | ~axisAngle ()=default |
Destructor. More... | |
virtual void | clear () |
Reset specification. More... | |
virtual tensor | R () const |
virtual void | write (Ostream &os) const |
Write information. More... | |
virtual void | writeEntry (const word &keyword, Ostream &os) const |
Write dictionary entry. More... | |
Public Member Functions inherited from coordinateRotation | |
TypeNameNoDebug ("coordinateRotation") | |
Runtime type information. More... | |
declareRunTimeSelectionTable (autoPtr, coordinateRotation, dictionary,(const dictionary &dict),(dict)) | |
virtual autoPtr< coordinateRotation > | clone () const =0 |
Construct and return a clone. More... | |
virtual | ~coordinateRotation ()=default |
Destructor. More... | |
virtual void | clear ()=0 |
Reset specification. More... | |
virtual tensor | R () const =0 |
Calculate and return the rotation tensor. More... | |
virtual void | write (Ostream &os) const =0 |
Write information. More... | |
virtual void | writeEntry (const word &keyword, Ostream &os) const =0 |
Write dictionary entry. More... | |
Static Public Member Functions | |
static tensor | rotation (const vector &axis, const scalar angle, bool degrees=false) |
The rotation tensor for given axis/angle. More... | |
static tensor | rotation (const vector::components axis, const scalar angle, bool degrees=false) |
Rotation tensor calculated for given axis and angle. More... | |
Static Public Member Functions inherited from coordinateRotation | |
static autoPtr< coordinateRotation > | New (word modelType, const dictionary &dict) |
Select construct the specified coordinate rotation type. More... | |
static autoPtr< coordinateRotation > | New (const dictionary &dict) |
Select construct from dictionary (requires the "type" entry) More... | |
Additional Inherited Members | |
Static Protected Member Functions inherited from coordinateRotation | |
static vector | findOrthogonal (const vector &axis) |
Determine best-guess for an orthogonal axis. More... | |
A coordinateRotation specified by a rotation axis and a rotation angle about that axis.
rotation { type axisAngle; axis (1 0 0); angle 90; }
Dictionary entries
Property | Description | Reqd | Default |
---|---|---|---|
type | Type name: axisAngle | yes | |
axis | Axis of rotation (vector) | yes | |
angle | Rotation angle | yes | |
degrees | The angle is in degrees | no | true |
Definition at line 99 of file axisAngleRotation.H.
axisAngle | ( | ) |
Default construct. Axis = Z, angle = 0.
Definition at line 98 of file axisAngleRotation.C.
Copy construct.
Definition at line 107 of file axisAngleRotation.C.
Construct from axis and angle.
Definition at line 118 of file axisAngleRotation.C.
axisAngle | ( | const vector::components | axis, |
scalar | angle, | ||
bool | degrees | ||
) |
Construct from x/y/z axis enumeration and angle.
Definition at line 134 of file axisAngleRotation.C.
|
explicit |
Construct from dictionary.
Definition at line 150 of file axisAngleRotation.C.
|
virtualdefault |
Destructor.
TypeNameNoDebug | ( | "axisAngle" | ) |
Runtime type information.
|
inlinevirtual |
|
static |
The rotation tensor for given axis/angle.
Definition at line 66 of file axisAngleRotation.C.
References Foam::degToRad(), SphericalTensor< scalar >::I, Foam::mag(), and quaternion::R().
|
static |
Rotation tensor calculated for given axis and angle.
Definition at line 82 of file axisAngleRotation.C.
References coordinateSystem::rotation(), and Foam::Zero.
|
virtual |
Reset specification.
Implements coordinateRotation.
Definition at line 163 of file axisAngleRotation.C.
References Foam::Zero.
|
virtual |
Calculate and return the rotation tensor calculated from axis and angle
Implements coordinateRotation.
Definition at line 170 of file axisAngleRotation.C.
|
virtual |
Write information.
Implements coordinateRotation.
Definition at line 176 of file axisAngleRotation.C.
References os().
Write dictionary entry.
Implements coordinateRotation.
Definition at line 183 of file axisAngleRotation.C.
References os(), and Foam::type().