/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     | Website:  https://openfoam.org
    \\  /    A nd           | Copyright (C) 2018-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/>.

\*---------------------------------------------------------------------------*/

#include "functionDot.H"
#include "rigidBodyModelState.H"
#include "addToRunTimeSelectionTable.H"

// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //

namespace Foam
{
namespace RBD
{
namespace joints
{
    defineTypeNameAndDebug(functionDot, 0);

    addToRunTimeSelectionTable
    (
        joint,
        functionDot,
        dictionary
    );
}
}
}


// * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //

Foam::RBD::joints::functionDot::functionDot
(
    const rigidBodyModel& model,
    const dictionary& dict
)
:
    joint(model, 0),
    f_(Function1<scalar>::New("function", units::none, units::none, dict)),
    delta_(dict.lookupOrDefault<scalar>("delta", rootSmall))
{}


Foam::autoPtr<Foam::RBD::joint> Foam::RBD::joints::functionDot::clone() const
{
    return autoPtr<joint>(new functionDot(*this));
}


// * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //

Foam::RBD::joints::functionDot::~functionDot()
{}


// * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * * //

void Foam::RBD::joints::functionDot::jcalc
(
    joint::XSvc& J,
    const rigidBodyModelState& state
) const
{
    const label lambda = model_.lambda()[index_];
    const joint& parent = model_.joints()[lambda];

    spatialVector x(Zero), v(Zero), c(Zero);
    for(label i = 0; i < model_.joints()[lambda].nDoF(); ++ i)
    {
        const scalar qDot = state.qDot()[parent.qIndex() + i];
        const scalar qDdot = state.qDdot()[parent.qIndex() + i];
        const scalar qDddot = 0; // the third derivative is not stored

        const scalar f = f_->value(qDot);
        const scalar fMinusDf = f_->value(qDot - delta_/2);
        const scalar fPlusDf = f_->value(qDot + delta_/2);
        const scalar dfdqDot = (fPlusDf - fMinusDf)/delta_;
        const scalar d2fdqDot2 = (fPlusDf - 2*f + fMinusDf)/sqr(delta_);

        const spatialVector& s = parent.S()[i];

        x += f*s;
        v += dfdqDot*qDdot*s;
        c += (dfdqDot*qDddot + d2fdqDot2*sqr(qDdot))*s;
    }

    const scalar magW = mag(x.w());

    const tensor X(magW > vSmall ? quaternion(x.w(), magW).R() : tensor::I);

    J.X = spatialTransform(X, x.l());
    J.S = Zero;
    J.S1 = Zero;
    J.v = v;
    J.c = c;
}


// ************************************************************************* //