Line data    Source code

       1              : /*
       2              :  * Copyright (c) 2015:  G-CSC, Goethe University Frankfurt
       3              :  * Author: Sebastian Reiter
       4              :  * 
       5              :  * This file is part of UG4.
       6              :  * 
       7              :  * UG4 is free software: you can redistribute it and/or modify it under the
       8              :  * terms of the GNU Lesser General Public License version 3 (as published by the
       9              :  * Free Software Foundation) with the following additional attribution
      10              :  * requirements (according to LGPL/GPL v3 §7):
      11              :  * 
      12              :  * (1) The following notice must be displayed in the Appropriate Legal Notices
      13              :  * of covered and combined works: "Based on UG4 (www.ug4.org/license)".
      14              :  * 
      15              :  * (2) The following notice must be displayed at a prominent place in the
      16              :  * terminal output of covered works: "Based on UG4 (www.ug4.org/license)".
      17              :  * 
      18              :  * (3) The following bibliography is recommended for citation and must be
      19              :  * preserved in all covered files:
      20              :  * "Reiter, S., Vogel, A., Heppner, I., Rupp, M., and Wittum, G. A massively
      21              :  *   parallel geometric multigrid solver on hierarchically distributed grids.
      22              :  *   Computing and visualization in science 16, 4 (2013), 151-164"
      23              :  * "Vogel, A., Reiter, S., Rupp, M., Nägel, A., and Wittum, G. UG4 -- a novel
      24              :  *   flexible software system for simulating pde based models on high performance
      25              :  *   computers. Computing and visualization in science 16, 4 (2013), 165-179"
      26              :  * 
      27              :  * This program is distributed in the hope that it will be useful,
      28              :  * but WITHOUT ANY WARRANTY; without even the implied warranty of
      29              :  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
      30              :  * GNU Lesser General Public License for more details.
      31              :  */
      32              : 
      33              : #ifndef __H__UG_file_io_asc
      34              : #define __H__UG_file_io_asc
      35              : 
      36              : #include "common/util/field.h"
      37              : #include "common/math/ugmath_types.h"
      38              : #include "lib_grid/lg_base.h"
      39              : #include "lib_grid/algorithms/field_util.h"
      40              : 
      41              : namespace ug{
      42              : 
      43              : class FileReaderASC{
      44              :         public:
      45              :                 FileReaderASC();
      46              :                 ~FileReaderASC();
      47              : 
      48              :         ///     set an external field in which the data will be loaded
      49              :         /**     By default data is loaded into the internal field of the FileReader.
      50              :          * If you want to provide a field into which the data shall be loaded,
      51              :          * e.g. to avoid memory duplication and copying, you may use this method.
      52              :          * In this case you should make sure that the provided field instance outlives
      53              :          * the FileReaders instance.
      54              :          * Call this method with NULL to indicate that the internal field shall be used again.
      55              :          * \note When an external field-pointer is set or unset, no data will be copied
      56              :          *               between the internal and external fields. Unless a new load_file
      57              :          *               has been executed, the provided data may not be of any use.*/
      58              :                 void set_field(Field<number>* field);
      59              : 
      60              :                 void load_file(const char* filename);
      61              : 
      62            0 :                 number cell_size() const                        {return m_cellSize;}
      63            0 :                 number lower_left_corner_x() const      {return m_llcorner.x();}
      64            0 :                 number lower_left_corner_y() const      {return m_llcorner.y();}
      65            0 :                 number no_data_value() const            {return m_noDataValue;}
      66              :                 size_t num_rows() const                         {return m_field->height();}
      67              :                 size_t num_columns() const                      {return m_field->width();}
      68              : 
      69              :                 number at(size_t r, size_t c) const     {return m_field->at(r, c);}
      70            0 :                 const Field<number>& field() const    {return *m_field;}
      71              : 
      72              :         private:
      73              :                 Field<number>*    m_field;
      74              :                 number                  m_cellSize;
      75              :                 vector2                 m_llcorner;
      76              :                 number                  m_noDataValue;
      77              :                 SmartPtr<Field<number> >    m_privateField;
      78              : };
      79              : 
      80              : bool LoadGridFromASC(Grid& grid, const char* filename, AVector3& aPos = aPosition);
      81              : 
      82              : }//     end of namespace
      83              : 
      84              : #endif  //__H__UG_file_io_asc