STARCDedgeFormat Class Reference

Read/write the lines from pro-STAR vrt/cel files. More...

Inheritance diagram for STARCDedgeFormat:
Collaboration diagram for STARCDedgeFormat:

Public Member Functions

 STARCDedgeFormat (const fileName &)
 Construct from file name. More...
 
 STARCDedgeFormat (const STARCDedgeFormat &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~STARCDedgeFormat ()
 Destructor. More...
 
virtual bool read (const fileName &)
 Read from file. More...
 
virtual void write (const fileName &name) const
 Write object. More...
 
void operator= (const STARCDedgeFormat &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from edgeMesh
 TypeName ("edgeMesh")
 Runtime type information. More...
 
 edgeMesh ()
 Construct null. More...
 
 edgeMesh (const pointField &, const edgeList &)
 Construct from components. More...
 
 edgeMesh (pointField &&, edgeList &&)
 Construct by transferring components (points, edges). More...
 
 edgeMesh (const edgeMesh &)
 Copy constructor. More...
 
 edgeMesh (edgeMesh &&)
 Move constructor. More...
 
 edgeMesh (const fileName &)
 Construct from file name (uses extension to determine type) More...
 
 edgeMesh (const fileName &, const word &ext)
 Construct from file name (uses extension to determine type) More...
 
 edgeMesh (Istream &)
 Construct from Istream. More...
 
 declareRunTimeSelectionTable (autoPtr, edgeMesh, fileExtension,(const fileName &name),(name))
 
virtual ~edgeMesh ()
 Destructor. More...
 
 declareMemberFunctionSelectionTable (void, edgeMesh, write, fileExtension,(const fileName &name, const edgeMesh &mesh),(name, mesh))
 
void transfer (edgeMesh &)
 Transfer the contents of the argument and annul the argument. More...
 
bool read (const fileName &, const word &ext)
 Read from file. Chooses reader based on explicit extension. More...
 
const pointField & points () const
 Return points. More...
 
const edgeList & edges () const
 Return edges. More...
 
const labelListList & pointEdges () const
 Return edges. More...
 
label regions (labelList &edgeRegion) const
 Find connected regions. Set region number per edge. More...
 
virtual void clear ()
 Clear all storage. More...
 
virtual void reset (pointField &&points, edgeList &&edges)
 Reset primitive data (points, edges) More...
 
virtual void scalePoints (const scalar)
 Scale points. A non-positive factor is ignored. More...
 
virtual void mergePoints (const scalar mergeDist, labelList &)
 Merge common points (points within mergeDist). Return map from. More...
 
virtual void mergeEdges ()
 Merge duplicate edges. More...
 
virtual void writeStats (Ostream &) const
 
void operator= (const edgeMesh &)
 
void operator= (edgeMesh &&)
 
- Public Member Functions inherited from edgeMeshFormatsCore
 edgeMeshFormatsCore ()
 Construct null. More...
 
virtual ~edgeMeshFormatsCore ()
 Destructor. More...
 
- Public Member Functions inherited from STARCDCore
 STARCDCore ()
 Construct null. More...
 

Static Public Member Functions

static autoPtr< edgeMesh > New (const fileName &name)
 Read file and return edgeMesh. More...
 
static void write (const fileName &, const edgeMesh &)
 Write edge mesh. More...
 
- Static Public Member Functions inherited from edgeMesh
static bool canRead (const fileName &, const bool verbose=false)
 Can we read this file format? More...
 
static bool canReadType (const word &ext, const bool verbose=false)
 Can we read this file format? More...
 
static bool canWriteType (const word &ext, const bool verbose=false)
 Can we write this file format type? More...
 
static wordHashSet readTypes ()
 
static wordHashSet writeTypes ()
 
static autoPtr< edgeMesh > New (const fileName &, const word &ext)
 Select constructed from filename (explicit extension) More...
 
static autoPtr< edgeMesh > New (const fileName &)
 Select constructed from filename (implicit extension) More...
 
static void write (const fileName &, const edgeMesh &)
 Write to file. More...
 
- Static Public Member Functions inherited from edgeMeshFormatsCore
static bool checkSupport (const wordHashSet &available, const word &ext, const bool verbose, const word &functionName)
 
- Static Public Member Functions inherited from STARCDCore
static bool readPoints (IFstream &, pointField &, labelList &ids)
 Read points from a (.vrt) file. More...
 
static void writePoints (Ostream &, const pointField &)
 Write header and points to (.vrt) file. More...
 

Static Protected Member Functions

static void writeCase (Ostream &, const pointField &, const label nEdges)
 
- Static Protected Member Functions inherited from edgeMeshFormatsCore
static string getLineNoComment (IFstream &)
 Read non-comment line. More...
 
- Static Protected Member Functions inherited from STARCDCore
static bool readHeader (IFstream &, const word &fileSignature)
 Read header. More...
 
static void writeHeader (Ostream &, const word &fileType)
 Write header for fileType (CELL|VERTEX|BOUNDARY) More...
 

Additional Inherited Members

- Static Public Attributes inherited from edgeMeshFormatsCore
static word nativeExt
 The file extension corresponding to 'native' edge format. More...
 
- Protected Types inherited from STARCDCore
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 inherited from edgeMesh
pointField & storedPoints ()
 Non-const access to global points. More...
 
edgeList & storedEdges ()
 Non-const access to the edges. More...
 

Detailed Description

Read/write the lines from pro-STAR vrt/cel files.

Note
Uses the extension .inp (input) to denote the format.
See also
Foam::meshReaders::STARCD
Source files

Definition at line 61 of file STARCDedgeFormat.H.

Constructor & Destructor Documentation

◆ STARCDedgeFormat() [1/2]

STARCDedgeFormat ( const fileName &  filename)

Construct from file name.

Definition at line 96 of file STARCDedgeFormat.C.

References STARCDedgeFormat::read().

Referenced by STARCDedgeFormat::New(), and STARCDedgeFormat::writeCase().

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

◆ STARCDedgeFormat() [2/2]

STARCDedgeFormat ( const STARCDedgeFormat &  )
delete

Disallow default bitwise copy construction.

◆ ~STARCDedgeFormat()

virtual ~STARCDedgeFormat ( )
inlinevirtual

Destructor.

Definition at line 120 of file STARCDedgeFormat.H.

References STARCDedgeFormat::read(), and STARCDedgeFormat::write().

Here is the call graph for this function:

Member Function Documentation

◆ writeCase()

void writeCase ( Ostream &  os,
const pointField &  pointLst,
const label  nEdges 
)
staticprotected

Definition at line 62 of file STARCDedgeFormat.C.

References clock::dateTime(), Ostream::flush(), fileName::lessExt(), fileName::name(), IOstream::name(), Foam::nl, List< T >::size(), and STARCDedgeFormat::STARCDedgeFormat().

Referenced by STARCDedgeFormat::write().

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

◆ New()

static autoPtr<edgeMesh> New ( const fileName &  name)
inlinestatic

Read file and return edgeMesh.

Definition at line 110 of file STARCDedgeFormat.H.

References STARCDedgeFormat::STARCDedgeFormat().

Here is the call graph for this function:

◆ write() [1/2]

void write ( const fileName &  filename,
const edgeMesh &  mesh 
)
static

Write edge mesh.

Definition at line 232 of file STARCDedgeFormat.C.

References edgeMesh::edges(), fileName::lessExt(), edgeMesh::points(), List< T >::size(), STARCDedgeFormat::writeCase(), and STARCDCore::writePoints().

Referenced by STARCDedgeFormat::read(), STARCDedgeFormat::write(), and STARCDedgeFormat::~STARCDedgeFormat().

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

◆ read()

◆ write() [2/2]

virtual void write ( const fileName &  name) const
inlinevirtual

Write object.

Reimplemented from edgeMesh.

Definition at line 133 of file STARCDedgeFormat.H.

References STARCDedgeFormat::operator=(), and STARCDedgeFormat::write().

Here is the call graph for this function:

◆ operator=()

void operator= ( const STARCDedgeFormat &  )
delete

Disallow default bitwise assignment.

Referenced by STARCDedgeFormat::write().

Here is the caller graph for this function:

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