zhyang-dev/OpenFOAM-12
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

rigidBodyState, sixDoFRigidBodyState: Change angleFormat -> angleUnits with backwards-compatibility

Browse Source 
angleUnits is a more logical name for the user-input as it specifies the units
of the angles written rather than the format of the numbers.  The previous name
angleFormat is supported for backwards-compatibility

Class
    Foam::functionObjects::rigidBodyState

Description
    Writes the rigid body motion state.

Usage
    \table
        Property     | Description                  | Required | Default value
        type         | type name: rigidBodyState    | yes      |
        angleUnits   | degrees or radians           | no       | radians
    \endtable

    Example of function object specification:
    \verbatim
    rigidBodyState
    {
        type           rigidBodyState;
        libs           ("librigidBodyState.so");
        angleUnits     degrees;
    }
    \endverbatim

Class
    Foam::functionObjects::sixDoFRigidBodyState

Description
    Writes the 6-DoF motion state.

    Example of function object specification:
    \verbatim
    sixDoFRigidBodyState
    {
        type           sixDoFRigidBodyState;
        libs           ("libsixDoFRigidBodyState.so");
        angleUnits     degrees;
    }
    \endverbatim

Usage
    \table
        Property     | Description                  | Required | Default value
        type         | type name: sixDoFRigidBodyState    | yes |
        angleUnits  | degrees or radians           | no       | radian
    \endtable
This commit is contained in:
Henry Weller
2022-12-05 19:57:12 +00:00
parent 02c7257eb0
commit 818eed7a3d
9 changed files with 38 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
tutorials/modules/incompressibleFluid/wingMotion/wingMotion2D_transient/system/controlDict
View File

@ -56,7 +56,7 @@ functions
{
type sixDoFRigidBodyState;
libs ("libsixDoFRigidBodyState.so");
angleFormat degrees;
angleUnits degrees;
}
}

2
tutorials/multiphase/interFoam/RAS/floatingObject/system/controlDict
View File

@ -56,7 +56,7 @@ functions
{
type rigidBodyState;
libs ("librigidBodyState.so");
angleFormat degrees;
angleUnits degrees;
}
}

2
tutorials/multiphase/interFoam/RAS/floatingObject/system/controlDict.sixDoF
View File

@ -56,7 +56,7 @@ functions
{
type sixDoFRigidBodyState;
libs ("libsixDoFRigidBodyState.so");
angleFormat degrees;
angleUnits degrees;
}
}

2
tutorials/multiphase/interFoam/RAS/planingHullW3/system/controlDict
View File

@ -67,7 +67,7 @@ functions
{
type rigidBodyState;
libs ("librigidBodyState.so");
angleFormat degrees;
angleUnits degrees;
}
#includeFunc surfaces