#!/bin/sh
#------------------------------------------------------------------------------
# =========                 |
# \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
#  \\    /   O peration     | Website:  https://openfoam.org
#   \\  /    A nd           | Copyright (C) 2021-2022 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/>.
#
# Script
#     coldEngineFoam
#
# Description
#     Script to inform the user that coldEngineFoam has been replaced by the
#     more general fluid solver module.
#
#------------------------------------------------------------------------------

cat << EOF

The coldEngineFoam solver has solver has been replaced by the more general
fluid solver module, which supports engine mesh motion using an appropriate
fvMeshMover. e.g. layeredEngine

To run a coldEngineFoam case with

    foamRun -solver fluid

add a mover entry in constant/dynamicMeshDict
e.g. from the tutorials/modules/fluid/RAS/kivaTest case:

mover
{
    type            layeredEngine;

    libs            ("libfvMeshMovers.so");

    conRodLength    0.147;
    bore            0.092;
    stroke          0.08423;
    clearance       0.00115;
    pistonLayers    0;
}

EOF

#------------------------------------------------------------------------------