file_io.h

Go to the documentation of this file.

/*
 * Copyright (c) 2009-2015:  G-CSC, Goethe University Frankfurt
 * Author: Sebastian Reiter
 * 
 * This file is part of UG4.
 * 
 * UG4 is free software: you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License version 3 (as published by the
 * Free Software Foundation) with the following additional attribution
 * requirements (according to LGPL/GPL v3 §7):
 * 
 * (1) The following notice must be displayed in the Appropriate Legal Notices
 * of covered and combined works: "Based on UG4 (www.ug4.org/license)".
 * 
 * (2) The following notice must be displayed at a prominent place in the
 * terminal output of covered works: "Based on UG4 (www.ug4.org/license)".
 * 
 * (3) The following bibliography is recommended for citation and must be
 * preserved in all covered files:
 * "Reiter, S., Vogel, A., Heppner, I., Rupp, M., and Wittum, G. A massively
 *   parallel geometric multigrid solver on hierarchically distributed grids.
 *   Computing and visualization in science 16, 4 (2013), 151-164"
 * "Vogel, A., Reiter, S., Rupp, M., Nägel, A., and Wittum, G. UG4 -- a novel
 *   flexible software system for simulating pde based models on high performance
 *   computers. Computing and visualization in science 16, 4 (2013), 165-179"
 * 
 * This program 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 Lesser General Public License for more details.
 */
 
#ifndef __H__LIB_GRID__FILE_IO__
#define __H__LIB_GRID__FILE_IO__
 
#include "common/types.h"
#include "common/ug_config.h"
#include "common/error.h"
#include <lib_grid/attachments/attachment_pipe.h>
#include <lib_grid/grid/grid_base_objects.h>
#include "lib_grid/refinement/projectors/projection_handler.h"
 
namespace ug
{
 
//  predeclaration of surface view (declared in lib_grid/tools/surface_view.h)
class Grid;
class MultiGrid;
class SurfaceView;
class ISubsetHandler;
 
 
template <class TAPos>
UG_API
bool LoadGridFromFile(Grid& grid, SPProjectionHandler& ph, size_t& num_ph, ISubsetHandler& sh, std::vector<std::string> additionalSHNames,
            std::vector<SmartPtr<ISubsetHandler>> ash, const char* filename, TAPos& aPos, int procId = -1);
 
template <class TAPos>
UG_API
bool LoadGridFromFile(Grid& grid, ISubsetHandler& sh, const char* filename, TAPos& aPos, int procId = -1);
 
template <class TAPos>
UG_API
bool LoadGridFromFile(Grid& grid, const char* filename, TAPos& aPos, int procId = -1);
 
UG_API
bool LoadGridFromFile(Grid& grid, ISubsetHandler& sh, const char* filename, int procId = -1);
 
UG_API
bool LoadGridFromFile(Grid& grid, const char* filename, int procId = -1);
 
template <class TAPos>
UG_API
bool SaveGridToFile(Grid& grid, ISubsetHandler& sh,
          const char* filename, TAPos& aPos);
 
template <class TAPos>
UG_API
bool SaveGridToFile(Grid& grid, const char* filename, TAPos& aPos);
 
UG_API
bool SaveGridToFile(Grid& grid, ISubsetHandler& sh, const char* filename);
 
UG_API
bool SaveGridToFile(Grid& grid, const char* filename);
 
bool SaveGridHierarchyTransformed(MultiGrid& mg, ISubsetHandler& sh,
                  const char* filename, number offset);
 
 
bool SaveGridHierarchyTransformed(MultiGrid& mg, const char* filename,
                    number offset);
 
 
bool SaveParallelGridLayout(MultiGrid& mg, const char* filename,
              number offset = 0.1);
 
 
 
bool SaveSurfaceViewTransformed(MultiGrid& mg, const SurfaceView& sv,
                const char* filename, number offset = 0.1);
 
 
 
template <class TAPos>
void CopyGridLevel(MultiGrid& srcMG, Grid& destGrid,
           ISubsetHandler& srcSH, ISubsetHandler& destSH,
           int lvl, TAPos aPos);
 
 
 
template <class TAPos>
void CopyGrid
(
  Grid& srcGrid,
  Grid& destGrid,
  ISubsetHandler& srcSH,
  ISubsetHandler& destSH,
  TAPos aPos
);
 
 
template <typename TAPos>
void MergeGrids
(
  Grid& mrgGrid,
  Grid& grid,
  ISubsetHandler& mrgSh,
  ISubsetHandler& sh,
  TAPos aPos,
  bool joinSubsets
);
 
 
template <class TAPos>
bool SaveGridLevel(MultiGrid& srcMG, ISubsetHandler& srcSH, int lvl,
           const char* filename, TAPos aPos);
 
 
 
bool SaveGridLevelToFile(MultiGrid& srcMG, ISubsetHandler& srcSH, int lvl,
                     const char* filename);
 
template<class TElem>
void CopyGridElements(Grid& srcGrid, Grid& destGrid,
              ISubsetHandler& srcSH, ISubsetHandler& destSH,
            Attachment<Vertex*>& aNewVrt);
}
 
#include "file_io_impl.h"
 
#endif