https://subversion.renater.fr/anonscm/svn/fullswof-2d
Tip revision: f0d2c4ea29c8923198d21ac3f64a48eeae9bfb55 authored by fdarboux on 09 July 2020, 15:20:26 UTC
Update of HowtoRelease document
Update of HowtoRelease document
Tip revision: f0d2c4e
initialization_topo.hpp
/**
* @file initialization_topo.hpp
* @author Olivier Delestre <olivierdelestre41@yahoo.fr> (2008)
* @author Christian Laguerre <christian.laguerre@math.cnrs.fr> (2012-201()
* @version 1.06.00
* @date 2015-02-19
*
* @brief %Initialization of z
* @details
* Common part for all the initialization of the topography.
*
* @copyright License Cecill-V2 \n
* <http://www.cecill.info/licences/Licence_CeCILL_V2-en.html>
*
* (c) CNRS - Universite d'Orleans - BRGM (France)
*/
/*
*
* This file is part of FullSWOF_2D software.
* <https://sourcesup.renater.fr/projects/fullswof-2d/>
*
* FullSWOF_2D = Full Shallow-Water equations for Overland Flow,
* in two dimensions of space.
* This software is a computer program whose purpose is to compute
* solutions for 2D Shallow-Water equations.
*
* LICENSE
*
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* <http://www.cecill.info>.
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
*
******************************************************************************/
#ifndef PARAMETERS_HPP
#include "parameters.hpp"
#endif
#ifndef INITIALIZATION_TOPO_HPP
#define INITIALIZATION_TOPO_HPP
/** @class Initialization_topo
* @brief Initialization of z
* @details
* Class that contains all the common declarations for the initialization of the topography.
*/
class Initialization_topo{
public:
/** @brief Constructor */
Initialization_topo(Parameters &);
/** @brief Function to be specified in each initialization */
virtual void initialization(TAB &) =0;
/** @brief Destructor */
virtual ~Initialization_topo();
protected :
/** Number of cells in space in the x direction. */
const int NXCELL;
/** Number of cells in space in the y direction. */
const int NYCELL;
/** Space step in the x direction. */
const SCALAR DX;
/** Space step in the y direction. */
const SCALAR DY;
};
#endif
