STARCDCore Class Reference

Core routines used when reading/writing PROSTAR vrt/cel/bnd files. More...

Inheritance diagram for STARCDCore:

Collaboration diagram for STARCDCore:

Public Types
enum	fileHeader { HEADER_CEL, HEADER_VRT, HEADER_BND }
enum	fileExt { CEL_FILE, VRT_FILE, BND_FILE, INP_FILE }
enum	matlType {   starcdFluidType = 1, starcdSolidType = 2, starcdBaffleType = 3, starcdShellType = 4,   starcdLineType = 5, starcdPointType = 6 }
enum	shapeType {   starcdPoint = 1, starcdLine = 2, starcdShell = 3, starcdHex = 11,   starcdPrism = 12, starcdTet = 13, starcdPyr = 14, starcdPoly = 255 }

Static Public Member Functions
static fileName	starFileName (const fileName &baseName, const enum fileExt ext)
static void	removeFiles (const fileName &baseName)
static label	readPoints (IFstream &is, List< point > &points, List< label > &ids)
static void	writePoints (Ostream &os, const UList< point > &points, const scalar scaleFactor=1.0)

Static Public Attributes
static const char *const	defaultBoundaryName
static const char *const	defaultSolidBoundaryName

Protected Member Functions
	STARCDCore ()=default

Static Protected Member Functions
static bool	readHeader (IFstream &is, const enum fileHeader header)
static void	writeHeader (Ostream &os, const enum fileHeader header)

Static Protected Attributes
static const Map< FixedList< int, 6 > >	starToFoamFaceAddr
static const Map< FixedList< int, 6 > >	foamToStarFaceAddr

Detailed Description

Core routines used when reading/writing PROSTAR vrt/cel/bnd files.

Source files

• STARCDCore.H
• STARCDCore.C

Definition at line 55 of file STARCDCore.H.

Member Enumeration Documentation

fileHeader

enum fileHeader

Enumerator
HEADER_CEL
HEADER_VRT
HEADER_BND

Definition at line 62 of file STARCDCore.H.

fileExt

enum fileExt

Enumerator
CEL_FILE
VRT_FILE
BND_FILE
INP_FILE

Definition at line 70 of file STARCDCore.H.

matlType

enum matlType

Enumerator
starcdFluidType
starcdSolidType
starcdBaffleType
starcdShellType
starcdLineType
starcdPointType

Definition at line 79 of file STARCDCore.H.

shapeType

enum shapeType

Enumerator
starcdPoint
starcdLine
starcdShell
starcdHex
starcdPrism
starcdTet
starcdPyr
starcdPoly

Definition at line 90 of file STARCDCore.H.

Constructor & Destructor Documentation

STARCDCore()

STARCDCore ( )

protecteddefault

Member Function Documentation

readHeader()

bool readHeader ( IFstream &  is, const enum fileHeader  header  )

staticprotected

Definition at line 115 of file STARCDCore.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, IOstream::good(), Foam::Info, IFstream::name(), Foam::nl, and Foam::readToNewline().

Referenced by STARCDMeshReader::readCells().

Here is the call graph for this function:

Here is the caller graph for this function:

writeHeader()

void writeHeader ( Ostream &  os, const enum fileHeader  header  )

staticprotected

Definition at line 149 of file STARCDCore.C.

References Foam::nl, and os().

Here is the call graph for this function:

starFileName()

Foam::fileName starFileName ( const fileName &  baseName, const enum fileExt  ext  )

static

Definition at line 170 of file STARCDCore.C.

Referenced by STARCDCore::removeFiles().

Here is the caller graph for this function:

removeFiles()

void removeFiles ( const fileName &  baseName )

static

Definition at line 179 of file STARCDCore.C.

References STARCDCore::BND_FILE, STARCDCore::CEL_FILE, STARCDCore::INP_FILE, Foam::rm(), STARCDCore::starFileName(), and STARCDCore::VRT_FILE.

Referenced by STARCDMeshWriter::write().

Here is the call graph for this function:

Here is the caller graph for this function:

readPoints()

Foam::label readPoints ( IFstream &  is, List< point > &  points, List< label > &  ids  )

static

Definition at line 189 of file STARCDCore.C.

References DynamicList::append(), DynamicList::clear(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, IOstream::good(), token::isLabel(), token::labelToken(), Foam::max(), IFstream::name(), points, ISstream::read(), List::transfer(), x, and y.

Here is the call graph for this function:

writePoints()

void writePoints ( Ostream &  os, const UList< point > &  points, const scalar  scaleFactor = 1.0  )

static

Definition at line 238 of file STARCDCore.C.

References Foam::nl, os(), p, points, and Foam::writeHeader().

Here is the call graph for this function:

Member Data Documentation

defaultBoundaryName

const char *const defaultBoundaryName

static

Initial value:

=
    "Default_Boundary_Region"

Definition at line 104 of file STARCDCore.H.

defaultSolidBoundaryName

const char *const defaultSolidBoundaryName

static

Initial value:

=
    "Default_Boundary_Solid"

Definition at line 108 of file STARCDCore.H.

starToFoamFaceAddr

const Foam::Map< Foam::FixedList< int, 6 > > starToFoamFaceAddr

staticprotected

Initial value:

=
{
    { starcdHex,   { 4, 5, 2, 3, 0, 1 } },
    { starcdPrism, { 0, 1, 4, -1, 2, 3 } },
    { starcdTet,   { 3, -1, 2, -1, 1, 0 } },
    { starcdPyr,   { 0, -1, 4, 2, 1, 3 } }
}

Definition at line 125 of file STARCDCore.H.

Referenced by STARCDMeshReader::readBoundary().

foamToStarFaceAddr

const Foam::Map< Foam::FixedList< int, 6 > > foamToStarFaceAddr

staticprotected

Initial value:

=
{
    { starcdHex,   { 4, 5, 2, 3, 0, 1 } },
    { starcdPrism, { 0, 1, 4, 5, 2, -1 } },
    { starcdTet,   { 5, 4, 2, 0, -1, -1 } },
    { starcdPyr,   { 0, 4, 3, 5, 2, -1 } }
}

Definition at line 129 of file STARCDCore.H.

---

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

• src/fileFormats/starcd/STARCDCore.H
• src/fileFormats/starcd/STARCDCore.C