Files
openfoam/src/surfMesh/surfaceFormats/surfaceFormatsCore.H
2009-07-10 19:21:21 +01:00

136 lines
3.7 KiB
C++

/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 1991-2009 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
OpenFOAM 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 2 of the License, or (at your
option) any later version.
OpenFOAM 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 OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
Foam::fileFormats::surfaceFormatsCore
Description
A collection of helper functions for reading/writing surface formats.
SourceFiles
surfaceFormatsCore.C
\*---------------------------------------------------------------------------*/
#ifndef surfaceFormatsCore_H
#define surfaceFormatsCore_H
#include "Map.H"
#include "HashSet.H"
#include "labelList.H"
#include "surfZoneList.H"
#include "surfZoneIdentifierList.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
// Forward declaration of friend functions and operators
class IFstream;
class Time;
namespace fileFormats
{
/*---------------------------------------------------------------------------*\
Class surfaceFormatsCore Declaration
\*---------------------------------------------------------------------------*/
class surfaceFormatsCore
{
protected:
//- Return a list with a single entry,
// the size corresponds to that of the container
template<class Container>
static List<surfZone> oneZone
(
const Container& container,
const word& name = "zone0"
)
{
return List<surfZone>(1, surfZone(name, container.size(), 0, 0));
}
//- Read non-comment line
static string getLineNoComment(IFstream&);
public:
// Static Data
//- The file extension corresponding to 'native' surface format
// Normally "ofs" (mnemonic: OF = OpenFOAM, S = Surface)
static word nativeExt;
// Static Member Functions
static bool checkSupport
(
const wordHashSet& available,
const word& ext,
const bool verbose,
const word& functionName
);
//- Return the local file name (within time directory)
// NEEDS FIXING
static fileName localMeshFileName(const word& surfName="");
//- Find instance with surfName
// NEEDS FIXING
static fileName findMeshInstance(const Time&, const word& surfName="");
//- Find mesh file with surfName
// NEEDS FIXING
static fileName findMeshFile(const Time&, const word& surfName="");
// Constructors
//- Construct null
surfaceFormatsCore();
// Destructor
virtual ~surfaceFormatsCore();
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace fileFormats
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //