Public Member Functions | Static Public Member Functions | Static Public Attributes | Static Protected Member Functions | List of all members
surfaceFormatsCore Class Reference

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

Inheritance diagram for surfaceFormatsCore:
[legend]
Collaboration diagram for surfaceFormatsCore:
[legend]

Public Member Functions

 surfaceFormatsCore ()=default
 Construct null. More...
 
virtual ~surfaceFormatsCore ()=default
 Destructor. More...
 

Static Public Member Functions

static bool checkSupport (const wordHashSet &available, const word &ext, const bool verbose, const word &functionName)
 Helper function when checking if a file extension is supported. More...
 
static fileName localMeshFileName (const word &surfName=word::null)
 Return the local file name (within time directory) More...
 
static fileName findMeshInstance (const Time &, const word &surfName=word::null)
 Find instance with surfName. More...
 
static fileName findMeshFile (const Time &, const word &surfName=word::null)
 Find mesh file with surfName. More...
 

Static Public Attributes

static word nativeExt
 The file extension corresponding to 'native' surface format. More...
 

Static Protected Member Functions

static string getLineNoComment (ISstream &is, const char comment='#')
 Read non-empty and non-comment line. More...
 
template<class Container >
static List< surfZone > oneZone (const Container &container, const word &name="zone0")
 

Detailed Description

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

Source files

Definition at line 61 of file surfaceFormatsCore.H.

Constructor & Destructor Documentation

◆ surfaceFormatsCore()

surfaceFormatsCore ( )
default

Construct null.

◆ ~surfaceFormatsCore()

virtual ~surfaceFormatsCore ( )
virtualdefault

Destructor.

Member Function Documentation

◆ getLineNoComment()

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

Read non-empty and non-comment line.

Definition at line 44 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

Return a surfZone list with a single entry, the size of which corresponds to that of the container

Definition at line 73 of file surfaceFormatsCore.H.

References Foam::name().

Here is the call graph for this function:

◆ checkSupport()

bool checkSupport ( const wordHashSet &  available,
const word &  ext,
const bool  verbose,
const word &  functionName 
)
static

Helper function when checking if a file extension is supported.

Definition at line 161 of file surfaceFormatsCore.C.

References Foam::endl(), Foam::flatOutput(), HashTable< T, Key, Hash >::found(), Foam::Info, Foam::nl, and HashTable< T, Key, Hash >::sortedToc().

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

Here is the call graph for this function:
Here is the caller graph for this function:

◆ localMeshFileName()

static fileName localMeshFileName ( const word &  surfName = word::null)
static

Return the local file name (within time directory)

NEEDS FIXING

◆ findMeshInstance()

static fileName findMeshInstance ( const Time &  ,
const word &  surfName = word::null 
)
static

Find instance with surfName.

NEEDS FIXING

◆ findMeshFile()

static fileName findMeshFile ( const Time &  ,
const word &  surfName = word::null 
)
static

Find mesh file with surfName.

NEEDS FIXING

Member Data Documentation

◆ nativeExt

Foam::word nativeExt
static

The file extension corresponding to 'native' surface format.

Normally "ofs" (mnemonic: OF = OpenFOAM, S = Surface)

Definition at line 87 of file surfaceFormatsCore.H.

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