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 () | |
Construct null. More... | |
axisAngle (const axisAngle &crot) | |
Copy construct. More... | |
axisAngle (axisAngle &&crot) | |
Move 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 | ~coordinateRotation ()=default |
Destructor. 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 Public Member Functions inherited from coordinateRotation | |
static autoPtr< coordinateRotation > | New (const dictionary &dict) |
Select constructed from dictionary. 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.
coordinateRotation { type axisAngle; axis (1 0 0); angle 90; }
Dictionary entries
Property | Description | Required | 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 | ( | ) |
Construct null.
Definition at line 82 of file axisAngleRotation.C.
Copy construct.
Definition at line 91 of file axisAngleRotation.C.
Move construct.
Definition at line 102 of file axisAngleRotation.C.
Construct from axis and angle.
Definition at line 114 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 130 of file axisAngleRotation.C.
|
explicit |
Construct from dictionary.
Definition at line 145 of file axisAngleRotation.C.
|
virtualdefault |
Destructor.
TypeNameNoDebug | ( | "axisAngle" | ) |
Runtime type information.
|
inlinevirtual |
|
static |
The rotation tensor for given axis/angle.
Definition at line 65 of file axisAngleRotation.C.
References Foam::degToRad(), SphericalTensor< scalar >::I, Foam::mag(), and quaternion::R().
|
virtual |
Reset specification.
Implements coordinateRotation.
Definition at line 158 of file axisAngleRotation.C.
References Foam::Zero.
|
virtual |
Calculate and return the rotation tensor calculated from axis and angle
Implements coordinateRotation.
Definition at line 165 of file axisAngleRotation.C.
|
virtual |
Write information.
Implements coordinateRotation.
Definition at line 171 of file axisAngleRotation.C.
Write dictionary entry.
Implements coordinateRotation.
Definition at line 179 of file axisAngleRotation.C.
References Ostream::beginBlock(), Ostream::endBlock(), Foam::type(), and Ostream::writeEntry().