edgeMeshFormat Class Reference

Provide a means of reading/writing the single-file OpenFOAM edge format. More...

Inheritance diagram for edgeMeshFormat:
Collaboration diagram for edgeMeshFormat:

Public Member Functions

 edgeMeshFormat (const fileName &)
 Construct from file name. More...
 
 edgeMeshFormat (const edgeMeshFormat &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~edgeMeshFormat ()
 Destructor. More...
 
virtual bool read (const fileName &)
 Read from file. More...
 
virtual void write (const fileName &name) const
 Write object. More...
 
void operator= (const edgeMeshFormat &)=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...
 

Static Public Member Functions

static autoPtr< edgeMesh > New (const fileName &name)
 Read file and return edgeMesh. More...
 
static bool read (Istream &, pointField &, edgeList &)
 Read edgeMesh components from stream. More...
 
static Ostream & write (Ostream &, const pointField &, const edgeList &)
 Write edgeMesh components to stream. More...
 
static void write (const fileName &, const edgeMesh &)
 Write edgeMesh with a mimicked IOobject header. 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 Protected Member Functions

static void writeHeader (Ostream &, const pointField &, const edgeList &)
 Write header information. More...
 
- Static Protected Member Functions inherited from edgeMeshFormatsCore
static string getLineNoComment (IFstream &)
 Read non-comment line. More...
 

Additional Inherited Members

- Static Public Attributes inherited from edgeMeshFormatsCore
static word nativeExt
 The file extension corresponding to 'native' edge format. More...
 
- 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

Provide a means of reading/writing the single-file OpenFOAM edge format.

Note
This class provides more methods than the regular edge format interface.
Source files

Definition at line 55 of file edgeMeshFormat.H.

Constructor & Destructor Documentation

◆ edgeMeshFormat() [1/2]

edgeMeshFormat ( const fileName &  filename)

Construct from file name.

Definition at line 36 of file edgeMeshFormat.C.

References Foam::blockMeshTools::read(), and edgeMeshFormat::read().

Referenced by edgeMeshFormat::New().

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

◆ edgeMeshFormat() [2/2]

edgeMeshFormat ( const edgeMeshFormat &  )
delete

Disallow default bitwise copy construction.

◆ ~edgeMeshFormat()

virtual ~edgeMeshFormat ( )
inlinevirtual

Destructor.

Definition at line 96 of file edgeMeshFormat.H.

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

Here is the call graph for this function:

Member Function Documentation

◆ writeHeader()

static void writeHeader ( Ostream &  ,
const pointField &  ,
const edgeList &   
)
staticprotected

Write header information.

◆ New()

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

Read file and return edgeMesh.

Definition at line 86 of file edgeMeshFormat.H.

References edgeMeshFormat::edgeMeshFormat().

Here is the call graph for this function:

◆ read() [1/2]

bool read ( Istream &  is,
pointField &  pointLst,
edgeList &  edgeLst 
)
static

Read edgeMesh components from stream.

Definition at line 105 of file edgeMeshFormat.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, IOstream::good(), and edgeMeshFormat::write().

Referenced by edgeMeshFormat::edgeMeshFormat(), Foam::operator>>(), edgeMeshFormat::read(), and edgeMeshFormat::~edgeMeshFormat().

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

◆ write() [1/3]

Foam::Ostream & write ( Ostream &  os,
const pointField &  pointLst,
const edgeList &  edgeLst 
)
static

Write edgeMesh components to stream.

Definition at line 129 of file edgeMeshFormat.C.

References IOstream::check(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, IOstream::good(), IOstream::name(), and Foam::nl.

Referenced by Foam::operator<<(), edgeMeshFormat::read(), edgeMeshFormat::write(), and edgeMeshFormat::~edgeMeshFormat().

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

◆ write() [2/3]

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

Write edgeMesh with a mimicked IOobject header.

Definition at line 159 of file edgeMeshFormat.C.

References IOstream::check(), edgeMesh::edges(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, IOobject::note(), edgeMesh::points(), Foam::vtkWriteOps::write(), and IOobject::writeHeader().

Here is the call graph for this function:

◆ read() [2/2]

bool read ( const fileName &  filename)
virtual

Read from file.

Reimplemented from edgeMesh.

Definition at line 47 of file edgeMeshFormat.C.

References clear(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, fileName::name(), fileName::path(), Foam::blockMeshTools::read(), edgeMeshFormat::read(), IOobject::readHeader(), and IOobject::typeHeaderOk().

Here is the call graph for this function:

◆ write() [3/3]

virtual void write ( const fileName &  name) const
inlinevirtual

Write object.

Reimplemented from edgeMesh.

Definition at line 125 of file edgeMeshFormat.H.

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

Here is the call graph for this function:

◆ operator=()

void operator= ( const edgeMeshFormat &  )
delete

Disallow default bitwise assignment.

Referenced by edgeMeshFormat::write().

Here is the caller graph for this function:

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