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

Description
    Motion function for solid regions representing a valve. Looks up the
    multiValveEngine mover from the associated fluid region and uses the motion
    specified for one of the valves.

    Example specification, in constant/\<solidRegion\>/dynamicMeshDict:
    \verbatim
    mover
    {
        type            pointMeshMover;
        libs            ("libfvMotionSolvers.so");

        pointMeshMover
        {
            type            solidBody;
            cellZone        all;
            solidBodyMotionFunction multiValveEngineValveMotion;
            fluidRegion     fluid;
            valve           iv;
        }
    }
    \endverbatim

SourceFiles
    multiValveEngineValveMotion.C

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

#ifndef multiValveEngineValveMotion_H
#define multiValveEngineValveMotion_H

#include "solidBodyMotionFunction.H"

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

namespace Foam
{
namespace solidBodyMotionFunctions
{

/*---------------------------------------------------------------------------*\
                  Class multiValveEngineValveMotion Declaration
\*---------------------------------------------------------------------------*/

class multiValveEngineValveMotion
:
    public solidBodyMotionFunction
{
private:

    // Private Data

        //- Name of the region in which the multiValveEngine mover is used
        word fluidRegionName_;

        //- Name of the valve
        word valveName_;

        //- Index of the valve
        mutable label valveIndex_;


public:

    //- Runtime type information
    TypeName("multiValveEngineValveMotion");


    // Constructors

        //- Construct from components
        multiValveEngineValveMotion
        (
            const word& name,
            const dictionary& SBMFCoeffs,
            const Time& runTime
        );

        //- Disallow default bitwise copy construction
        multiValveEngineValveMotion
        (
            const multiValveEngineValveMotion&
        ) = delete;

        //- Construct and return a clone
        virtual autoPtr<solidBodyMotionFunction> clone() const
        {
            return autoPtr<solidBodyMotionFunction>
            (
                new multiValveEngineValveMotion
                (
                    name_,
                    SBMFCoeffs_,
                    time_
                )
            );
        }


    //- Destructor
    virtual ~multiValveEngineValveMotion();


    // Member Functions

        //- Return the solid-body motion transformation septernion
        virtual septernion transformation() const;


    // Member Operators

        //- Disallow default bitwise assignment
        void operator=(const multiValveEngineValveMotion&) = delete;
};


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

} // End namespace solidBodyMotionFunctions
} // End namespace Foam

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

#endif

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