#!/bin/sh
#------------------------------------------------------------------------------
# =========                 |
# \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
#  \\    /   O peration     | Website:  https://openfoam.org
#   \\  /    A nd           | Copyright (C) 2023 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
#     scalarTransportFoam
#
# Description
#     Script to inform the user that scalarTransportFoam has been superseded
#     and replaced by the more general functions solver module
#     executed by the foamRun application.
#
#     The solver specified by either the subSolver or if not present the solver
#     entry in the controlDict is instantiated to provide the physical fields
#     needed by the functionObjects.  The scalarTransport functionObject is then
#     instantiated from the functions entry in the controlDict and executed in a
#     time-loop also controlled by entries in controlDict and the maxDeltaT()
#     returned by the sub-solver.  See:
#
#         tutorials/incompressibleFluid/pitzDailyScalarTransport
#
#------------------------------------------------------------------------------

cat <<EOF

scalarTransportFoam has been superseded and replaced by the more general
functions solver module executed by the foamRun application:

    foamRun -solver functions

The solver specified by either the subSolver or if not present the solver entry
in the controlDict is instantiated to provide the physical fields needed by the
functionObjects.  The scalarTransport functionObject is then instantiated from
the functions entry in the controlDict and executed in a time-loop also
controlled by entries in controlDict and the maxDeltaT() returned by the
sub-solver.  See:

    tutorials/incompressibleFluid/pitzDailyScalarTransport

EOF

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