SDA.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) 2011-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::solidBodyMotionFunctions::SDA
 
Description
    Ship design analysis (SDA) 3DoF motion function.
 
    Comprising sinusoidal roll (rotation about x), heave (z-translation)
    and sway (y-translation) motions with changing amplitude and phase.
 
See also
    Foam::solidBodyMotionFunctions::tabulated6DoFMotion
 
SourceFiles
    SDA.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef SDA_H
#define SDA_H
 
#include "solidBodyMotionFunction.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
namespace solidBodyMotionFunctions
{
 
/*---------------------------------------------------------------------------*\
                             Class SDA Declaration
\*---------------------------------------------------------------------------*/
 
class SDA
:
    public solidBodyMotionFunction
{
    // Private Data
 
        //- Center of gravity
        vector CofG_;
 
        //- Model scale ratio
        scalar lambda_;
 
        //- Max roll amplitude [rad]
        scalar rollAmax_;
 
        //- Min roll amplitude [rad]
        scalar rollAmin_;
 
        //- Heave amplitude [m]
        scalar heaveA_;
 
        //- Sway amplitude [m]
        scalar swayA_;
 
        //- Damping Coefficient [-]
        scalar Q_;
 
        //- Time Period for liquid [sec]
        scalar Tp_;
 
        //- Natural Period of Ship [sec]
        scalar Tpn_;
 
        //- Reference time step [sec]
        scalar dTi_;
 
        //- Incr. in Tp/unit 'dTi'[-]
        scalar dTp_;
 
 
public:
 
    //- Runtime type information
    TypeName("SDA");
 
 
    // Constructors
 
        //- Construct from components
        SDA
        (
            const word& name,
            const dictionary& SBMFCoeffs,
            const Time& runTime
        );
 
        //- Disallow default bitwise copy construction
        SDA(const SDA&) = delete;
 
 
        //- Construct and return a clone
        virtual autoPtr<solidBodyMotionFunction> clone() const
        {
            return autoPtr<solidBodyMotionFunction>
            (
                new SDA
                (
                    name_,
                    SBMFCoeffs_,
                    time_
                )
            );
        }
 
 
    //- Destructor
    virtual ~SDA();
 
 
    // Member Functions
 
        //- Return the solid-body motion transformation septernion
        virtual septernion transformation() const;
 
        //- Update properties from given dictionary
        virtual bool read(const dictionary& SBMFCoeffs);
 
 
    // Member Operators
 
        //- Disallow default bitwise assignment
        void operator=(const SDA&) = delete;
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace solidBodyMotionFunctions
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //