flux_limiter.hh

Go to the documentation of this file.

/* Copyright (C) 2022, 2025 PISM Authors
 *
 * This file is part of PISM.
 *
 * PISM 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.
 *
 * PISM 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 PISM; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */
 
namespace pism {
 
namespace array {
class Scalar1;
class Staggered;
class Staggered1;
} // end of namespace array
 
/*! Limit fluxes to preserve non-negativity of a transported quantity.
 *
 * @param[in] dt time step length (seconds)
 * @param[in] x transported quantity (non-negative)
 * @param[in] flux flux on the staggered grid
 * @param[in] result flux with the limiter applied
 *
 * Returns the number of grid cells affected by the flux limiter.
 *
 * Does not require communication.
 */
int make_nonnegative_preserving(double dt, const array::Scalar1 &x, const array::Staggered1 &flux,
                                array::Staggered &result);
 
} // end of namespace pism