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

Mesh data needed to do the Finite Area discretisation. More...

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

Public Member Functions

 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)
 
virtual bool read (const fileName &name)
 
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, IOstreamOption streamOpt=IOstreamOption(), const dictionary &options=dictionary::null) 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 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)
 

Protected Member Functions

pointFieldstoredPoints () noexcept
 
edgeListstoredEdges () noexcept
 

Friends

Ostreamoperator<< (Ostream &os, const edgeMesh &em)
 
Istreamoperator>> (Istream &is, edgeMesh &em)
 

Additional Inherited Members

- Public Types inherited from GeoMesh< faMesh >
typedef faMesh Mesh
 
typedef faMesh ::BoundaryMesh BoundaryMesh
 
- Protected Attributes inherited from GeoMesh< faMesh >
const faMeshmesh_
 

Detailed Description

Mesh data needed to do the Finite Area discretisation.

Points connected by edges.

Author Zeljko Tukovic, FMENA Hrvoje Jasak, Wikki Ltd.

Can be read from fileName based on extension. Uses New factory method to select the reader and transfer the result.

Source files

Definition at line 47 of file edgeFaMesh.H.

Constructor & Destructor Documentation

◆ edgeMesh() [1/8]

edgeMesh ( const faMesh mesh)
inlineexplicit

Definition at line 56 of file edgeFaMesh.H.

◆ edgeMesh() [2/8]

edgeMesh ( )
inline

Definition at line 38 of file edgeMeshI.H.

◆ edgeMesh() [3/8]

edgeMesh ( const edgeMesh em)
inline

Definition at line 47 of file edgeMeshI.H.

◆ edgeMesh() [4/8]

edgeMesh ( edgeMesh &&  em)
inline

Definition at line 56 of file edgeMeshI.H.

References edgeMesh::transfer().

Here is the call graph for this function:

◆ edgeMesh() [5/8]

edgeMesh ( const pointField points,
const edgeList edges 
)
inline

Definition at line 65 of file edgeMeshI.H.

◆ edgeMesh() [6/8]

edgeMesh ( pointField &&  pointLst,
edgeList &&  edgeLst 
)
inline

Definition at line 78 of file edgeMeshI.H.

◆ edgeMesh() [7/8]

edgeMesh ( const fileName name)
explicit

Definition at line 42 of file edgeMeshIO.C.

References Foam::name(), and edgeMesh::read().

Here is the call graph for this function:

◆ edgeMesh() [8/8]

edgeMesh ( const fileName name,
const word fileType 
)

Definition at line 29 of file edgeMeshIO.C.

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

Here is the call graph for this function:

◆ ~edgeMesh()

virtual ~edgeMesh ( )
virtualdefault

Member Function Documentation

◆ size() [1/2]

static label size ( const Mesh mesh)
inlinestatic

Definition at line 64 of file edgeFaMesh.H.

References mesh.

◆ size() [2/2]

label size ( ) const
inline

Definition at line 70 of file edgeFaMesh.H.

References GeoMesh< faMesh >::mesh_.

◆ C()

const edgeVectorField& C ( ) const
inline

Definition at line 76 of file edgeFaMesh.H.

References faMesh::edgeCentres(), and GeoMesh< faMesh >::mesh_.

Here is the call graph for this function:

◆ storedPoints()

Foam::pointField & storedPoints ( )
inlineprotectednoexcept

Definition at line 24 of file edgeMeshI.H.

Referenced by OBJedgeFormat::read().

Here is the caller graph for this function:

◆ storedEdges()

Foam::edgeList & storedEdges ( )
inlineprotectednoexcept

Definition at line 30 of file edgeMeshI.H.

Referenced by OBJedgeFormat::read().

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "edgeMesh"  )

◆ readTypes()

Foam::wordHashSet readTypes ( )
static

Definition at line 42 of file edgeMesh.C.

◆ writeTypes()

Foam::wordHashSet writeTypes ( )
static

Definition at line 48 of file edgeMesh.C.

◆ canReadType()

bool canReadType ( const word fileType,
bool  verbose = false 
)
static

Definition at line 54 of file edgeMesh.C.

◆ canWriteType()

bool canWriteType ( const word fileType,
bool  verbose = false 
)
static

Definition at line 66 of file edgeMesh.C.

◆ canRead()

bool canRead ( const fileName name,
bool  verbose = false 
)
static

Definition at line 78 of file edgeMesh.C.

References word::ext(), word::lessExt(), and Foam::name().

Here is the call graph for this function:

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr  ,
edgeMesh  ,
fileExtension  ,
(const fileName &name ,
(name  
)

◆ New() [1/2]

Foam::autoPtr< Foam::edgeMesh > New ( const fileName name,
const word fileType 
)
static

Definition at line 27 of file edgeMeshNew.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::flatOutput(), Foam::name(), and Foam::nl.

Referenced by edgeMesh::New().

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

◆ New() [2/2]

Foam::autoPtr< Foam::edgeMesh > New ( const fileName name)
static

Definition at line 48 of file edgeMeshNew.C.

References word::ext(), word::lessExt(), Foam::name(), and edgeMesh::New().

Here is the call graph for this function:

◆ declareMemberFunctionSelectionTable()

declareMemberFunctionSelectionTable ( void  ,
edgeMesh  ,
write  ,
fileExtension  ,
(const fileName &name, const edgeMesh &mesh, IOstreamOption streamOpt, const dictionary &options)  ,
(name, mesh, streamOpt, options)   
)

◆ write() [1/4]

void write ( const fileName name,
const edgeMesh mesh,
IOstreamOption  streamOpt = IOstreamOption(),
const dictionary options = dictionary::null 
)
static

Definition at line 107 of file edgeMeshIO.C.

References word::ext(), mesh, Foam::name(), and Foam::vtk::write().

Referenced by edgeMesh::write(), and extendedEdgeMesh::writeObj().

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

◆ write() [2/4]

void write ( const fileName name,
const word fileType,
const edgeMesh mesh,
IOstreamOption  streamOpt = IOstreamOption(),
const dictionary options = dictionary::null 
)
static

Definition at line 80 of file edgeMeshIO.C.

References DebugInFunction, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInLookup, mesh, and Foam::name().

Here is the call graph for this function:

◆ transfer()

void transfer ( edgeMesh mesh)

Definition at line 117 of file edgeMesh.C.

References mesh.

Referenced by extendedEdgeMesh::add(), edgeMesh::edgeMesh(), extendedEdgeMesh::flipNormals(), and extendedEdgeMesh::transfer().

Here is the caller graph for this function:

◆ read() [1/2]

bool read ( const fileName name,
const word fileType 
)

Definition at line 68 of file edgeMeshIO.C.

References Foam::name(), and Foam::New().

Referenced by edgeMesh::edgeMesh().

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

◆ read() [2/2]

bool read ( const fileName name)
virtual

◆ points()

const Foam::pointField & points ( ) const
inlinenoexcept

◆ edges()

const Foam::edgeList & edges ( ) const
inlinenoexcept

◆ pointEdges()

const Foam::labelListList & pointEdges ( ) const
inline

Definition at line 104 of file edgeMeshI.H.

◆ regions()

Foam::label regions ( labelList edgeRegion) const

Definition at line 130 of file edgeMesh.C.

References DynamicList::append(), Foam::constant::electromagnetic::e, forAll, List::setSize(), and List::transfer().

Here is the call graph for this function:

◆ clear()

void clear ( )
virtual

Reimplemented in extendedEdgeMesh.

Definition at line 109 of file edgeMesh.C.

Referenced by extendedEdgeMesh::clear(), and OBJedgeFormat::read().

Here is the caller graph for this function:

◆ scalePoints()

void scalePoints ( const scalar  scaleFactor)
virtual

Definition at line 196 of file edgeMesh.C.

References Foam::equal().

Here is the call graph for this function:

◆ mergePoints()

void mergePoints ( const scalar  mergeDist)
virtual

Definition at line 206 of file edgeMesh.C.

References Foam::constant::electromagnetic::e, forAll, Foam::mergePoints(), and VectorSpace< Vector< scalar >, scalar, 3 >::zero.

Here is the call graph for this function:

◆ mergeEdges()

void mergeEdges ( )
virtual

◆ writeStats()

void writeStats ( Ostream os) const
virtual

Reimplemented in extendedEdgeMesh.

Definition at line 118 of file edgeMeshIO.C.

References Foam::endl(), Foam::indent(), Foam::nl, os(), and points.

Referenced by extendedEdgeMesh::writeStats().

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

◆ write() [3/4]

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

Reimplemented in edgeMeshFormat, STARCDedgeFormat, OBJedgeFormat, and VTKedgeFormat.

Definition at line 267 of file edgeMesh.H.

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

Here is the call graph for this function:

◆ write() [4/4]

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

Definition at line 279 of file edgeMesh.H.

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

Here is the call graph for this function:

◆ operator=() [1/2]

void operator= ( const edgeMesh rhs)
inline

Definition at line 116 of file edgeMeshI.H.

◆ operator=() [2/2]

void operator= ( edgeMesh &&  rhs)
inline

Definition at line 124 of file edgeMeshI.H.

Friends And Related Function Documentation

◆ operator<<

Ostream& operator<< ( Ostream os,
const edgeMesh em 
)
friend

◆ operator>>

Istream& operator>> ( Istream is,
edgeMesh em 
)
friend

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