All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
STARCD Class Reference

Read pro-STAR vrt/cel/bnd files. The protected data in meshReader are filled. More...

Inheritance diagram for STARCD:
Collaboration diagram for STARCD:

Public Member Functions

 STARCD (const fileName &prefix, const objectRegistry &, const scalar scaleFactor=1.0)
 Construct from case name. More...
 
 STARCD (const STARCD &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~STARCD ()
 Destructor. More...
 
void operator= (const STARCD &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from meshReader
 meshReader (const fileName &, const scalar scaleFactor=1.0)
 Construct from fileName. More...
 
 meshReader (const meshReader &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~meshReader ()
 Destructor. More...
 
virtual autoPtr< polyMeshmesh (const objectRegistry &)
 Create and return polyMesh. More...
 
void writeAux (const objectRegistry &) const
 Write auxiliary information. More...
 
void writeMesh (const polyMesh &, IOstream::streamFormat fmt=IOstream::BINARY) const
 Write mesh. More...
 
void operator= (const meshReader &)=delete
 Disallow default bitwise assignment. More...
 

Static Public Attributes

static bool keepSolids = false
 Keep solids (default false) More...
 

Protected Types

enum  cellType {
  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
}
 

Protected Member Functions

virtual bool readGeometry (const scalar scaleFactor=1.0)
 Read the mesh from the file(s) More...
 
void readPoints (const fileName &, const scalar scaleFactor)
 Read points from file. More...
 
virtual void readCells (const fileName &)
 Read cell connectivities from file. More...
 
void cullPoints ()
 Remove unused points. More...
 
void readBoundary (const fileName &)
 Read boundary (cell/face) definitions. More...
 
void readAux (const objectRegistry &)
 Read auxiliary data from constant/{boundaryRegion,cellTable}. More...
 

Static Protected Member Functions

static void readToNewline (IFstream &)
 Read and discard to newline. More...
 
static bool readHeader (IFstream &, word fileSignature)
 Read header. More...
 

Protected Attributes

cellShapeList cellShapes_
 Cell shapes. More...
 
labelList mapToFoamPointId_
 Point labels (imported Point numbering not necessarily contiguous) More...
 
labelList mapToFoamCellId_
 Cell labels (imported Cell numbering not necessarily contiguous) More...
 
boundaryRegion boundaryRegion_
 Boundary region data. More...
 
- Protected Attributes inherited from meshReader
fileName geometryFile_
 Referenced filename. More...
 
scalar scaleFactor_
 Geometry scaling. More...
 
pointField points_
 Points supporting the mesh. More...
 
labelList origCellId_
 Lookup original Cell number for a given cell. More...
 
List< List< cellFaceIdentifier > > boundaryIds_
 Identify boundary faces by cells and their faces. More...
 
wordList patchTypes_
 Boundary patch types. More...
 
wordList patchNames_
 Boundary patch names. More...
 
wordList patchPhysicalTypes_
 Boundary patch physical types. More...
 
faceListList cellFaces_
 List of faces for every cell. More...
 
faceList baffleFaces_
 List of each baffle face. More...
 
labelList cellTableId_
 Cell table id for each cell. More...
 
cellTable cellTable_
 Cell table persistent data saved as a dictionary. More...
 

Static Protected Attributes

static const char *const defaultBoundaryName
 
static const char *const defaultSolidBoundaryName
 
static const int starToFoamFaceAddr [4][6]
 Face addressing from pro-STAR faces -> OpenFOAM faces. More...
 
- Static Protected Attributes inherited from meshReader
static const cellModelunknownModel
 Pointers to cell shape models. More...
 
static const cellModeltetModel
 
static const cellModelpyrModel
 
static const cellModelprismModel
 
static const cellModelhexModel
 

Additional Inherited Members

- Static Public Member Functions inherited from meshReader
static void warnDuplicates (const word &context, const wordList &)
 Warn about repeated names. More...
 

Detailed Description

Read pro-STAR vrt/cel/bnd files. The protected data in meshReader are filled.

Starting with pro-STAR version 4, the files have become easier to read.

  • vertices are space-delimited.
  • the cell format is logical.
  • trimmed and degenerate cells are saved as polyhedral.
  • the boundaries corresponds to cells and their faces.
Source files

Definition at line 61 of file STARCDMeshReader.H.

Member Enumeration Documentation

◆ cellType

enum cellType
protected
Enumerator
starcdFluidType 
starcdSolidType 
starcdBaffleType 
starcdShellType 
starcdLineType 
starcdPointType 

Definition at line 118 of file STARCDMeshReader.H.

◆ shapeType

enum shapeType
protected
Enumerator
starcdPoint 
starcdLine 
starcdShell 
starcdHex 
starcdPrism 
starcdTet 
starcdPyr 
starcdPoly 

Definition at line 128 of file STARCDMeshReader.H.

Constructor & Destructor Documentation

◆ STARCD() [1/2]

STARCD ( const fileName prefix,
const objectRegistry registry,
const scalar  scaleFactor = 1.0 
)

Construct from case name.

Definition at line 1050 of file STARCDMeshReader.C.

References STARCD::readAux().

Referenced by STARCD::readGeometry().

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

◆ STARCD() [2/2]

STARCD ( const STARCD )
delete

Disallow default bitwise copy construction.

◆ ~STARCD()

~STARCD ( )
virtual

Destructor.

Definition at line 1067 of file STARCDMeshReader.C.

Member Function Documentation

◆ readGeometry()

bool readGeometry ( const scalar  scaleFactor = 1.0)
protectedvirtual

Read the mesh from the file(s)

Implements meshReader.

Definition at line 1036 of file STARCDMeshReader.C.

References STARCD::cullPoints(), meshReader::geometryFile_, STARCD::readBoundary(), STARCD::readCells(), STARCD::readPoints(), and STARCD::STARCD().

Here is the call graph for this function:

◆ readPoints()

void readPoints ( const fileName inputName,
const scalar  scaleFactor 
)
protected

Read points from file.

Original Point number for a given vertex

might need again in the future labelList origPointId(nPoints); origPointId = -1;

Definition at line 117 of file STARCDMeshReader.C.

References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, Foam::Info, STARCD::mapToFoamPointId_, Foam::max(), nPoints, meshReader::points_, STARCD::readHeader(), List< T >::setSize(), x, and y.

Referenced by STARCD::readAux(), and STARCD::readGeometry().

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

◆ readCells()

◆ cullPoints()

void cullPoints ( )
protected

Remove unused points.

Definition at line 976 of file STARCDMeshReader.C.

References meshReader::baffleFaces_, meshReader::cellFaces_, Foam::endl(), forAll, Foam::Info, Foam::inplaceRenumber(), Foam::inplaceReorder(), nPoints, meshReader::points_, List< T >::setSize(), and List< T >::size().

Referenced by STARCD::readGeometry().

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

◆ readBoundary()

◆ readAux()

void readAux ( const objectRegistry registry)
protected

Read auxiliary data from constant/{boundaryRegion,cellTable}.

Definition at line 96 of file STARCDMeshReader.C.

References STARCD::boundaryRegion_, meshReader::cellTable_, boundaryRegion::readDict(), cellTable::readDict(), and STARCD::readPoints().

Referenced by STARCD::STARCD().

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

◆ readToNewline()

void readToNewline ( IFstream is)
staticprotected

Read and discard to newline.

Definition at line 57 of file STARCDMeshReader.C.

Referenced by STARCD::readCells(), and STARCD::readHeader().

Here is the caller graph for this function:

◆ readHeader()

bool readHeader ( IFstream is,
word  fileSignature 
)
staticprotected

Read header.

Definition at line 68 of file STARCDMeshReader.C.

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

Referenced by STARCD::readBoundary(), STARCD::readCells(), and STARCD::readPoints().

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

◆ operator=()

void operator= ( const STARCD )
delete

Disallow default bitwise assignment.

Member Data Documentation

◆ defaultBoundaryName

const char *const defaultBoundaryName
staticprotected
Initial value:
=
"Default_Boundary_Region"

Definition at line 70 of file STARCDMeshReader.H.

Referenced by STARCD::readBoundary().

◆ defaultSolidBoundaryName

const char *const defaultSolidBoundaryName
staticprotected
Initial value:
=
"Default_Boundary_Solid"

Definition at line 71 of file STARCDMeshReader.H.

◆ starToFoamFaceAddr

const int starToFoamFaceAddr
staticprotected
Initial value:
=
{
{ 4, 5, 2, 3, 0, 1 },
{ 0, 1, 4, -1, 2, 3 },
{ 3, -1, 2, -1, 1, 0 },
{ 0, -1, 4, 2, 1, 3 }
}

Face addressing from pro-STAR faces -> OpenFOAM faces.

Definition at line 74 of file STARCDMeshReader.H.

Referenced by STARCD::readBoundary().

◆ cellShapes_

cellShapeList cellShapes_
protected

Cell shapes.

Definition at line 77 of file STARCDMeshReader.H.

Referenced by STARCD::readBoundary(), and STARCD::readCells().

◆ mapToFoamPointId_

labelList mapToFoamPointId_
protected

Point labels (imported Point numbering not necessarily contiguous)

Definition at line 80 of file STARCDMeshReader.H.

Referenced by STARCD::readCells(), and STARCD::readPoints().

◆ mapToFoamCellId_

labelList mapToFoamCellId_
protected

Cell labels (imported Cell numbering not necessarily contiguous)

Definition at line 83 of file STARCDMeshReader.H.

Referenced by STARCD::readBoundary(), and STARCD::readCells().

◆ boundaryRegion_

boundaryRegion boundaryRegion_
protected

Boundary region data.

Definition at line 86 of file STARCDMeshReader.H.

Referenced by STARCD::readAux(), and STARCD::readBoundary().

◆ keepSolids

bool keepSolids = false
static

Keep solids (default false)

Definition at line 146 of file STARCDMeshReader.H.

Referenced by STARCD::readCells().


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