SWE
Classes | Functions
/import/home/rettenbs/src/SWE/src/tools/help.hh File Reference
#include <cstring>
#include <iostream>
#include <fstream>
#include <sstream>

Go to the source code of this file.

Classes

class  Float1D
class  Float2D

Functions

std::string generateFileName (std::string baseName, int timeStep)
std::string generateFileName (std::string i_baseName, int i_blockPositionX, int i_blockPositionY, std::string i_fileExtension=".nc")
std::string generateFileName (std::string baseName, int timeStep, int block_X, int block_Y, std::string i_fileExtension=".vts")
std::string generateBaseFileName (std::string &i_baseName, int i_blockPositionX, int i_blockPositionY)
std::string generateContainerFileName (std::string baseName, int timeStep)

Detailed Description

This file is part of SWE.

Author:
Michael Bader, Kaveh Rahnema
Sebastian Rettenberger

LICENSE

SWE 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.

SWE 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 SWE. If not, see <http://www.gnu.org/licenses/>.

DESCRIPTION

TODO


Function Documentation

std::string generateBaseFileName ( std::string &  i_baseName,
int  i_blockPositionX,
int  i_blockPositionY 
) [inline]

Generates an output file name for a multiple SWE_Block version based on the ordering of the blocks.

Parameters:
i_baseNamebase name of the output.
i_blockPositionXposition of the SWE_Block in x-direction.
i_blockPositionYposition of the SWE_Block in y-direction.
Returns:
the output filename without timestep information and file extension
std::string generateContainerFileName ( std::string  baseName,
int  timeStep 
) [inline]

generate output filename for the ParaView-Container-File (to visualize multiple SWE_Blocks per checkpoint)

std::string generateFileName ( std::string  baseName,
int  timeStep 
) [inline]

generate output filenames for the single-SWE_Block version (for serial and OpenMP-parallelised versions that use only a single SWE_Block - one output file is generated per checkpoint)

Deprecated:
std::string generateFileName ( std::string  i_baseName,
int  i_blockPositionX,
int  i_blockPositionY,
std::string  i_fileExtension = ".nc" 
) [inline]

Generates an output file name for a multiple SWE_Block version based on the ordering of the blocks.

Parameters:
i_baseNamebase name of the output.
i_blockPositionXposition of the SWE_Block in x-direction.
i_blockPositionYposition of the SWE_Block in y-direction.
i_fileExtensionfile extension of the output file.
Returns:
Deprecated:
std::string generateFileName ( std::string  baseName,
int  timeStep,
int  block_X,
int  block_Y,
std::string  i_fileExtension = ".vts" 
) [inline]

generate output filename for the multiple-SWE_Block version (for serial and parallel (OpenMP and MPI) versions that use multiple SWE_Blocks - for each block, one output file is generated per checkpoint)

Deprecated:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends