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

cat << EOF

The DPMFoam solver has solver has been replaced by the more general
denseParticleFoam solver, which supports incompressible flow, including the
effect of the volume fraction of particles on the continuous phase, coupled to
multiple run-time-selectable lagrangian clouds.

To run with a single cloud rename the constant/*CloudProperties file to
constant/cloudProperties.

To run with a multiple clouds create a constant/clouds file with a list of the
names of clouds in it. Each cloud then has a corresponding
constant/<cloudName>Properties file.

In addition, cloud properties files also now require a "type" entry to specify
the type of cloud model used (e.g., thermoCloud, reactingMultiphaseCloud,
collidingCloud, etc ...).

See the following case for an example converted from DPMFoam:

    \$FOAM_TUTORIALS/lagrangian/denseParticleFoam/Goldschmidt

EOF

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