Skip to main content
  • Home
  • Development
  • Documentation
  • Donate
  • Operational login
  • Browse the archive

swh logo
SoftwareHeritage
Software
Heritage
Archive
Features
  • Search

  • Downloads

  • Save code now

  • Add forge now

  • Help

https://subversion.renater.fr/anonscm/svn/fullswof-2d
13 April 2021, 17:02:37 UTC
  • Code
  • Branches (1)
  • Releases (0)
  • Visits
    • Branches
    • Releases
    • HEAD
    No releases to show
  • 56f377c
  • /
  • trunk
  • /
  • Sources
  • /
  • libinitializations
  • /
  • huv_read.cpp
Raw File Download Save again
Take a new snapshot of a software origin

If the archived software origin currently browsed is not synchronized with its upstream version (for instance when new commits have been issued), you can explicitly request Software Heritage to take a new snapshot of it.

Use the form below to proceed. Once a request has been submitted and accepted, it will be processed as soon as possible. You can then check its processing state by visiting this dedicated page.
swh spinner

Processing "take a new snapshot" request ...

To reference or cite the objects present in the Software Heritage archive, permalinks based on SoftWare Hash IDentifiers (SWHIDs) must be used.
Select below a type of object currently browsed in order to display its associated SWHID and permalink.

  • content
  • directory
  • revision
  • snapshot
origin badgecontent badge
swh:1:cnt:de647b1a88528c7fad68b297792d4904dfc88c81
origin badgedirectory badge
swh:1:dir:999f1bb34ee33d5ad753f02f73015fccbd216cec
origin badgerevision badge
swh:1:rev:f0d2c4ea29c8923198d21ac3f64a48eeae9bfb55
origin badgesnapshot badge
swh:1:snp:0b5ec9ba5beee743d28d9984aa27fdced8d4bc64

This interface enables to generate software citations, provided that the root directory of browsed objects contains a citation.cff or codemeta.json file.
Select below a type of object currently browsed in order to generate citations for them.

  • content
  • directory
  • revision
  • snapshot
(requires biblatex-software package)
Generating citation ...
(requires biblatex-software package)
Generating citation ...
(requires biblatex-software package)
Generating citation ...
(requires biblatex-software package)
Generating citation ...
Tip revision: f0d2c4ea29c8923198d21ac3f64a48eeae9bfb55 authored by fdarboux on 09 July 2020, 15:20:26 UTC
Update of HowtoRelease document
Tip revision: f0d2c4e
huv_read.cpp
/**
 * @file huv_read.cpp
 * @author Olivier Delestre <olivierdelestre41@yahoo.fr> (2008)
 * @author Christian Laguerre <christian.laguerre@math.cnrs.fr> (2012-2015)
 * @version 1.08.01
 * @date 2019-12-16
 *
 * @brief File configuration
 * @details
 * Initialization of the water height and of the velocity:
 * the values are read in a file.
 *
 * @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.
 *
 ******************************************************************************/

#include "huv_read.hpp"

Huv_read::Huv_read(Parameters & par):Initialization_huv(par){

  /**
   * @details
   * Defines the name of the file for the initialization.
   * @param[in] par parameter, contains all the values from the parameters file.
   */

  huv_namefile = par.get_huvNameFile();
}


