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

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

Inheritance diagram for edgeMeshFormat:
Inheritance graph
[legend]
Collaboration diagram for edgeMeshFormat:
Collaboration graph
[legend]

Public Member Functions

 edgeMeshFormat (const fileName &)
 
virtual ~edgeMeshFormat ()=default
 
virtual bool read (const fileName &name)
 
virtual void write (const fileName &name, IOstreamOption streamOpt=IOstreamOption(), const dictionary &options=dictionary::null) const
 
- Public Member Functions inherited from edgeMesh
 edgeMesh (const faMesh &mesh)
 
label size () const
 
const edgeVectorFieldC () const
 
 TypeName ("edgeMesh")
 
 edgeMesh ()
 
 edgeMesh (const edgeMesh &em)
 
 edgeMesh (edgeMesh &&em)
 
 edgeMesh (const pointField &points, const edgeList &edges)
 
 edgeMesh (pointField &&pointLst, edgeList &&edgeLst)
 
 edgeMesh (const fileName &name)
 
 edgeMesh (const fileName &name, const word &fileType)
 
 declareRunTimeSelectionTable (autoPtr, edgeMesh, fileExtension,(const fileName &name),(name))
 
virtual ~edgeMesh ()=default
 
 declareMemberFunctionSelectionTable (void, edgeMesh, write, fileExtension,(const fileName &name, const edgeMesh &mesh, IOstreamOption streamOpt, const dictionary &options),(name, mesh, streamOpt, options))
 
void transfer (edgeMesh &mesh)
 
bool read (const fileName &name, const word &fileType)
 
const pointFieldpoints () const noexcept
 
const edgeListedges () const noexcept
 
const labelListListpointEdges () const
 
label regions (labelList &edgeRegion) const
 
virtual void clear ()
 
virtual void scalePoints (const scalar scaleFactor)
 
virtual void mergePoints (const scalar mergeDist)
 
virtual void mergeEdges ()
 
virtual void writeStats (Ostream &) const
 
virtual void write (const fileName &name, const word &fileType, IOstreamOption streamOpt=IOstreamOption(), const dictionary &options=dictionary::null) const
 
void operator= (const edgeMesh &rhs)
 
void operator= (edgeMesh &&rhs)
 
- Public Member Functions inherited from GeoMesh< faMesh >
 GeoMesh (const faMesh &mesh)
 
bool hasDb () const
 
const objectRegistrythisDb () const
 
const faMeshoperator() () const
 

Static Public Member Functions

static autoPtr< edgeMeshNew (const fileName &name)
 
static bool read (Istream &, pointField &, edgeList &)
 
static Ostreamwrite (Ostream &, const pointField &, const edgeList &)
 
static void write (const fileName &filename, const edgeMesh &mesh, IOstreamOption streamOpt=IOstreamOption(), const dictionary &options=dictionary::null)
 
- Static Public Member Functions inherited from edgeMesh
static label size (const Mesh &mesh)
 
static wordHashSet readTypes ()
 
static wordHashSet writeTypes ()
 
static bool canReadType (const word &fileType, bool verbose=false)
 
static bool canWriteType (const word &fileType, bool verbose=false)
 
static bool canRead (const fileName &name, bool verbose=false)
 
static autoPtr< edgeMeshNew (const fileName &name, const word &fileType)
 
static autoPtr< edgeMeshNew (const fileName &name)
 
static void write (const fileName &name, const edgeMesh &mesh, IOstreamOption streamOpt=IOstreamOption(), const dictionary &options=dictionary::null)
 
static void write (const fileName &name, const word &fileType, const edgeMesh &mesh, IOstreamOption streamOpt=IOstreamOption(), const dictionary &options=dictionary::null)
 

Static Protected Member Functions

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

Additional Inherited Members

- Public Types inherited from GeoMesh< faMesh >
typedef faMesh Mesh
 
typedef faMesh ::BoundaryMesh BoundaryMesh
 
- Protected Member Functions inherited from edgeMesh
pointFieldstoredPoints () noexcept
 
edgeListstoredEdges () noexcept
 
- Protected Attributes inherited from GeoMesh< faMesh >
const faMeshmesh_
 

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 54 of file edgeMeshFormat.H.

Constructor & Destructor Documentation

◆ edgeMeshFormat()

edgeMeshFormat ( const fileName filename)
explicit

Definition at line 32 of file edgeMeshFormat.C.

References Foam::blockMeshTools::read().

Here is the call graph for this function:

◆ ~edgeMeshFormat()

virtual ~edgeMeshFormat ( )
virtualdefault

Member Function Documentation

◆ writeHeader()

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

◆ New()

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

Definition at line 91 of file edgeMeshFormat.H.

References Foam::name().

Here is the call graph for this function:

◆ read() [1/2]

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

Definition at line 90 of file edgeMeshFormat.C.

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

Referenced by Foam::operator>>().

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

Definition at line 111 of file edgeMeshFormat.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, FUNCTION_NAME, Foam::nl, and os().

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

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,
IOstreamOption  streamOpt = IOstreamOption(),
const dictionary options = dictionary::null 
)
static

Definition at line 135 of file edgeMeshFormat.C.

References Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, FUNCTION_NAME, mesh, Foam::New(), IOobject::note(), os(), Foam::vtk::write(), and IOobject::writeHeader().

Here is the call graph for this function:

◆ read() [2/2]

bool read ( const fileName name)
virtual

Reimplemented from edgeMesh.

Definition at line 43 of file edgeMeshFormat.C.

References clear(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::New(), Foam::blockMeshTools::read(), IOobject::readHeader(), and IOobject::typeHeaderOk().

Here is the call graph for this function:

◆ write() [3/3]

virtual void write ( const fileName name,
IOstreamOption  streamOpt = IOstreamOption(),
const dictionary options = dictionary::null 
) const
inlinevirtual

Reimplemented from edgeMesh.

Definition at line 136 of file edgeMeshFormat.H.

References Foam::name(), and edgeMeshFormat::write().

Here is the call graph for this function:

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