STYLE: improve usage notes for transformPoints, surfaceTransformPoints

This commit is contained in:
Mark Olesen
2017-04-20 16:27:44 +02:00
parent 5844d337a0
commit 89f2eff565
2 changed files with 16 additions and 8 deletions

View File

@ -53,9 +53,9 @@ Usage
it will also read & transform vector & tensor fields. it will also read & transform vector & tensor fields.
Note: Note:
yaw (rotation about z)
pitch (rotation about y)
roll (rotation about x) roll (rotation about x)
pitch (rotation about y)
yaw (rotation about z)
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
@ -143,6 +143,12 @@ void rotateFields(const argList& args, const Time& runTime, const tensor& T)
int main(int argc, char *argv[]) int main(int argc, char *argv[])
{ {
argList::addNote
(
"Transform (translate/rotate/scale) mesh points.\n"
"Note: roll=rotation about x, pitch=rotation about y, "
"yaw=rotation about z"
);
argList::addOption argList::addOption
( (
"translate", "translate",
@ -160,13 +166,13 @@ int main(int argc, char *argv[])
( (
"rollPitchYaw", "rollPitchYaw",
"vector", "vector",
"transform in terms of '(roll pitch yaw)' in degrees" "rotate by '(roll pitch yaw)' in degrees"
); );
argList::addOption argList::addOption
( (
"yawPitchRoll", "yawPitchRoll",
"vector", "vector",
"transform in terms of '(yaw pitch roll)' in degrees" "rotate by '(yaw pitch roll)' in degrees"
); );
argList::addBoolOption argList::addBoolOption
( (

View File

@ -61,8 +61,10 @@ int main(int argc, char *argv[])
{ {
argList::addNote argList::addNote
( (
"Transform (scale/rotate) a surface. " "Transform (translate/rotate/scale) a surface. "
"Like transformPoints but for surfaces." "Like transformPoints but for surfaces.\n"
"Note: roll=rotation about x, pitch=rotation about y, "
"yaw=rotation about z"
); );
argList::noParallel(); argList::noParallel();
argList::validArgs.append("surfaceFile"); argList::validArgs.append("surfaceFile");
@ -91,13 +93,13 @@ int main(int argc, char *argv[])
( (
"rollPitchYaw", "rollPitchYaw",
"vector", "vector",
"transform in terms of '( roll pitch yaw )' in degrees" "rotate by '(roll pitch yaw)' in degrees"
); );
argList::addOption argList::addOption
( (
"yawPitchRoll", "yawPitchRoll",
"vector", "vector",
"transform in terms of '( yaw pitch roll )' in degrees" "rotate by '(yaw pitch roll)' in degrees"
); );
argList args(argc, argv); argList args(argc, argv);