void Huv_read::initialization(TAB & h,TAB & u,TAB & v){

  /**
   * @details
   * Initializes the water height and the velocity to the values read in the corresponding file.
   * @param[in, out] h water height.
   * @param[in, out] u first component of the velocity.
   * @param[in, out] v second component of the velocity.
   * @warning (huv_namefile): ERROR: cannot open the huv file.
   * @warning (huv_namefile): ERROR: the number of data in this file is too big
   * @warning (huv_namefile): ERROR: line ***.
   * @warning (huv_namefile): WARNING: line ***.
   * @warning (huv_namefile): ERROR: the number of data in this file is too small
   * @warning (huv_namefile): ERROR: the value for the point x *** y *** is missing
   * @note If the file cannot be opened or if the data are not correct, the code will exit with failure termination code.
   */

  int row, column;
  int it=0; //iterator
  int num_lin=0; //iterator
  string line;// string to store a line of the input file
  char car;//First character of a commentary line

  //Opening the file and verification if it exists.
  ifstream getdata(huv_namefile.c_str(),ios::in);
  if (!getdata){
    //The input file cannot be opened.
    cerr << huv_namefile  << ": ERROR: cannot open the huv file\n";
    exit(EXIT_FAILURE);
  }

  //Initialization of water height to the largest finite representable floating-point number.
  //So that we will be able to check that the user fills the variables h, u and v properly.
  for (int i=1 ; i<NXCELL+1 ; i++){
    for (int j=1 ; j<NYCELL+1 ; j++){
      h[i][j]=MAX_SCAL;
    } //end for j
  } //end for i

  // As long as the end of the file is not reached, the next line is read.
  while (!getdata.eof()){
    num_lin++;
    getline (getdata, line, '\n');       // read a line
    istringstream entree (line);
    if (entree >> x >> y >> h_init >> u_init >> v_init) {

      //Check that the input file contains the expected number of data.
      if(++it > NXCELL*NYCELL){
        cerr << huv_namefile << ": ERROR: the number of data in this file is too big!"<<endl;
        exit(EXIT_FAILURE);
      }

      //We compute the index of the h, u and v arrays from the space variable in the input file.
      row=(int)ceil(x/DX); column=(int)ceil(y/DY); //The index corresponds to the smallest integer superior or equal to x/DX or y/DY.

      //Error if the x or y value of the input file is out of the domain.
      if(x < 0){
        cerr<< huv_namefile <<": ERROR: line "<< num_lin<<", x = "<< x <<" must be positive."<< endl;
        exit(EXIT_FAILURE);
      }
      if(y < 0){
        cerr<< huv_namefile <<": ERROR: line "<< num_lin<<", y = "<< y <<" must be positive."<< endl;
        exit(EXIT_FAILURE);
      }
      if(x > NXCELL*DX){
        cerr<< huv_namefile <<": ERROR: line "<< num_lin<<", x = "<< x <<" must be lower than "<< NXCELL*DX <<"."<< endl;
        exit(EXIT_FAILURE);
      }
      if(y > NYCELL*DY){
        cerr<< huv_namefile <<": ERROR: at line "<< num_lin<<", y = "<< y <<" must be lower than "<< NYCELL*DY <<"."<< endl;
        exit(EXIT_FAILURE);
      }

      //Error if the x or y value of the input file is not near the center of the cell.
      if (fabs(x - (row-0.5)*DX) > DX*RATIO_CLOSE_CELL){
        cout<< huv_namefile <<": ERROR: line "<< num_lin<<"; x = "<< x <<";\n This value is not close enough to the center of the cell.\n You may want to replace it with " << (row-0.5)*DX <<endl;
        exit(EXIT_FAILURE);
      }
      if (fabs(y - (column-0.5)*DY) > DY*RATIO_CLOSE_CELL){
        cout<<"column ="<<column<<endl;
        cout<< huv_namefile <<": ERROR: line "<< num_lin<<"; y = "<< y <<";\n This value is not close enough to the center of the cell.\n You may want to replace it with " << (column-0.5)*DY <<endl;
        exit(EXIT_FAILURE);
      }

      // Error if the water height h_init is negative.
      if (h_init < 0){
        cerr<< huv_namefile  <<": ERROR: line "<< num_lin<<"; A NEGATIVE initial water height was encountered in this file."<< endl;
        exit(EXIT_FAILURE);
      }

      //Store the input values into the h, u and v arrays.
      h[row][column]=h_init;
      u[row][column]=u_init;
      v[row][column]=v_init;

    }
    else{
      car='#'; //Initialization of the character used to identify the beginning of a comment
      istringstream entree_car (line);
      entree_car >> car;
      if (car != '#'){
        cout << huv_namefile << ": WARNING: line "<< num_lin <<"; a commentary should begin with the # symbol " <<endl;
      }
    }
  }

  //Closing the input file
  getdata.close();

  //Check that the input file contains the expected number of data.
  if(it < NXCELL*NYCELL){
    cerr << huv_namefile<< ": ERROR: the number of data in this file is too small!"<<endl;
    exit(EXIT_FAILURE);
  }

  //Final check: Does all the grid cells were filled with a value?
  for (int i=1 ; i<NXCELL+1 ; i++){
    for (int j=1 ; j<NYCELL+1 ; j++){
      if(h[i][j]>=MAX_SCAL){
        cerr<< huv_namefile<< ": ERROR: the value for the point x ="<< (i-0.5)*DX <<" y = "<< (j-0.5)*DY <<" is missing!"<<endl;
        exit(EXIT_FAILURE);
      }
    } //end for j
  } //end for i

}


Huv_read::~Huv_read(){
}

back to top

Software Heritage — Copyright (C) 2015–2026, The Software Heritage developers. License: GNU AGPLv3+.
The source code of Software Heritage itself is available on our development forge.
The source code files archived by Software Heritage are available under their own copyright and licenses.
Terms of use: Archive access, API— Content policy— Contact— JavaScript license information— Web API