surfaceFormatsCore Class Reference

A collection of helper functions for reading/writing surface formats. More...

Inheritance diagram for surfaceFormatsCore:

Collaboration diagram for surfaceFormatsCore:

Public Member Functions
	surfaceFormatsCore ()=default
virtual	~surfaceFormatsCore ()=default

Static Public Member Functions
static bool	checkSupport (const wordHashSet &available, const word &fileType, const bool verbose=false, const char *functionName=nullptr)
static fileName	findFile (const IOobject &io, const bool isGlobal=true)
static fileName	findFile (const IOobject &io, const dictionary &dict, const bool isGlobal=true)

Static Public Attributes
static word	nativeExt

Static Protected Member Functions
static string	getLineNoComment (ISstream &is, const char comment='#')
template<class Container >
static List< surfZone >	oneZone (const Container &container, const word &name="zone0")
static labelList	getSelectedPatches (const surfZoneList &patches, const wordRes &allow, const wordRes &deny=wordRes())
static fileName	relativeFilePath (const IOobject &io, const fileName &f, const bool isGlobal=true)
static fileName	checkFile (const IOobject &io, const bool isGlobal=true)
static fileName	checkFile (const IOobject &io, const dictionary &dict, const bool isGlobal=true)

Friends
class	::Foam::triSurface

Detailed Description

A collection of helper functions for reading/writing surface formats.

Source files

• surfaceFormatsCore.H
• surfaceFormatsCore.C

Definition at line 62 of file surfaceFormatsCore.H.

Constructor & Destructor Documentation

surfaceFormatsCore()

surfaceFormatsCore ( )

default

~surfaceFormatsCore()

virtual ~surfaceFormatsCore ( )

virtualdefault

Member Function Documentation

getLineNoComment()

Foam::string getLineNoComment ( ISstream &  is, const char  comment = '#'  )

staticprotected

Definition at line 36 of file surfaceFormatsCore.C.

References ISstream::getLine(), and IOstream::good().

Here is the call graph for this function:

oneZone()

static List<surfZone> oneZone ( const Container &  container, const word &  name = "zone0"  )

inlinestaticprotected

Definition at line 79 of file surfaceFormatsCore.H.

References Foam::name().

Here is the call graph for this function:

getSelectedPatches()

Foam::labelList getSelectedPatches ( const surfZoneList &  patches, const wordRes &  allow, const wordRes &  deny = wordRes()  )

staticprotected

Definition at line 53 of file surfaceFormatsCore.C.

References Foam::PtrListOps::findMatching(), and patches.

Here is the call graph for this function:

relativeFilePath()

Foam::fileName relativeFilePath ( const IOobject &  io, const fileName &  f, const bool  isGlobal = true  )

staticprotected

Parameters

isGlobal

resolve as a global file

Definition at line 171 of file surfaceFormatsCore.C.

References string::expand(), f(), Foam::fileHandler(), fileOperation::filePath(), fileName::isAbsolute(), and word::null.

Referenced by triSurface::relativeFilePath().

Here is the call graph for this function:

Here is the caller graph for this function:

checkFile() [1/2]

Foam::fileName checkFile ( const IOobject &  io, const bool  isGlobal = true  )

staticprotected

Parameters

isGlobal

resolve as a global file

Definition at line 250 of file surfaceFormatsCore.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, IOobject::globalFilePath(), IOobject::localFilePath(), Foam::nl, word::null, and IOobject::objectPath().

Referenced by triSurface::checkFile().

Here is the call graph for this function:

Here is the caller graph for this function:

checkFile() [2/2]

Foam::fileName checkFile ( const IOobject &  io, const dictionary &  dict, const bool  isGlobal = true  )

staticprotected

Parameters

isGlobal

resolve as a global file

Definition at line 275 of file surfaceFormatsCore.C.

References dict, Foam::exists(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, IOobject::globalFilePath(), keyType::LITERAL, IOobject::localFilePath(), Foam::nl, word::null, and IOobject::objectPath().

Here is the call graph for this function:

checkSupport()

bool checkSupport ( const wordHashSet &  available, const word &  fileType, const bool  verbose = false, const char *  functionName = nullptr  )

static

Definition at line 319 of file surfaceFormatsCore.C.

References Foam::flatOutput(), Foam::Info, and Foam::nl.

Referenced by triSurface::canReadType(), and triSurface::canWriteType().

Here is the call graph for this function:

Here is the caller graph for this function:

findFile() [1/2]

Foam::fileName findFile ( const IOobject &  io, const bool  isGlobal = true  )

static

Parameters

isGlobal

resolve as a global file

Definition at line 197 of file surfaceFormatsCore.C.

References Foam::exists(), IOobject::globalFilePath(), IOobject::localFilePath(), and word::null.

Referenced by triSurface::findFile().

Here is the call graph for this function:

Here is the caller graph for this function:

findFile() [2/2]

Foam::fileName findFile ( const IOobject &  io, const dictionary &  dict, const bool  isGlobal = true  )

static

Parameters

isGlobal

resolve as a global file

Definition at line 219 of file surfaceFormatsCore.C.

References dict, Foam::exists(), IOobject::globalFilePath(), keyType::LITERAL, IOobject::localFilePath(), and word::null.

Here is the call graph for this function:

Friends And Related Function Documentation

::Foam::triSurface

friend class ::Foam::triSurface

friend

Definition at line 67 of file surfaceFormatsCore.H.

Member Data Documentation

nativeExt

Foam::word nativeExt

static

Definition at line 136 of file surfaceFormatsCore.H.

---

The documentation for this class was generated from the following files:

• src/surfMesh/surfaceFormats/surfaceFormatsCore.H
• src/surfMesh/surfaceFormats/surfaceFormatsCore.C