A coordinate rotation specified per local axes and the base class for other rotation specifications. More...
#include <meshTools/coordinateRotation.H>
A coordinate rotation specified per local axes and the base class for other rotation specifications.
The rotation is defined by a combination of local vectors (e1/e2), (e2/e3) or (e3/e1). Any nonorthogonality will be absorbed into the second vector.
For convenience, the dictionary constructor forms allow a few shortcuts:
type is not otherwise specified, the type axes is implicitSpecifying the rotation by an EulerCoordinateRotation (type "EulerRotation") or by a STARCDCoordinateRotation (type "STARCDRotation") requires the coordinateRotation sub-dictionary.
coordinateRotation
{
typeSTARCDRotation
rotation(0 0 90);
}
coordinateRotation
{
typeSTARCDRotation
degrees false;
rotation(0 0 3.141592654);
}
axis (corresponding to e3) and a direction (corresponding to e1), is allowed for backwards compatibility, but this terminology is generally a bit confusing.Definition at line 87 of file coordinateRotation.H.
Inheritance diagram for coordinateRotation:
Collaboration diagram for coordinateRotation:Public Member Functions | |
| TypeName ("coordinateRotation") | |
| Runtime type information.
| |
| coordinateRotation () | |
| Construct null.
| |
| coordinateRotation (const vector &axis, const vector &dir) | |
| Construct from 2 axes.
| |
| coordinateRotation (const dictionary &) | |
| Construct from dictionary.
| |
| autoPtr< coordinateRotation > | clone () const |
| Return clone.
| |
| declareRunTimeSelectionTable (autoPtr, coordinateRotation, dictionary,(const dictionary &dict),(dict)) | |
| virtual | ~coordinateRotation () |
| const tensor & | R () const |
| Return local-to-global transformation tensor.
| |
| const vector | e1 () const |
| Return local Cartesian x-axis.
| |
| const vector | e2 () const |
| Return local Cartesian y-axis.
| |
| const vector | e3 () const |
| Return local Cartesian z-axis.
| |
| void | operator= (const dictionary &) |
| assign from dictionary
| |
Static Public Member Functions | |
| static autoPtr < coordinateRotation > | New (const dictionary &dict) |
| Select constructed from Istream.
| |
Construct null.
Definition at line 96 of file coordinateRotation.C.
Referenced by coordinateRotation::clone().
| coordinateRotation | ( | const vector & | axis, |
| const vector & | dir | ||
| ) |
Construct from 2 axes.
Definition at line 103 of file coordinateRotation.C.
| coordinateRotation | ( | const dictionary & | dict ) |
Construct from dictionary.
Definition at line 115 of file coordinateRotation.C.
| virtual ~coordinateRotation | ( | ) | [inline, virtual]
|
Definition at line 162 of file coordinateRotation.H.
| TypeName | ( | "coordinateRotation" | ) |
Runtime type information.
| autoPtr<coordinateRotation> clone | ( | ) | const [inline]
|
Return clone.
Definition at line 132 of file coordinateRotation.H.
References coordinateRotation::coordinateRotation().
| declareRunTimeSelectionTable | ( | autoPtr | , |
| coordinateRotation | , | ||
| dictionary | , | ||
| (const dictionary &dict) | , | ||
| (dict) | |||
| ) |
| Foam::autoPtr< Foam::coordinateRotation > New | ( | const dictionary & | dict ) | [static]
|
Select constructed from Istream.
Definition at line 127 of file coordinateRotation.C.
References Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorIn, Foam::nl, Foam::Pout, and dictionary::readIfPresent().
Referenced by coordinateSystem::operator=().
| const tensor& R | ( | ) | const [inline]
|
Return local-to-global transformation tensor.
Definition at line 169 of file coordinateRotation.H.
| const vector e1 | ( | ) | const [inline]
|
Return local Cartesian x-axis.
Definition at line 175 of file coordinateRotation.H.
References Tensor< Cmpt >::T().
| const vector e2 | ( | ) | const [inline]
|
Return local Cartesian y-axis.
Definition at line 181 of file coordinateRotation.H.
References Tensor< Cmpt >::T().
| const vector e3 | ( | ) | const [inline]
|
Return local Cartesian z-axis.
Definition at line 187 of file coordinateRotation.H.
References Tensor< Cmpt >::T().
| void operator= | ( | const dictionary & | rhs ) |
assign from dictionary
Definition at line 172 of file coordinateRotation.C.
References Foam::endl(), dictionary::found(), SphericalTensor< Cmpt >::I, dictionary::lookup(), Tensor< scalar >::operator=(), Foam::Pout, dictionary::readIfPresent(), and dictionary::subDict().