rigidBodyMotion_pointMeshMover.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     | Website:  https://openfoam.org
    \\  /    A nd           | Copyright (C) 2016-2026 OpenFOAM Foundation
     \\/     M anipulation  |
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.
 
    OpenFOAM is free software: you can redistribute it and/or modify it
    under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
 
    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    for more details.
 
    You should have received a copy of the GNU General Public License
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
Class
    Foam::pointMeshMovers::rigidBodyMotion
 
Description
    Multiple rigid body mesh motion in which movement of the bodies is
    generated by RBD::rigidBodyMotion.
 
    Applies distance weighted SLERP interpolation between the septernion
    transformations for each body returned provided by the
    RBD::rigidBodyMotion solution of the multi-body + joint system.
 
    The mesh patches for each body must be specified and optionally pointZones
    that move with each body.  The motion of the mesh around each body may be
    constrained by the optional \c innerDistance and \c outerDistance, the mesh
    within the \c innerDistance moves with the body without distortion and the
    mesh beyond the \c outerDistance does not move with body but may move by the
    proximity of other bodies.
 
    Example of the motion of a single constrained and restrained floating hull
    in a stationary region:
    \verbatim
    mover
    {
        type            pointMeshMover;
 
        libs            ("librigidBodyMotion_pointMeshMover.so");
 
        pointMeshMover
        {
            type            rigidBodyMotion;
 
            report          on;
 
            solver
            {
                type Newmark;
            }
 
            accelerationRelaxation 0.4;
 
            bodies
            {
                hull
                {
                    type            rigidBody;
                    parent          root;
 
                    centreOfMass    (0 0 0);
                    mass            412.73;
                    inertia         (40 0 0 921 0 921);
                    transform       (1 0 0 0 1 0 0 0 1) (2.929541 0 0.2);
 
                    joint
                    {
                        type    composite;
                        joints
                        (
                            {
                                type Pz;
                            }
                            {
                                type Ry;
                            }
                        );
                    }
 
                    patches         (hull);
                    innerDistance   0.3;
                    outerDistance   1;
                }
            }
 
            restraints
            {
                translationDamper
                {
                    type linearDamper;
                    body hull;
                    coeff 8596;
                }
 
                rotationDamper
                {
                    type sphericalAngularDamper;
                    body hull;
                    coeff 11586;
                }
            }
        }
    }
    \endverbatim
 
See also
    Foam::RBD::rigidBodyMotion
    Foam::pointMeshMovers::multiRigidBody
 
SourceFiles
    rigidBodyMotion_pointMeshMover.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef rigidBodyMotion_pointMeshMover_H
#define rigidBodyMotion_pointMeshMover_H
 
#include "multiRigidBody_pointMeshMover.H"
#include "rigidBodyMotion.H"
#include "Function1.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
namespace pointMeshMovers
{
 
/*---------------------------------------------------------------------------*\
                     Class rigidBodyMotion Declaration
\*---------------------------------------------------------------------------*/
 
class rigidBodyMotion
:
    public pointMeshMovers::multiRigidBody,
    public RBD::rigidBodyMotion
{
    // Private Data
 
        //- Switch for test-mode in which only the
        //  gravitational body-force is applied
        Switch test_;
 
        //- Number of iterations in test-mode
        label nIter_;
 
        //- Reference density required by the forces object for
        //  incompressible calculations, required if rho == rhoInf
        scalar rhoInf_;
 
        //- Name of density field, optional unless used for an
        //  incompressible simulation, when this needs to be specified
        //  as rhoInf
        word rhoName_;
 
        //- Ramp the forces according to the specified function and period
        autoPtr<Function1<scalar>> ramp_;
 
        //- Current time index (used for updating)
        label curTimeIndex_;
 
 
    // Private Member Functions
 
        //- To avoid warning from clang
        using RBD::rigidBodyMotion::write;
 
        //- Return the list of transformation for each body from time 0
        virtual List<septernion> transforms0() const;
 
        //- Move the bodies
        virtual void moveBodies();
 
 
public:
 
    //- Runtime type information
    TypeName("rigidBodyMotion");
 
 
    // Constructors
 
        //- Construct from polyMesh and dictionary
        rigidBodyMotion(const polyMesh&, const dictionary& dict);
 
        //- Disallow default bitwise copy construction
        rigidBodyMotion(const rigidBodyMotion&) = delete;
 
 
    //- Destructor
    ~rigidBodyMotion();
 
 
    // Member Functions
 
        //- Write motion state information for restart
        virtual bool write() const;
 
 
    // Member Operators
 
        //- Disallow default bitwise assignment
        void operator=(const rigidBodyMotion&) = delete;
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace pointMeshMovers
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //