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

Inheritance diagram for edgeMesh:

Collaboration diagram for edgeMesh:

Public Member Functions
	edgeMesh (const faMesh &mesh)
	Construct finite-area edge mesh faMesh reference. More...

label	size () const
	Return size. Number of internal edges. More...

const edgeVectorField &	C () const
	Field of edge centres. More...

	TypeName ("edgeMesh")
	Runtime type information. More...

	edgeMesh ()
	Default construct. More...

	edgeMesh (const edgeMesh &em)
	Copy construct. More...

	edgeMesh (edgeMesh &&em)
	Move construct. More...

	edgeMesh (const pointField &points, const edgeList &edges)
	Copy construct from components. More...

	edgeMesh (pointField &&pointLst, edgeList &&edgeLst)
	Move construct from components. More...

	edgeMesh (const fileName &name)
	Construct from file name (uses extension to determine type) More...

	edgeMesh (const fileName &name, const word &fileType)
	Construct from file name with specified type. More...

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

virtual	~edgeMesh ()=default
	Destructor. More...

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

void	transfer (edgeMesh &mesh)
	Transfer the contents of the argument and annul the argument. More...

bool	read (const fileName &name, const word &fileType)
	Read from file. Chooses reader based on explicit extension. More...

virtual bool	read (const fileName &name)
	Read from file. Chooses reader based on detected extension. More...

const pointField &	points () const noexcept
	Return points. More...

const edgeList &	edges () const noexcept
	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	scalePoints (const scalar scaleFactor)
	Scale points. A non-positive factor is ignored. More...

virtual void	mergePoints (const scalar mergeDist)
	Geometric merge points (points within mergeDist) prior to. More...

virtual void	mergeEdges ()
	Merge duplicate edges and eliminate unused points. More...

virtual void	writeStats (Ostream &) const

virtual void	write (const fileName &name, IOstreamOption streamOpt=IOstreamOption(), const dictionary &options=dictionary::null) const
	Write to file, choosing writer based on the file extension. More...

virtual void	write (const fileName &name, const word &fileType, IOstreamOption streamOpt=IOstreamOption(), const dictionary &options=dictionary::null) const
	Write to file with given format type. More...

void	operator= (const edgeMesh &rhs)
	Copy assignment. More...

void	operator= (edgeMesh &&rhs)
	Move assignment. More...

Public Member Functions inherited from GeoMesh< faMesh >
	GeoMesh (const faMesh &mesh)
	Construct from mesh reference. More...

bool	hasDb () const
	Return true if thisDb() is a valid DB - here = false. More...

const objectRegistry &	thisDb () const
	Return the object registry. More...

const faMesh &	operator() () const
	Return reference to the underlying mesh. More...

Static Public Member Functions
static label	size (const Mesh &mesh)
	Return size. Number of internal edges. More...

static wordHashSet	readTypes ()
	Summary of supported read file types. More...

static wordHashSet	writeTypes ()
	Summary of supported write file types. More...

static bool	canReadType (const word &fileType, bool verbose=false)
	Can we read this file format? More...

static bool	canWriteType (const word &fileType, bool verbose=false)
	Can we write this file format type? More...

static bool	canRead (const fileName &name, bool verbose=false)
	Can we read this file format? More...

static autoPtr< edgeMesh >	New (const fileName &name, const word &fileType)
	Read construct from filename with given format. More...

static autoPtr< edgeMesh >	New (const fileName &name)
	Select constructed from filename (implicit extension) More...

static void	write (const fileName &name, const edgeMesh &mesh, IOstreamOption streamOpt=IOstreamOption(), const dictionary &options=dictionary::null)
	Write to file (format implicit in the extension) More...

static void	write (const fileName &name, const word &fileType, const edgeMesh &mesh, IOstreamOption streamOpt=IOstreamOption(), const dictionary &options=dictionary::null)
	Write to file, with given format. More...

Protected Member Functions
pointField &	storedPoints () noexcept
	Non-const access to global points. More...

edgeList &	storedEdges () noexcept
	Non-const access to the edges. More...

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

Istream &	operator>> (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 faMesh &	mesh_
	Reference to Mesh. More...

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 53 of file edgeFaMesh.H.

Constructor & Destructor Documentation

◆ edgeMesh() [1/8]

edgeMesh ( const faMesh & mesh )

inlineexplicit

Construct finite-area edge mesh faMesh reference.

Definition at line 62 of file edgeFaMesh.H.

◆ edgeMesh() [2/8]

edgeMesh ( )

inline

Default construct.

Definition at line 45 of file edgeMeshI.H.

◆ edgeMesh() [3/8]

edgeMesh ( const edgeMesh & em )

inline

Copy construct.

Definition at line 54 of file edgeMeshI.H.

◆ edgeMesh() [4/8]

edgeMesh ( edgeMesh && em )

inline

Move construct.

Definition at line 63 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

Copy construct from components.

Definition at line 72 of file edgeMeshI.H.

◆ edgeMesh() [6/8]

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

inline

Move construct from components.

Definition at line 85 of file edgeMeshI.H.

◆ edgeMesh() [7/8]

edgeMesh ( const fileName & name )

explicit

Construct from file name (uses extension to determine type)

Definition at line 49 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
	)

Construct from file name with specified type.

Definition at line 36 of file edgeMeshIO.C.

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

Here is the call graph for this function:

◆ ~edgeMesh()

virtual ~edgeMesh ( )

virtualdefault

Destructor.

Member Function Documentation

◆ size() [1/2]

static label size ( const Mesh & mesh )

inlinestatic

Return size. Number of internal edges.

Definition at line 70 of file edgeFaMesh.H.

References mesh.

◆ size() [2/2]

label size ( ) const

inline

Return size. Number of internal edges.

Definition at line 76 of file edgeFaMesh.H.

References GeoMesh< faMesh >::mesh_.

◆ C()

const edgeVectorField& C ( ) const

inline

Field of edge centres.

Definition at line 82 of file edgeFaMesh.H.

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

Here is the call graph for this function:

◆ storedPoints()

Foam::pointField & storedPoints ( )

inlineprotectednoexcept

Non-const access to global points.

Definition at line 31 of file edgeMeshI.H.

Referenced by OBJedgeFormat::read().

Here is the caller graph for this function:

◆ storedEdges()

Foam::edgeList & storedEdges ( )

inlineprotectednoexcept

Non-const access to the edges.

Definition at line 37 of file edgeMeshI.H.

Referenced by OBJedgeFormat::read().

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "edgeMesh" )

Runtime type information.

◆ readTypes()

Foam::wordHashSet readTypes ( )

static

Summary of supported read file types.

Definition at line 49 of file edgeMesh.C.

◆ writeTypes()

Foam::wordHashSet writeTypes ( )

static

Summary of supported write file types.

Definition at line 55 of file edgeMesh.C.

◆ canReadType()

bool canReadType	(	const word &	fileType,
		bool	verbose = `false`
	)

static

Can we read this file format?

Definition at line 61 of file edgeMesh.C.

◆ canWriteType()

bool canWriteType	(	const word &	fileType,
		bool	verbose = `false`
	)

static

Can we write this file format type?

Definition at line 73 of file edgeMesh.C.

◆ canRead()

bool canRead	(	const fileName &	name,
		bool	verbose = `false`
	)

static

Can we read this file format?

Definition at line 85 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

Read construct from filename with given format.

Definition at line 34 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

Select constructed from filename (implicit extension)

Definition at line 55 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

Write to file (format implicit in the extension)

Definition at line 114 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

Write to file, with given format.

Definition at line 87 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 )

Transfer the contents of the argument and annul the argument.

Definition at line 124 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
	)

Read from file. Chooses reader based on explicit extension.

Definition at line 75 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

Read from file. Chooses reader based on detected extension.

Reimplemented in extendedEdgeMesh, edgeMeshFormat, STARCDedgeFormat, OBJedgeFormat, VTKedgeFormat, NASedgeFormat, extendedFeatureEdgeMeshFormat, and extendedEdgeMeshFormat.

Definition at line 61 of file edgeMeshIO.C.

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

Here is the call graph for this function:

◆ points()

const Foam::pointField & points ( ) const

inlinenoexcept

Return points.

Definition at line 99 of file edgeMeshI.H.

Referenced by extendedEdgeMesh::add(), refinementFeatures::checkSizes(), extendedFeatureEdgeMesh::extendedFeatureEdgeMesh(), featureEdgeMesh::featureEdgeMesh(), Foam::operator<<(), refinementFeatures::regionEdgeTrees(), searchableExtrudedCircle::searchableExtrudedCircle(), VTKedgeFormat::write(), and Foam::edgeMeshTools::writeStats().

Here is the caller graph for this function:

◆ edges()

const Foam::edgeList & edges ( ) const

inlinenoexcept

Return edges.

Definition at line 105 of file edgeMeshI.H.

Referenced by extendedEdgeMesh::add(), Foam::calcProximityOfFeatureEdges(), extendedFeatureEdgeMesh::extendedFeatureEdgeMesh(), featureEdgeMesh::featureEdgeMesh(), Foam::operator<<(), refinementFeatures::regionEdgeTrees(), searchableExtrudedCircle::searchableExtrudedCircle(), VTKedgeFormat::write(), and Foam::edgeMeshTools::writeStats().

Here is the caller graph for this function:

◆ pointEdges()

const Foam::labelListList & pointEdges ( ) const

inline

Return edges.

Definition at line 111 of file edgeMeshI.H.

◆ regions()

Foam::label regions ( labelList & edgeRegion ) const

Find connected regions. Set region number per edge.

Returns number of regions.

Definition at line 137 of file edgeMesh.C.

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

Here is the call graph for this function:

◆ clear()

void clear ( )

virtual

Clear all storage.

Reimplemented in extendedEdgeMesh.

Definition at line 116 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

Scale points. A non-positive factor is ignored.

Definition at line 203 of file edgeMesh.C.

References Foam::equal().

Here is the call graph for this function:

◆ mergePoints()

void mergePoints ( const scalar mergeDist )

virtual

Geometric merge points (points within mergeDist) prior to.

automatically calling mergeEdges().

Definition at line 213 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

Merge duplicate edges and eliminate unused points.

Definition at line 247 of file edgeMesh.C.

References Foam::expressions::patchExpr::debug, Foam::constant::electromagnetic::e, Foam::endl(), forAll, and Foam::Info.

Here is the call graph for this function:

◆ writeStats()

void writeStats ( Ostream & os ) const

virtual

Reimplemented in extendedEdgeMesh.

Definition at line 125 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

Write to file, choosing writer based on the file extension.

Reimplemented in edgeMeshFormat, STARCDedgeFormat, OBJedgeFormat, and VTKedgeFormat.

Definition at line 271 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

Write to file with given format type.

If the format type is "", uses the file extension.

Definition at line 283 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

Copy assignment.

Definition at line 123 of file edgeMeshI.H.

◆ operator=() [2/2]

void operator= ( edgeMesh && rhs )

inline

Move assignment.

Definition at line 131 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:

src/finiteArea/edgeMesh/edgeFaMesh.H
src/meshTools/edgeMesh/edgeMesh.H
src/meshTools/edgeMesh/edgeMesh.C
src/meshTools/edgeMesh/edgeMeshI.H
src/meshTools/edgeMesh/edgeMeshIO.C
src/meshTools/edgeMesh/edgeMeshNew.C

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ edgeMesh() [1/8]

◆ edgeMesh() [2/8]

◆ edgeMesh() [3/8]

◆ edgeMesh() [4/8]

◆ edgeMesh() [5/8]

◆ edgeMesh() [6/8]

◆ edgeMesh() [7/8]

◆ edgeMesh() [8/8]

◆ ~edgeMesh()

Member Function Documentation

◆ size() [1/2]

◆ size() [2/2]

◆ C()

◆ storedPoints()

◆ storedEdges()

◆ TypeName()

◆ readTypes()

◆ writeTypes()

◆ canReadType()

◆ canWriteType()

◆ canRead()

◆ declareRunTimeSelectionTable()

◆ New() [1/2]

◆ New() [2/2]

◆ declareMemberFunctionSelectionTable()

◆ write() [1/4]

◆ write() [2/4]

◆ transfer()

◆ read() [1/2]

◆ read() [2/2]

◆ points()

◆ edges()

◆ pointEdges()

◆ regions()

◆ clear()

◆ scalePoints()

◆ mergePoints()

◆ mergeEdges()

◆ writeStats()

◆ write() [3/4]

◆ write() [4/4]

◆ operator=() [1/2]

◆ operator=() [2/2]

Friends And Related Function Documentation

◆ operator<<

◆ operator>>